创建设备API

操作场景

通过将IoT实际API与规范API进行映射创建生成设备API，可将其作为数据建模、数据服务时配置的数据来源，用来获取OT数据。

本文指导您如何新增设备API。

前提条件

已获取开发人员及以上权限用户的账号和密码。

操作步骤

1. 登录LinkX-F系统首页。
2. 选择“基础数据管理 > 设备API”，进入“设备API”页面。
3. 单击“创建”，弹出“创建设备API”页面。
4. 填写基本信息，如表1所示：

   表1 基本信息

   字段	说明
   API类型	必填，下拉选择API类型： 查询最新：用来查询指定设备最新的采集信息。 查询异常：用来查询指定设备最新的异常信息。
   是否批量接口	是否是查询批量设备OT数据的接口。 默认值为“否”。
   API英文名称	设备API的英文名，必填且不能重复，必须以大写字母开头，且只能包含字母、数字、下划线。
   API中文名称	设备API的中文名，非必填，必须以中文或者字母开头，且只能包含中文、字母、数字、下划线。
   API URL	必填，手工输入，用于指定访问此API的URL。
   请求方式	必填，下拉选择，用于指定访问此API的请求方式。 说明： 当API为批量接口时，仅支持POST请求方式。
   API描述	非必填，可包含中文、英文、数字、特殊字符和空格，长度不能超过1024个字符。
   Swagger内容	必填，手工输入。此内容通过接入API的Swagger内容获取接口的详细出入参信息，支持Swagger2.0和Swagger 3.0。 单击“填写示例”查看不同版本的Swagger内容填写模板。

5. 请求头配置。

   如需配置请求头，请填写key值和value值，单击“新增请求头”可添加多条。

6. 规范API参数映射配置。
   • 从“Swagger入参”处拖动字段至“规范API入参”对应字段后的填写框中。
   • 从“Swagger出参”处拖动字段至“规范API出参”对应字段后的填写框中。

7. 选择是否开启安全连接。默认值为“是”，可选“否”。
   • 是：表示会校验服务端证书。此选择能保证您与网站之间建立的连接安全性，请确保服务端证书的有效性，否则可能连接测试失败。
   • 否：表示不校验服务端证书。此选择无法保证您与网站之间建立的连接安全性，请勿上传输敏感信息，可能会被攻击者盗取信息。

8. 填写完成后单击“连接测试”，切换至“运行测试”页签。
9. 根据接入API中的定义，填写请求参数值，单击“连接测试”。
10. 运行结果处显示测试结果，多次调试直至测试通过后单击“保存”。