使用向导模式创建三方API

前提条件

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

操作步骤

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

2. 在页面左上角，单击图标，选择协同。

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

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

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

6. 在三方API-创建页面，开始新建API。

   1. 设置API基础信息。

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

   2. 在参数配置区域，配置API参数。

      参数	说明
      资源组	选择服务资源组。 说明 上线后API的测试和调用会占用资源组，请根据资源组的规格和占用情况，选择适合的服务资源组。
      签名方式	选择签名方式。
      请求参数和返回参数	根数业务情况设置请求参数和返回参数，此处以请求参数（Body）为例说明。 在请求参数（Body）区域，单击新增参数，选择新增参数，填写字段名称、选择数据类型、设置默认值、是否必填、授权时筛选等。 在请求参数（Body）区域，单击新增参数，选择通过JSON新增，在通过Json新增参数对话框，粘入对应的Json代码，单击确定，生成对应字段。 说明 授权时筛选若选择是，在授权页面，会展示授权过滤配置项，具体操作，请参见授权API。 新增参数和通过JSON新增任选一种方式即可，两种方式会互相覆盖已设置的参数。 请求参数来源于注册的API提供商的URL的请求参数。
      过滤器	（可选）打开过滤器开关，设置信息模块展示隐藏，更多信息，请参见API结果过滤器。

   3. 测试API：单击开始测试，核对返回内容。

   4. 配置API流量控制。

      参数	说明
      API最大调用QPS	API最大调用QPS应为不大于10000的正整数。当服务资源组设置为“公共资源组”时，API最大调用QPS只能为1。更多信息，请参考API流量控制支持的参数。
      超时配置	请选择API单次响应超时时间。当服务资源组设置为“公共资源组”时，API单次响应超时时间限制，最大支持10s。
      开启缓存	打开开启缓存开关，API调用会请求缓存。
      缓存时长	当缓存开启后，可以手动设置缓存失效时间，缓存时长上限为3600秒。

7. API参数配置完成后，单击保存或保存并上线。

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

相关操作

后续步骤

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