更新时间:2022-05-05 GMT+08:00
分享

接入API数据源

概述

ROMA Connect支持把API作为一个数据源,并用于数据集成任务。在使用API数据源前,您需要先接入数据源。

前提条件

每个接入的数据源都要归属到某个集成应用下,在接入数据源前您需要有可用的集成应用,否则请提前创建集成应用

操作步骤

  1. 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
  2. 在左侧的导航栏选择“数据源管理”,单击页面右上角的“接入数据源”。
  3. 在接入数据源页面的“默认数据源”页签下,选择“API”类型的数据源,然后单击“下一步”。
  4. 在页面中配置数据源的连接信息。
    表1 数据源连接信息

    参数

    配置说明

    数据源名称

    填写数据源的名称,根据规划自定义。建议您按照一定的命名规则填写数据源名称,方便您快速识别和查找。

    集成应用

    选择数据源所归属的集成应用。

    描述

    填写数据源的描述信息。

    地址

    填写API的请求URL地址,例如“https://example.com/test”。

    Site实例中,地址需要填写为APIC连接地址的IP,例如“192.100.0.10”。

    请求方式

    选择API的请求方式。

    认证方式

    选择API的请求认证方式。

    • None:无需认证,任何人都可以调用API。
    • Basic Auth:使用用户名和密码进行认证,认证通过后才允许调用API。

      选择Basic Auth认证时,还需要填写认证的“用户名”和“密码”。

    • AppKey Auth:使用AppKey和AppSecret对请求进行签名,签名校验通过后才允许调用API。

      选择AppKey Auth认证时,还需要选择APP认证方式,APP认证方式包含以下三种:

      • Default:使用AppKey和AppSecret对请求进行签名,签名校验通过后才允许调用API。APIC的API默认使用此方式。
      • Secret:使用AppKey和AppSecret直接进行认证。
      • Jwt:使用AppKey、AppSecret以及调用时的时间戳生成签名信息,通过AppKey、签名以及时间戳进行认证。
    • OAuth2.0:调用接口时提供请求的header中需携带Authorization信息,接口获取header中的secret信息,校验成功后才允许调用。

      其中,Authorization中的Token信息需要通过Access Token Url获取,所以还需要选择授权类型,并填写Access Token Url、客户端标识、客户端密匙以及Scope。

    • Secret:使用密码进行认证,请求的header中携带secret信息,接口获取header中的secret信息,校验成功后才允许调用。

      选择Secret认证时,需要填写Secret。

    • MD5:使用MD5对body体参数加密后得到验证信息sign,请求的body体中携带sign相关信息,接口获取后,校验成功后才允许调用。

      选择Secret认证时,需要填写Secret。

    • HMAC:使用HMAC对body体参数加密后得到验证信息sign,请求的body体中携带sign相关信息,接口获取后,校验成功后才允许调用。

      选择Secret认证时,需要填写Secret。

    • 定制化认证方式: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数据源配置示例
  5. 完成数据源接入配置后,单击“开始检测”,检测ROMA Connect与数据源之间是否能够连通。
    • 若测试结果为“数据源连接成功!”,则继续下一步。
    • 若测试结果为“数据源连接失败!”,则检查地址,请求方式,认证方式,AppKey、AppSecret是否填写正确,以及API是否可以正常访问,然后单击“重新检测”,直到连接成功为止。
  6. 单击“创建”,完成数据源的接入。
分享:

    相关文档

    相关产品

close