连接器开发工具手册介绍

一:平台概述

纷享销客集成平台IPaas是面向软件开发商的低代码集成平台。开发者通过可视化界面配置连接器的授权、触发器和动作,无需编写任何代码或者部分代码即可完成系统对接。连接器上线后,用户可在集成平台中通过可视化画布编排业务流程,实现系统间的数据互通。

二:应用类型说明

类型说明
内部连接器仅在企业内部使用,创建后实时上线无需审核
全网发布连接器面向纷享销客全部用户,上线前需经过审核和测试

三:创建连接器

经过研发灰度企业:管理后台->系统集成平台->连接器开发 ,后续连接器开发工作都是基于这个页面
按照真实信息填写即可

四:授权方式

  1. OAuth授权方式:
      OAuth2.0授权配置需要以下几个步骤:
  • 设置填写授权字段 (非必填,仅在OAuth2.0登录授权前需要额外参数时添加)
  • 复制回调地址:将自动生成的集成平台授权回调地址添加到您的应用中
  • 设置授权参数:一般为Client Key和 Client Secret
  • 设置接口参数:配置授权接口需要的参数,Access Token换取和刷新参数等
  • 账号授权测试 (模拟账户授权,测试是否可以调取成功)
选择对应授权方式:
1:添加字段(非必要)
此步骤非必须,仅在OAuth2.0登录授权前需要额外参数时添加。例如部分系统可能需要选择某些地区或者某些域名
OAuth基础配置:
开发者统一创建,一般就是作为集成平台ISV服务商才需要选择这个,如果用户自定义应用可以选择用户自行创建,区别就是开发者统一创建,那么授权应用都是沿用同一套应用信息
OAuth授权类型:
OAuth 授权类型:用于指定连接器接入第三方平台时使用的 OAuth 2.0 授权方式。
OAuth 2.0(授权码模式):用户完成登录授权后获取访问令牌。
OAuth 2.0(客户端凭证模式):系统使用客户端凭证直接获取访问令牌,无需用户参与。
OAuth 2.0(PKCE 模式):在授权码模式基础上增加 PKCE 校验,适用于前端或移动端场景。
字段怎么使用,统一参考后面章节【字段说明】
认证地址授权:
获取token地址
刷新token地址

其他授权方式

可以具体授权类型以及AI辅助理解一下
授权选择授权机制
OAuth2-AuthorizationCode三步授权流程:获取授权码 → 换取 Access Token → 使用 Refresh Token 自动刷新;支持 PKCE 自动处理,适用于需要用户登录授权的第三方平台
OAuth2-ClientCredentials机器对机器授权,无需用户交互;平台直接使用 Client ID / Client Secret 获取 Token,并按过期时间重新申请
APIKey通过 API Key 进行认证;可将 Key 注入到 Header、Query 参数,适用于 OpenAPI、Server API 等简单鉴权场景
BasicAuthHTTP Basic 认证;使用用户名 + 密码生成 Authorization Header 进行请求认证
SessionAuth先调用登录接口获取 Session / Cookie,再携带 Session 信息访问后续接口;适用于传统 Web 系统或 Cookie 会话型接口
DigestAuthHTTP Digest 认证;基于服务端 challenge 机制完成摘要签名认证,适用于部分老系统或特定安全要求接口
CustomAuth自定义认证;通过平台函数模式实现任意认证逻辑,可覆盖自定义签名、登录换票据、多步认证、混合认证等复杂场景

五:Trigger/Action类型

触发动作是指当一个事件发生时,触发数据流程。 而产生触发事件的应用系统就是触发系统。
实时触发:由应用系统自动在触发事件产生时推送数据到集成平台,集成平台自动响应并且执行。
根据真实系统需求,选择哪些事件作为trigger(触发事件),选择新建
根据接口要求,配置对应字段:
如果事件需要实时触发,需要选择【Rest Hook】,hook地址有两种级别,按照集成流生成,那么就是每个集成流都有不同hook地址,用于不同事件区分
如果选择账号生成,那么就是系统级别(系统授权对应账号),多个事件共用一个hook地址
hook地址需要连接器配置完成,进到集成流选择对应事件,生成对应hook地址:
部分saas系统支持根据接口动态将这些hook地址注册到对方系统,那么就可以按照对方系统接口文档要求,配置对应接口以及参数:
订阅请求中需要将平台生成的回调地址传给外部系统,使用 path("['input_data']['bundleUrl']") 引用 
如果事件需要轮训:

Action类型 

action执行动作跟上面trigger操作基本操作差别不大,只是trigger回作为集成流第一个节点可选,如果这个接口配置action,那么在集成流就不能选择第一个作为触发事件

六:字段说明:

1:授权页面配置字段:
如果用户配置授权接口,页面表单字段,那么怎么能够在后续接口配置用到呢?
授权表单配置参数以及授权接口返回任何参数,都会包装进去auth_data: 
path("['auth_data']['access_token']")   集成平台用的表达式一定需要带有前缀path,后续就是具体参数路径
普通trigger以及action配置表单参数:
1:接口需要拿到授权参数:也是按照之前约束:path("['auth_data']['xxxxxxx']")
2.trigger/action页面表单填写参数:接口需要用到input_data表达式 

七:函数模式:

每一个接口如果页面UI满足不了,都可以切换代码模型:
函数参数透传对应页面配置参数以及授权参数
Map<String, Object> authData = (Map<String, Object>) syncArg.get("auth_data"); Map<String, Object> inputData = (Map<String, Object>) syncArg.get("input_data"); String tenantId = (String) syncArg.get("tenantId"); String connectorKey = (String) syncArg.get("connectorKey"); String operation = (String) syncArg.get("operation"); String connectionId = (String) syncArg.get("connectionId"); String type = (String) syncArg.get("type"); Map<String, Object> extra = (Map<String, Object>) syncArg.get("extra"); Map<String, Object> http = (Map<String, Object>) syncArg.get("http");

函数返回值格式要求:

trigger返回格式要求,需要返回数据列表

字段说明: dataItems:必须,触发出来的数据列表 privateKeys:推荐,去重主键字段 nameKeys:推荐,调试展示名称字段 conditions:推荐,下一次轮询继续查询用 return [ outputData: [ triggerOperation: "instant.created", dataItems: [ [ id: "1", event: "created", name: "test order" ], [ id: "2", event: "created", name: "test order 2" ] ], privateKeys: ["id"], nameKeys: ["name"], conditions: [ nextCursor: "cursor_123" ] ] ]

获取认证授权地址:

return [ outputData: [ authorizeUrl: "https://example.com/oauth/authorize?client_id=xxx&state=xxx&redirect_uri=xxx" ] ]

获取token

return [ outputData: [ access_token: "access_token_xxx", refresh_token: "refresh_token_xxx", token_type: "Bearer", expires_in: 7200, scope: "crm" ] ]

刷新token

return [ outputData: [ access_token: "new_access_token_xxx", refresh_token: "new_refresh_token_xxx", token_type: "Bearer", expires_in: 7200 ] ]
普通接口函数返回内容:返回 outputData
return [ outputData: [ id: "123", name: "test", status: "success" ] ]

八:skill自动创建连接器

1:需要找到值班同学拿到创建连接器skill,目前还在内测,只能部分同学测试
2:需要有个好用agent,codex,Qoder,claudecode等等都可以
3:用户企业需要灰度CLI:https://help.fxiaoke.com/ee88/a823/ce56

九:常见问题:

2026-06-17
0 0