连接器开发指南
配置连接器的授权方式与授权参数。
概述
通过配置授权方式,连接器可以对接第三方平台的鉴权机制。OAuth 2.0 是最常用的授权方式。
开始之前
[!IMPORTANT]
- 角色权限:你所在企业需经过研发灰度,可访问连接器开发页面
- 前置配置:已在目标系统应用中获取 Client Key 和 Client Secret
第一步:进入连接器开发页面
在 管理后台 > 系统集成平台 > 连接器开发 页面中,选择要配置的连接器。
第二步:选择授权方式
在授权配置中,根据目标系统的鉴权机制选择对应的授权方式。
第三步:配置授权
以 OAuth 2.0 授权配置为例,需要以下步骤:
-
设置填写授权字段(非必填,仅在 OAuth 2.0 登录授权前需要额外参数时添加)
-
复制回调地址,将自动生成的集成平台授权回调地址添加到你的应用中
-
设置授权参数,一般为 Client Key 和 Client Secret
-
设置接口参数,配置授权接口需要的参数、Access Token 换取和刷新参数等
-
进行账号授权测试,模拟账户授权测试是否可以调取成功
[!NOTE]
开发者统一创建一般作为集成平台 ISV 服务商才需要选择。如果用户自定义应用可以选择用户自行创建。区别是开发者统一创建时,授权应用沿用同一套应用信息。
第四步:配置授权类型
OAuth 授权类型用于指定连接器接入第三方平台时使用的 OAuth 2.0 授权方式。
| 授权类型 | 说明 |
|---|---|
| OAuth 2.0(授权码模式) | 用户完成登录授权后获取访问令牌 |
| OAuth 2.0(客户端凭证模式) | 系统使用客户端凭证直接获取访问令牌,无需用户参与 |
| OAuth 2.0(PKCE 模式) | 在授权码模式基础上增加 PKCE 校验,适用于前端或移动端场景 |
第五步:配置认证地址
配置认证地址授权、获取 Token 地址和刷新 Token 地址。
预期结果与验证
完成授权配置后,账号授权测试可通过,连接器可正常调取目标系统数据。
验证方法:
- 在授权配置页点击 账号授权测试。
- 观察测试结果是否提示调取成功。
- 若失败,根据错误提示检查 Client Key、Client Secret 与回调地址。