一、概述
物联云平台提供高性能、高可用的API托管服务。通过API网关帮助企业建立完整的API发布、管理、维护生命周期管理。用户只需要进行简单的操作，即可快速、低成本的开放数据和服务。
二、快捷入口
2.1.平台访问授权
2.2.后端API注册
三、 操作指引
3.1.创建前端API
前往物联云平台管理台【应用中心->API网关->API管理】
创建一个API
设置API基本信息
| 字段名称 | 说明 |
|---|---|
| API名称 | API的描述性名称 |
| 所属分组 | API所属的API分组 |
| 描述 | API的备注信息 |
| 认证方式 | B端用户认证、C端用户认证、无认证、外部认证、应用端认证 |
点击下一步,设置对应的后端服务信息。
后端服务提供两种方式配置，一种为平台预置的服务（系统），另一种为企业自定义服务的路径（自定义）。
选择平台预置的服务，则可以使用【应用中心->API网关->服务管理】中已完成配置的服务和对应的接口。
选择企业自定义的服务，则需要填写后端服务的地址和对应的接口参数。
| 字段名称 | 说明 |
|---|---|
| 后端服务地址 | 后端服务所部署的地址 |
| 后端请求path | 服务下接口的路径地址 |
| 请求method | 前端的请求方法 |
| 后端超时 | 后端接口返回的超时时间限制 |
| 后端参数名称 | 参数的名称 |
| 后端参数位置 | 参数在结构体中的位置 |
| 必填 | 参数是否必填 |
| 描述 | 参数的备注说明 |
点击下一步,设置对应的API请求信息。
| 字段名称 | 说明 |
|---|---|
| 请求path | 请求的路径地址 |
| 入参模式 | 采用请求参数和后端服务接口的参数映射 |
| 请求方法 | 前端的请求方法 |
| 入参参数名 | 后端接口返回的超时时间限制 |
| 映射参数位置 | 参数的名称 |
| 参数类型 | 参数在结构体中的位置 |
| 后端参数名称 | 参数是否必填 |
| 后端参数位置 | 参数的备注说明 |
| 描述 | 参数的备注说明 |
点击下一步,设置对应的返回结果信息。
当后端服务信息选择平台预置的服务时，则不需要填写返回信息。当后端服务信息选择企业自定义服务时，可根据需要填写接口的返回示例和错误码说明。
| 字段名称 | 说明 |
|---|---|
| 成功响应示例 | 接口返回成功结果的示例说明 |
| 失败响应示例 | 接口返回失败结果的示例说明 |
| 错误码 | 接口定义的业务错误码 |
| 错误信息 | 接口定义的业务错误码对应的文字说明 |
3.2.创建前端API分组
前往物联云平台管理台【应用中心->API网关->分组管理】
点击创建一个API分组
填写表单信息后确定保存
3.3.创建后端API服务
前往物联云平台管理台【应用中心->API网关->服务管理】
创建一个API服务
填写表单信息后确定保存
| 字段名称 | 说明 |
|---|---|
| 服务名称 | 后端服务的描述性名称 |
| 命名空间 | 后端服务所对应的命名空间 |
3.4.创建应用
前往物联云平台管理台【应用中心->API网关->应用管理】
点击创建一个应用
填写表单信息后确定保存
找到已完成创建的应用后点击管理
在详情页中点击授权API
勾选需要授权至应用的API
3.5.创建API访问控制策略
前往物联云平台管理台【应用中心->API网关->访问控制】
创建一个访问控制策略
填写表单信息后确定保存
| 字段名称 | 说明 |
|---|---|
| 访问控制名称 | 访问控制策略的描述性名称 |
| 控制类型 | 设置访问控制策略类型是允许访问或者禁止访问 |
| 描述 | 访问控制策略的备注说明 |
| IP名称 | 允许访问或禁止访问的IP地址 |
找到已完成创建的访问控制策略后点击管理
在详情页中绑定API
勾选需要绑定至访问控制策略的API
3.6.创建API流量控制策略
前往物联云平台管理台【应用中心->API网关->流量控制】
创建一个流量控制策略
填写表单信息后确定保存
找到已完成创建的流量控制策略后点击管理
在详情页中绑定API
勾选需要绑定至流量控制策略的API
