使用流程归纳
更新时间: 2023-02-16 15:53:55
阅读 1672
API的创建
下图是在数据服务平台上创建API并进行API开发的流程图:
API开发者:
对于API开发者,需要选择具体的数据源、表、配置请求参数和返回参数,正确配置API的取数逻辑,对API进行测试,API测试成功后即可发布API;
API调用者:
对于API调用者,可以在API集市查看详情,支持申请API,支持新创建应用,生成KEY和Secert,同时下载操作文档,正确调用API。
API开发流程:
- 登记数据源;
- 创建API集合;
- 选择通过向导(或者SQL模式)创建API;
- 配置API基本信息:包括协议、请求方式、返回类型和设置超时时间等;
- 配置API参数:配置请求参数和返回参数,包括参数名称、类型和描述等;
- 保存和测试:在线发送请求,显示请求详情和返回内容;
- 发布API:测试成功的API才可以进行发布;
- 绑定应用:处于发布状态的API才可以授权应用。
API注册
平台支持将已有的API通过注册功能,统一由数据服务平台进行管理。
注意: 在使用注册API功能时,需要先通过数据源登记功能,将已有的API登记进元数据中心,以便于在注册功能中选择已登记好的API。 |
API注册整体流程如下:
- 登记API数据源类型;
- 创建API集合;
- 在API列表选择注册API功能;
- 配置API基本信息:包括API名称、协议、返回类型、设置超时时间等;
- 配置API参数:选择已注册的API数据源,添加请求参数和响应示例;
- 保存和测试:在线发送请求,测试注册API的连通性和返回内容;
- 发布API:测试成功的API才可以进行发布;
- 绑定应用:处于发布状态的API才可以授权应用。
对于新建API和注册API,API创建成功之后,后续的操作过程雷同,都需要绑定应用,通过应用鉴权调用,也可以发布后在API集市申请使用。
更多有关新建API和注册API的使用,可查看API开发和管理章节
文档反馈
以上内容对您是否有帮助?