连接器开发概述
了解连接器的应用类型、创建流程与授权方式。
概述
纷享销客集成平台 iPaaS 是面向软件开发商的低代码集成平台。开发者通过可视化界面配置连接器的授权、触发器和动作,无需编写代码即可完成系统对接。。连接器上线后,用户可在集成平台中通过可视化画布编排业务流程,实现系统间的数据互通。。
核心概念
连接器开发的核心概念包括:
- 应用类型:内部连接器(企业内使用)与全网发布连接器(面向全部用户)
- 授权方式:连接器对接第三方平台时采用的鉴权机制,如 OAuth 2.0
- Trigger:定义连接器在什么条件下触发数据流程
- Action:定义连接器触发后执行的具体动作
- 函数模式:页面 UI 无法满足时的代码配置模式
应用类型
| 类型 | 说明 |
|---|---|
| 内部连接器 | 仅在企业内部使用,创建后实时上线无需审核 |
| 全网发布连接器 | 面向纷享销客全部用户,上线前需经过审核和测试 |
创建连接器
经过研发灰度企业后,在 管理后台 > 系统集成平台 > 连接器开发 页面中,按真实信息填写即可创建连接器。。
授权方式
OAuth 2.0 授权方式
OAuth 2.0 授权配置需要以下几个步骤:
- 设置填写授权字段(非必填,仅在 OAuth 2.0 登录授权前需要额外参数时添加)
- 复制回调地址:将自动生成的集成平台授权回调地址添加到你的应用中
- 设置授权参数:一般为 Client Key 和 Client Secret
- 设置接口参数:配置授权接口需要的参数,Access Token 换取和刷新参数等
- 账号授权测试(模拟账户授权,测试是否可以调取成功)
开发者统一创建一般作为集成平台 ISV 服务商才需要选择。如果用户自定义应用可以选择用户自行创建。区别是开发者统一创建时,授权应用沿用同一套应用信息。
OAuth 授权类型
OAuth 授权类型用于指定连接器接入第三方平台时使用的 OAuth 2.0 授权方式。
| 授权类型 | 说明 |
|---|---|
| OAuth 2.0(授权码模式) | 用户完成登录授权后获取访问令牌 |
| OAuth 2.0(客户端凭证模式) | 系统使用客户端凭证直接获取访问令牌,无需用户参与 |
| OAuth 2.0(PKCE 模式) | 在授权码模式基础上增加 PKCE 校验,适用于前端或移动端场景 |
其他授权方式
| 授权选择 | 授权机制 |
|---|---|
OAuth2-AuthorizationCode |
三步授权流程:获取授权码 → 换取 Access Token → 使用 Refresh Token 自动刷新;支持 PKCE 自动处理,适用于需要用户登录授权的第三方平台 |
OAuth2-ClientCredentials |
机器对机器授权,无需用户交互;平台直接使用 Client ID / Client Secret 获取 Token,并按过期时间重新申请 |
APIKey |
通过 API Key 进行认证;可将 Key 注入到 Header、Query 参数,适用于 OpenAPI、Server API 等简单鉴权场景 |
BasicAuth |
HTTP Basic 认证;使用用户名 + 密码生成 Authorization Header 进行请求认证 |
SessionAuth |
先调用登录接口获取 Session / Cookie,再携带 Session 信息访问后续接口;适用于传统 Web 系统或 Cookie 会话型接口 |
DigestAuth |
HTTP Digest 认证;基于服务端 challenge 机制完成摘要签名认证,适用于部分老系统或特定安全要求接口 |
CustomAuth |
自定义认证;通过平台函数模式实现任意认证逻辑,可覆盖自定义签名、登录换票据、多步认证、混合认证等复杂场景 |
字段说明
授权页面配置字段
如果用户配置授权接口页面表单字段,那么该字段可在后续接口配置中使用。授权表单配置参数以及授权接口返回的任何参数,都会包装进 auth_data。
集成平台用的表达式一定需要带有前缀 path,后续就是具体参数路径,例如 path("['auth_data']['access_token']")。
Trigger / Action 页面表单字段
普通 Trigger 以及 Action 配置表单参数时,接口需要用到授权参数,同样按照约束使用 path("['auth_data']['xxxxxxx']");接口需要用到输入参数,则使用 input_data 表达式。
函数模式
每一个接口如果页面 UI 满足不了,都可以切换代码模式(函数模式),详见函数模式参考。