应用与数据集成平台 ROMA CONNECT-接入API数据源:操作步骤
操作步骤
- 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
- 在左侧的导航栏选择“数据源管理”,单击页面右上角的“接入数据源”。
- 在接入数据源页面的“默认数据源”页签下,选择“API”类型的数据源,然后单击“下一步”。
- 在页面中配置数据源的连接信息。
表1 数据源连接信息 参数
配置说明
数据源名称
填写数据源的名称,根据规划自定义。建议您按照一定的命名规则填写数据源名称,方便您快速识别和查找。
编码格式
默认“utf-8”格式。
集成应用
选择数据源所归属的集成应用。
描述
填写数据源的描述信息。
地址
填写API的请求URL地址,例如“https://example.com/test”。
Site实例中,地址需要填写为APIC连接地址的IP,例如“192.100.0.10”。
说明:如果接入的API为服务集成中创建的API时,因为API的默认子 域名 每天最多只能访问1000次,建议不要使用API的默认子域名接入API,避免因超过访问次数限制后导致接入数据源失败。建议使用API的独立域名接入。
请求方式
选择API的请求方式。
认证方式
选择API的请求认证方式。
- None:无需认证,任何人都可以调用API。
- Basic Auth:使用用户名和密码进行认证,认证通过后才允许调用API。
- 用户名:输入Basic Auth认证所需的用户名。
- 密码:输入Basic Auth认证所需的密码。
- AppKey Auth:使用AppKey和AppSecret对请求进行签名,签名校验通过后才允许调用API。
- OAuth2.0:调用接口时提供请求的header中需携带Authorization信息,接口获取header中的secret信息,校验成功后才允许调用。
- 授权类型:Authorization中的Token信息需要通过Access Token Url获取,所以需要选择授权类型。
- Access Token Url:输入OAuth2.0认证的Access Token Url。
- 客户端标识:输入OAuth2.0认证所需的客户端标识。
- 客户端密匙:输入OAuth2.0认证所需的客户端密匙。
- Scope:输入访问 API 的 Scope(作用域),Scope 用于限制应用程序访问 API 的权限。
- Secret:使用密码进行认证,请求的header中携带secret信息,接口获取header中的secret信息,校验成功后才允许调用。
- MD5:使用MD5对body体参数加密后得到验证信息sign,请求的body体中携带sign相关信息,接口获取后,校验成功后才允许调用。
- HMAC:使用HMAC对body体参数加密后得到验证信息sign,请求的body体中携带sign相关信息,接口获取后,校验成功后才允许调用。
- 定制化认证方式:Key Top Auth、Hik Vision Auth、li He Auth等其他认证方式是商业伙伴定制的认证方式,仅定制此类认证方式的商业伙伴使用。需要根据选择的定制认证方式,填写具体的认证参数。
以接入ROMA Connect发布的一个API为例,API的认证方式为“APP认证”,该API数据源的接入配置示例如下图所示。
其中,认证方式选择“APPKey Auth”,APP认证方式保持默认“Default”即可,AppKey和AppSecret为API所授权集成应用的Key和Secret。
图1 API数据源配置示例
- 完成数据源接入配置后,单击“开始检测”,检测ROMA Connect与数据源之间是否能够连通。
- 若测试结果为“数据源连接成功!”,则继续下一步。
- 若测试结果为“数据源连接失败!”,则检查地址,请求方式,认证方式,AppKey、AppSecret是否填写正确,以及API是否可以正常访问,然后单击“重新检测”,直到连接成功为止。
- 单击“创建”,完成数据源的接入。