使用向导模式创建三方API

更新时间: 2023-08-31 11:18:01

支持向导模式创建第三方平台提供的API,生成API以便后续调用,减少资源操作成本。本文介绍如何创建三方API。

前提条件

操作步骤

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

  2. 在页面左上角,单击导航图标 图标,选择协同

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

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

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

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

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

      名称

      说明

      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代码,单击确定,生成对应字段。通过Json新增参数

        说明

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

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

        说明

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

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

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

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

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

相关操作

操作项

说明

编辑API

API资源列表中,单击目标API操作列的编辑,在API编辑向导页面,可对API进行编辑修改。

说明

编辑API参数配置中的云计算资源时,需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致,如果一致可能导致编辑完成后,编辑内容不生效。

复制API

API资源列表操作列,选择更多 > 复制,在API资源列表中生成一个新的草稿API。单击复制API操作列的编辑,对复制的API进行编辑修改。

删除API

  • 单个删除:在API资源列表操作列,选择更多 > 删除,在删除对话框中,单击确定

  • 批量删除:在API资源列表中选选中删除API,单击列表下方的批量删除,在批量删除对话框,单击确定

说明

已上线的API不支持删除。

后续步骤

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

阿里云首页 数据资源平台 相关技术圈