接入API数据源

概述

交换数据空间支持把API作为一种数据源类型，并用于数据上传和下载。在使用API数据源前，需要先接入数据源。

操作步骤

1. 登录交换数据空间官网。
2. 单击“管理控制台”，进入交换数据空间控制台界面。
3. 单击“我的空间”，在交换数据空间实例中，选择实例，单击实例卡片上的“连接器”。
4. 然后选择连接器，单击连接器卡片上的“前往”，进入连接器控制台界面。
5. 选择界面左侧导航栏中的“数据源管理”，单击数据源列表上方“接入数据源”，进入“接入数据源”界面，设置API数据源的基本信息，具体参数如表1所示。

   表1 参数说明

   参数	说明
   数据源类型	API：数据资源需要通过调用API接口获取。
   数据源名称	自定义数据源名称，建议按照一定的命名规则填写任务名称，方便快速识别和查找。要求如下： 长度范围为1位~50位。 名称由中文、英文、数字、下划线（_）和中划线（-）组成。 只能以中文或者英文开头。
   数据源描述	用户可以根据需要在文本框中输入对该数据源的描述信息。

6. 设置完成后，配置API数据源请求信息，具体参数如表2所示。

   表2 参数说明

   参数	说明
   请求方式	选择API的请求方式。
   URL	填写API的请求URL地址，例如“https://{ip:port}/v1/token”。
   认证方式	选择API的请求认证方式，目前仅支持OAuth2。 OAuth2：调用接口时提供请求的header中需携带Authorization信息，接口获取header中的secret信息，校验成功后才允许调用。 其中，Authorization中的Token信息需要通过Access Token Url获取，所以还需要选择授权类型，并填写Access Token Url、客户端标识、客户端密匙以及Scope。
   认证模板	调用接口时所要添加的认证模板。 如果您已有认证模板，并且可以直接使用。直接选择所需要的模板即可，否则需新增认证模板，具体参见步骤7。

7. （可选）新增认证模板，具体参数如表3所示。

   表3 参数说明

   参数	说明
   模板名称	认证模板的名称，系统会自定义生成一个模板名称。 您也可根据规划自定义，建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。
   认证类型	认证模板的认证类型，目前仅支持OAuth 2.0。
   授权方式	认证模板的授权方式，目前仅支持用户名密码方式。
   获取Token地址	OAuth 2.0服务端中获取Access Token的URL。用于交换访问字符的授权码。
   客户端标识	在应用程序注册过程中向客户端颁发的客户端标识符。
   用户名/密码	调用API获取鉴权时使用的用户名和密码。
   客户端认证方式	设置调用获取token的URL时，认证信息在请求中的位置。

8. 填写请求的param、header、body参数。
9. 设置响应信息的响应类型。
10. 连接参数配置完成后，单击“测试连接”，测试数据源是否可以和EDS进行正常的连通。
    • 若测试结果为“测试连接成功”，则返回文件信息（文件名、类型、大小），则继续下一步。
    • 若测试结果为“测试连接失败”，则根据返回的响应信息检查数据源状态和数据源连接参数配置，然后单击“测试连接”，直到连接成功为止。

11. 测试成功后，单击“保存”，返回数据源列表界面。

相关操作

新增认证模板后，可对认证模板进行如表4的操作。