概要:
???? 配置 API 允许 HTTP RESTful 客户端添加、编辑、读取和删除服务器内的信道、设备和标记等对象,但操作(读写)不了任何标记下的当前值.
功能:
- 标准用户可读 JSON 数据格式的对象定义
- 支持服务器中某些对象的触发和监控操作
- 通过 HTTP 基本验证和 HTTP over SSL (HTTPS) 的安全性
- 支持基于用户管理器和安全策略插件的用户级访问
- 具有可配置详细程度和保留级别的事务处理日志记录
注意:此文档假定您熟悉 HTTP 通信和 REST 概念。
???? 官方给出的最佳做法是发出 GET 请求、保存当前项目 ID,然后将该 ID 用于以下 PUT 请求。如果仅使用一个客户端,客户端可能会将属性 "FORCE_UPDATE":true 放在 PUT 请求主体中,以强制配置 API 服务器忽略项目 ID
===== 欢迎加入KEPServerEX QQ讨论群:905485143 ======

=====================================================
1. KEPServerEX 配置:?
? ? ?设置配置API服务 【启用】

?打开? http://localhost:57412/config/?? 或? http://127.0.0.1:57412/config/

API文档? :? http://localhost:57412/config/v1/doc/drivers

?支持的驱动程序?? :? http://localhost:57412/config/v1/doc/drivers

?2.?Postman 接口测试工具
? ? ?
? ? 2-1. 发出HTTP GET 请求 从服务器中检索
? ? ?打开 postman 工具,
? ? ?输入 URL? :??? http://127.0.0.1:57412/config/v1/project/channels/Simulator/devices/Si001/tags/K01
? ? ?设置 :Authorization?? 设置访问的【用户、密码】
? ? 点击: 【send】
? ?正常有返回 【JSON】 格式数据

?
2-2. URL说明:
???? api? 文档 :http://127.0.0.1:57412/config/v1/doc
示例:? http://127.0.0.1:57412/config/v1/project/channels/Simulator/devices/Si001/tags/K01
IP 加 端口号? : http://127.0.0.1:57412
API? Endpoint 格式:/config/v1/project/channels/
API 示例:???? /config/v1/project/channels
说明:? 返回 当前已设置的所有通道(Channel)

API? Endpoint 格式:/config/v1/project/channels/{name}
API 示例 :??? /config/v1/project/channels/Simulator
说明:? 返回 当前已设置的通道中的(Simulator)

2-4.?测试? :?
/config/v1/project/channels/Simulator/devices/Si001/tags/K01
IP 加 端口号? : http://127.0.0.1:57412
API? Endpoint 格式:/config/v1/project/channels/{name}
API 示例 :??? /config/v1/project/channels/Simulator
说明:? 返回 当前已设置的通道中的(Simulator)

2-5. IP 加 端口号?
: http://127.0.0.1:57412
API? Endpoint 格式:/config/v1/project/channels/{name}/devices/
API 示例 :??? /config/v1/project/channels/Simulator/devices/
说明:? 返回 当前已设置的通道中的Simulator的所有 devices? (Si001)

2-6. IP 加 端口号?
: http://127.0.0.1:57412
API? Endpoint 格式:/config/v1/project/channels/{name}/devices/{name}/tags/{name}
API 示例 :??? /config/v1/project/channels/Simulator/devices/Si001/tags/K01
说明:? 返回 当前已设置的通道中的(Simulator)

?3.?发出HTTP POST 请求 从服务器中检索
打开 postman 工具
输入 URL? :????? http://127.0.0.1:57412/config/v1/project/channels
打开 【Body】??? 选择 【raw】?? 选择【JOSN】
输入? :? {"servermain.MULTIPLE_TYPES_DEVICE_DRIVER":"Modbus TCP/IP Ethernet","common.ALLTYPES_NAME":"Modbus"}
说明? :? 在服务器上? 创建一个 通道? 名为【Modbus】,驱动为 :【Modbus TCP/IP Ethernet】

?
配置 API 服务将从 REST 客户端接收标准 JSON 格式的请求。
这些请求在服务器中使用,并细分为创建、读取、更新或删除命令。
common.ALLTYPES_NAME??? :? 通道 名称 (通道级)
servermain.MULTIPLE_TYPES_DEVICE_DRIVER?? :?? 驱动协议 全称
Devices?? :? 设备(级)
===== 欢迎加入KEPServerEX QQ讨论群:905485143 ======
4. 创建说明
4-1. 创建对象
????? 可以HTTP POST 请求发送至配置 API 来创建对象,每个对象都必须具有名称),但并非需要所有属性
POST JSON 主体示例:
{"<属性1_名称>": <值>,
"<属性2_名称>": <值>,
"<属性3_名称>": <值>
}
4-2. 创建多个对象
POST JSON 正文示例:
[{"<属性1_名称>": <值>,
"<属性2_名称>": <值>,
"<属性3_名称>": <值>
},
{"<属性1_名称>": <值>,
"<属性2_名称>": <值>,
"<属性3_名称>": <值>
}]
4-3. 创建具有子层次结构的对象
???? 可以创建具有完整子对象层次结构的对象。为此, 请将该层次结构包括在 POST 请求中, 就像将其保存在 JSON 项目文件中时一样。例如, 要创建带下属设备的通道, 可以使用以下 JSON:
[{
"common.ALLTYPES_NAME": "Channel1",
"servermain.MULTIPLE_TYPES_DEVICE_DRIVER": "Simulator",
"devices": [
? ? ? ? ? ? ? ? ??{"common.ALLTYPES_NAME": "Device1",
????????????????? "servermain.MULTIPLE_TYPES_DEVICE_DRIVER": "Simulator",
????????????????? "servermain.DEVICE_MODEL": 0}
???????????????? ]
??}]
|