使用向导模式创建三方API

前提条件

• 已创建工作组，具体操作，请参见新建工作组。

• 已创建应用，具体操作，请参见新建应用。

操作步骤

1. 登录数据资源平台控制台。

2. 在页面左上角，单击图标，选择研发工作台。

3. 在顶部菜单栏，单击图标，选择目标工作组，单击资产加工。

   说明

   若您已在资产加工页面，请跳过“单击资产加工”的操作。

4. 在左侧导航栏，单击图标，选择API开发 > 三方API。

5. 在API资源页面右上角，选择创建API > 向导创建。

6. 在创建API向导页面，开始新建API。

   1. 设置API基础信息：设置API的名称、所属应用、API提供商URL、选择ContentType、请求方式、API Path、调用认证方式、标签和描述等，单击下一步。

      名称	说明
      API名称	需创建API的名称，自定义。
      所属应用	API的归属应用，自定义创建，支持在系统设置模块和创建API页面新增应用，关于新建应用，更多请参见新建应用。
      API提供商URL	联系对应提供商获取。
      ContentTyp	联系对应提供商获取。
      请求方式	根据封装的API选择对应的请求方式，支持POST和GET。
      API Path	API调用时展示的固定路径，默认自动生成。
      调用认证方式	简单身份认证和加密身份认证两种方式，更多信息，请参见认证方式说明。 简单身份认证：适用于工作组内、测试等场景下的API调用，工作组内调用时用API归属应用的AppCode调用。 加密身份认证：通过加密算法计算一个签名并放在请求的Header中即可调用API，具备更高的安全性，适用于API共享后，应用开发场景下API的调用。
      标签	自定义，可选。
      描述	针对该API增加的描述信息，自定义，必选。

   2. 配置API参数：以请求参数（Body）为例说明。

      • 单击签名方式下拉框，选择对应签名方式或自定义签名方式。

        说明

        若选择自定义签名方式，单击操作列的编辑，在编辑脚本对话框中输入脚本函数，单击确定。

      • 在请求参数（Body）区域，单击新增参数下拉框，选择新增参数，填写字段名称、选择数据类型、设置是否必填，以及填写默认值等。

      • 在新增参数下拉框，单击通过JSON新增，弹出通过JSON新增，粘入对应的JSON代码，单击确定，生成对应字段。

        说明

        请求参数来源于注册的API提供商的URL的请求参数。

   3. API配置及测试：选择是否需授权时筛选，并设置过滤器，单击开始测试，查看返回内容后，单击下一步。

      说明

      授权时筛选若选择是，在授权页面，会展示授权过滤配置项，具体操作，请参见授权API。

      过滤器是API数据适配器开关，设置信息模块展示隐藏，更多信息，请参见API结果过滤器。

   4. 查看返回内容：单击下一步。

   5. 配置流量控制参数：填写API最大调用次数，选择超时配置后，单击完成。

      在API资源列表，可查看新建的API。

相关操作

后续步骤

API创建完成后，需要对API进行上线操作，具体操作，请参见上线API。