认证方式 | 说明 |
API Key | 一段用于身份验证的密钥字符串。调用资源时,系统会按照您设置的传递方式,将密钥携带在请求中。 |
OAuth 客户端 | 基于 OAuth 协议的授权凭据。您录入在身份提供方(IdP)注册得到的客户端信息后,系统会按照标准授权流程换取访问令牌。 |
凭据类型 | 适用场景 | 授权方式 |
专属凭据(单用户账号场景) | 每个员工使用自己在下游业务系统的账号,例如各自用自己的飞书账号授权。 | 创建后系统自动完成授权,无需手动操作。 |
共享凭据(共享账号场景) | 多个员工共用同一个下游业务系统账号,例如多名运营人员共用一个 Shopee 商家账号。 | 创建后需管理员手动完成一次客户端授权,授权后所有有权限的员工均可使用。 |
参数 | 说明 |
API Key 名称 | 请输入 API Key 类型凭据的自定义名称,便于您在后续业务中识别和管理。 |
API Key 值 | 用于身份验证的密钥内容。 |
设置 API Key 传递方式 | 用于指定调用资源时密钥的携带方式。 说明
|
参数 | 说明 |
OAuth 客户端名称 | OAuth 客户端类型凭据的自定义名称,便于您后续识别和管理。 |
OAuth 客户端来源 | 您注册该客户端所在的身份提供方(IdP)类型。 支持选择飞书、扣子、GitHub、Shopee、TikTok Shop 以及自定义,选择不同来源时,需要填写的参数会有所不同。
|
OAuth 客户端 ID | 您在身份提供方(IdP)注册客户端时,由 IdP 分配的 ID。 |
客户端密钥 | 您在身份提供方(IdP)注册客户端时,由 IdP 分配的密钥。 |
配置类型 | 仅 OAuth 客户端来源为“自定义”时需配置此参数。
|
自动发现URL | 仅 OAuth 客户端来源为“自定义”,配置类型为“自动发现”时需配置此参数。
|
Issuer URL | 仅 OAuth 客户端来源为“自定义”,配置类型为“手动配置”时需配置此参数。
|
授权端点 | 仅 OAuth 客户端来源为“自定义”,配置类型为“手动配置”时需配置此参数。 用户登录并同意授权时跳转到的页面地址。 |
令牌端点 | 仅 OAuth 客户端来源为“自定义”,配置类型为“手动配置”时需配置此参数。 应用拿授权结果去换取访问令牌(access token)的接口地址。 |
响应类型 | 仅 OAuth 客户端来源为“自定义”,配置类型为“手动配置”时需配置此参数。 指定授权流程第一步希望返回什么结果,支持多选,默认选择code。 |
高级配置 | |
权限范围 | OAuth授权请求的权限范围,默认填入open_id。支持填写多个值,多个值之间用英文逗号(,)分隔。 |
自定义参数 | 用于补充其他需要随授权请求一起传递的参数,以键值对形式填写。 |
客户端额外参数 | 仅 OAuth 客户端来源为“Shopee”或“TikTok Shop”时,需配置以下键值对:
|
OAuth验证场景 | 用于指定授权的验证方式。
|
每次请求都重新授权 | 默认关闭。开启后,每次请求都要求用户重新确认授权,即每次登录都要求用户重新确认授权。 |
令牌最长过期时间 | 令牌的最长有效期,默认值为3600,取值范围为10~9999秒。需小于IdP限制,过期后需重新获取令牌。 |
参数 | 说明 |
OAuth 客户端名称 | OAuth 客户端类型凭据的自定义名称,便于您后续识别和管理。 |
OAuth 客户端来源 | 您注册该客户端所在的身份提供方(IdP)类型,共享账号场景仅支持 Shopee 和 TikTok Shop。 |
OAuth 客户端 ID | 您在身份提供方(IdP)注册客户端时,由 IdP 分配的 ID。 |
客户端密钥 | 您在身份提供方(IdP)注册客户端时,由 IdP 分配的密钥。 |
配置类型 | 仅 OAuth 客户端来源为“自定义”时需配置此参数。
|
高级配置 | |
权限范围 | OAuth授权请求的权限范围,默认填入open_id。支持填写多个值,多个值之间用英文逗号(,)分隔。 |
自定义参数 | 用于补充其他需要随授权请求一起传递的参数,以键值对形式填写。 |
客户端额外参数 |
|
OAuth验证场景 | 用于指定授权的验证方式,当前仅支持“用户委托”。 |
每次请求都重新授权 | 默认关闭。开启后,每次请求都要求用户重新确认授权,即每次登录都要求用户重新确认授权。 |
令牌最长过期时间 | 令牌的最长有效期,默认值为3600,取值范围为10~9999秒。需小于IdP限制,过期后需重新获取令牌。 |