【分享】在集简云上架应用使用OAuth2.0授权如何配置?

OAuth2.0授权配置需要以下几个步骤:

  • 设置填写授权字段 (非必填,仅在OAuth2.0登录授权前需要额外参数时添加)
  • 复制回调地址:将自动生成的集简云授权回调地址添加到我们的应用中
  • 设置授权参数:一般为Client Key和 Client Secret
  • 设置接口参数:配置授权接口需要的参数,Access Token换取和刷新参数等
  • 账号授权测试 (模拟账户授权,测试是否可以调取成功)

1 设置填写授权字段 (非必要)

此步骤非必须,仅在OAuth2.0登录授权前需要额外参数时添加。例如Zoho CRM示例中需要用户选择服务器所在地区后再进行登录授权:

如果我们需要设置,可以添加一个字段:

  • 字段名称:用户在前端可以看到的名称, 本示例中为API Key
  • 字段key: 此字段对应在接口调用时的Key,本示例中为 client_id
  • 是否必填:如果用户必须填写此字段,则勾选此选项
  • 字段类型:目前在授权环节支持的字段类型有三种:文本,密码(前端以密码形式展现),和 下拉。如果是下拉类型,则需要在页面最后的选项中配置选项的字段key与字段值。本示例中为文本
  • 字段说明:用于在前端展现给用户,一般用于说明此字段在哪里获取,或者填写时应该注意什么。
  • 默认字段值:可以设置在字段中默认展现一个字段值,用户可以直接使用此字段值或者删除此字段值后重新填写。
  • 下拉选项:仅字段类型为”下拉”类型时需要设置

保存后,返回授权设置页面我们可以看到刚才配置的字段已经展现在授权字段设置中:

2 复制回调地址

Oauth2.0一般需要一个授权回调地址,这里集简云会为每个Oauth2.0应用生成一个授权回调地址,我们仅需要复制使用即可:

3 设置授权参数

一般Oauth2.0需要配置Client Key和 Client Secret,在这里填写:

4 设置接口参数

在此步骤配置授权接口调用需要的参数,一般Oauth2.0常用的接口参数配置包括:

  • 启用接口授权
  • 换取Token:
  • 自动刷新Token配置:

如果我们的Oauth2.0授权有一定的实效性,比如1个月或者3个月,我们应该配置“刷新Token请求接口“步骤。

同时我们勾选了自动刷新Token,这样如果token过期报401错误时,集简云将自动执行token刷新接口,如果我们不设置自动刷新,那么则授权过期后需要用户在前端手动重新更新账户时刷新token。

6 账户授权测试

点击添加账户进行授权,查看请求是否成功

在“HTTP"中我们提供了请求参数详情,以便调试: