更新时间:2023-03-01 GMT+08:00
配置API授权(可选)
概述
仅使用APP认证方式的API,才需要配置调用授权,把API授权给指定集成应用。用户调用API时,使用集成应用的Key和Secret进行API请求的安全认证。
若API开启了简易认证,可直接使用集成应用中配置的AppCode进行简易安全认证,无需使用Key和Secret进行签名认证。
API所属集成应用无需授权,可直接用于调用API。
前提条件
- API的安全认证方式为“APP认证”。
- API已发布到环境,否则请先发布API。
配置API授权
- 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
- 在左侧的导航栏选择“服务集成 APIC > API管理”,在“API列表”页签中单击API右侧的“授权”。
- 在授权API页面,单击“添加集成应用”。
- 在授权集成应用弹窗中配置授权信息,完成后单击“授权”。
授权完成后,在授权API页面,单击API左侧的“”,可展开并查看已授权的集成应用列表。
表1 API授权配置 参数
配置说明
API授权的环境
选择要授权API所在的发布环境。
集成应用
勾选要授予API调用权限的集成应用。
访问参数
为授权的集成应用设置访问参数。访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。
绿色通道
选择是否开启绿色通道,开启绿色通道后,需要设置白名单和黑名单。
白名单
仅当“绿色通道”开启时需要配置。
填写要添加到白名单的IP地址或地址段,白名单中的地址可以不用认证即可调用API。
黑名单
仅当“绿色通道”开启时可配置。
填写要添加到黑名单的IP地址或地址段,黑名单中的地址不允许调用API。
添加AppCode
- 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
- 在左侧的导航栏选择“服务集成 APIC > API调用”,在“客户端配置”页签中单击API所授权客户端(即集成应用)的名称。
- 在客户端详情页面的“AppCode”页签下,单击“添加AppCode”。
- 在添加AppCode弹窗中配置AppCode,完成后单击“确定”。
表2 AppCode配置 参数
配置说明
生成方式
选择AppCode的生成方式。
- 自动生成:由系统随机生成AppCode。
- 手动输入:自定义AppCode。
AppCode
填写AppCode的值。
父主题: 开放API