API管理

API管理功能用于管理已发布的API，可以对API执行上线/下线切换、测试、下载文档等操作。

操作说明

1. 登录平台，进入数据服务，选择“服务管理 > API管理”，可查看所有已发布API的基本信息。

   

2. 对于选中的API，点击操作栏的【上线】、【下线】、【测试】、【策略管理】和【查看文档】可执行相应的操作。【上线】、【下线】操作用于切换API的状态，已上线的API是经过测试、发布的API，具有权限的应用可以直接调用，已下线的API是经过发布但已下线的API，下线的API不可再调用，但可重新上线。若API下线后被编辑过，则需测试通过后才可重新发布上线。

3. 点击API操作栏的【测试】操作可进入API测试模块对API进行调用测试。

   

4. 点击【查看文档】操作，可查看相应API的说明文档，并且支持下载API文档。

5. 点击【策略管理】操作，可进入API的策略管理页面。策略管理页面展示API已授权的应用、告警策略和流控策略。可在页面中新增绑定的授权应用或告警策略，以及解绑现有的授权应用和告警策略。一个API最多可选择10个告警策略，最多可绑定一个流控策略。

   

API测试

API测试是所有已发布API的测试中心，可选择任意API进行单次的调用测试，查看请求详情和返回内容值。

操作说明

1. 登录平台，进入数据服务，选择“服务管理 > API测试 ”。

2. 可通过下拉框选择一个API进行测试，测试前需填写API的参数取值。点击【开始测试】按钮可测试API，页面右侧将显示请求详情和API的返回内容，以便检验数据和功能的有效性。

   

3. 点击API操作栏的【测试】操作可进入API测试模块对API进行调用测试。

   

API调用

应用授权

应用授权功能用于管理可调用API的授权应用，支持新增应用授权、管理应用授权和授权有效期等。

操作说明

1. 登录平台，进入数据服务，选择“服务管理 >API调用 > 应用授权 ”。可在此页面管理API授权应用。
2. 点击【新增应用】按钮，将显示“新增应用”弹窗，填写应用名称、有效期、授权的API分组、IP白名单、描述等信息后，点击【确定】按钮可新增一个授权应用。系统将为应用自动生成秘钥（appSecret），生成的应用可用于访问已授权分组里的所有API。
   
3. 支持根据应用名称、创建用户等信息进行应用查询。
4. 点击操作栏的【编辑】按钮，可编辑应用的名称、描述、有效期、授权分组等信息。
5. 点击操作栏的【删除】按钮，可删除相应的应用，删除的应用不可再用于调用API。仅未绑定api的应用支持删除。

流控策略

流控策略功能用于管理作用于API的流控策略，页面列表中显示所有已添加的流控策略。支持新增、编辑、删除等操作。

操作说明

1. 点击【新增策略】按钮，可在新增流控策略弹窗中填写流控策略的相关信息。

2. 点击流控策略对应的【编辑】按钮可编辑流控策略，编辑流控策略时，所有内容均可编辑，编辑后的策略自动更新到所绑定的API。
3. 点击流控策略对应的【删除】按钮可删除流控策略。注意，仅没有绑定API的流控策略支持删除。删除时需进行二次确认。

告警策略

告警策略功能用于管理作用于API的告警策略，告警策略页面的列表中显示所有已添加的告警策略。支持新增、编辑、删除等操作。

操作说明

1. 点击【新增策略】按钮，可在新增告警策略弹窗中填写告警策略的相关信息，其中联系人和机器人需在运维中心的通道管理中配置，目前支持短信、站内信、企业微信机器人、邮箱等告警方式。

2. 点击【编辑】按钮，可编辑修改告警策略的相关信息。
3. 点击【删除】按钮，即可删除当前告警策略，已被使用的告警策略不支持删除。