管理 API

本文介绍了通过 API 管理页面对 API 进行新建、测试、编辑、删除等管理操作。

API 管理操作

1. 登录 涂鸦 IoT 平台。

2. 在左侧导航栏中，选择 数据 > 数据分析 > 项目管理，再进入目标项目。

3. 在 项目管理 页面中，选择 数据服务 > API管理。
   

   列表中的表头介绍如下：

   表头	说明
   API 标识	创建 API 后自动生成的唯一标识。
   类型	目前有两种类型：“面板API”和“应用API”。 面板API：仅可以供面板里的数据可视化调用。 应用API：可以供第三方调用，但是只支持云云对接的方式，目前暂未开放。
   描述	该 API 的描述。
   创建人	创建该 API 的账号。
   创建时间	该 API 的创建时间。
   操作	测试：可进行 API 接口的调试。 编辑：进行 API 的编辑。 删除：删除该 API。

4. （可选）单击 API 标识，可查看 API 详情。

   详情包含了该 API 的请求参数、响应参数和字段排序情况。此处无法对信息进行修改，若要修改则需要在 API 列表中进行编辑操作。
   

5. （可选）测试：可以对 API 进行测试。

6. （可选）编辑：单击之后进入该 API 的编辑页面，可进行 API 的重新编辑。

7. （可选）删除：单击之后删除该 API。

新建 API

您可基于自己的需求，从自己存储的数据表中自定义一个 API 的接口，供面板和其他三方应用调用。

前提条件

• 您创建了数据表，且表中有数据。

操作步骤

1. 在 API管理 页面中，单击 新建API 进入创建页面。

2. 选择 API 类型，再输入 API 描述和超时时间后，单击 下一步。
   

   说明：

   • 面板API：仅可以供面板里的数据可视化调用

   • 应用API：可以供第三方调用，但是只支持云云对接的方式，目前暂未开放。

3. 进行参数配置，完成 API 的创建。
   
   

   参数	描述
   数据源选择	数据源类型：有实时表、离线表和时序表，目前仅实时表可用。 选择数据表：选择某个数据源类型下的数据表。
   请求参数配置	可以通过 +新增请求参数 去增加请求参数字段。 需要完善的信息包括参数名称、绑定字段、参数类型、操作符号、默认值和是否必填，其中参数类型是选择某个绑定字段后确定的，无需填写。 您可通过操作符进行参数的规则配置。
   响应参数配置	您可通过 +新增响应参数 去增加响应参数。 需要完善参数名称、绑定字段、参数类型、默认值，其中参数类型是选择某个绑定字段后确定的，无需填写。
   字段排序设置	可以通过 +新增字段排序 去增加排序的字段，API 也会根据该排序规则进行分页。 可以按照某个字段的升序和降序，然后多字段组合进行最终的排序。 您可通过拖拽进行字段顺序的调整。 说明：建议增加的排序字段为创建索引的字段，这样可以加速查询。