"原子云平台API文档V1.2修订记录及使用流程"

原子云平台API文档V1.2修订记录： 总体说明 原子云开放平台提供了HTTPS和WebSocket两类协议的API，供用户定制开发业务相关应用。其中，HTTPS协议接口完成管理功能，如获取设备列表、设备在线状态等；WebSocket协议接口通过长连接，实现设备状态和消息订阅，以及向设备发送消息等。通讯逻辑如下图所示： 版本号 日期 描述 01 2018-8-10 第一版 02 2019-3-16 增加接口描述 03 2019-6-19- 增加WebSocket协议的数据编码说明，增加4G DTU设备类型说明 使用流程 协议接口地址 HTTPS接口地址：https://cloud.alientek.com/api，端口号：443 WebSocket接口地址：wss://cloud.alientek.com/conntecion，端口号：443 HTTPS协议接口 鉴权 原子云HTTPS接口采用JSON WEB TOKEN鉴权，每次API请求，需在REQUEST HEADER中放置名为token的参数，参数值可从管理后台中获取。例如： { "token": "your_token_value" } 请求示例 获取设备列表 接口描述：用来获取已绑定设备的详细信息列表 请求方式：GET 接口地址：https://cloud.alientek.com/api/devices 请求参数：无 头部信息：{ "token": "your_token_value" } 返回示例 { "code": 200, "data": [ { "device_id": "123456", "device_name": "Device1", "device_type": "Temperature Sensor", "status": "Online", "last_seen": "2022-01-01 12:00:00" }, { "device_id": "789012", "device_name": "Device2", "device_type": "Humidity Sensor", "status": "Offline", "last_seen": "2022-01-01 11:00:00" } ] } WebSocket协议接口 数据编码说明 WebSocket协议采用JSON格式进行数据交互，数据编码方式为UTF-8。客户端与服务器端建立WebSocket连接后，可进行订阅设备状态、接收设备消息等操作。 例：订阅设备状态 客户端发送订阅请求消息格式： { "action": "subscribe", "device_id": "123456" } 服务器端返回设备状态更新消息格式： { "device_id": "123456", "status": "Online", "last_seen": "2022-01-01 12:00:00" } 4G DTU设备类型说明 除了常见的传感器设备外，原子云还支持4G DTU设备类型。用户可通过HTTPS接口绑定和管理4G DTU设备，并通过WebSocket接口与4G DTU设备进行实时通讯。 在使用4G DTU设备时，需要在设备管理后台获取相应的设备ID和token，并按照接口文档中的协议格式进行通讯。 结语 原子云平台API文档V1.2介绍了平台提供的HTTPS和WebSocket两类协议接口的使用方法和注意事项，包括鉴权方式、请求示例、返回示例、数据编码说明、4G DTU设备类型说明等内容。用户在进行业务开发时，可根据本文档中的接口描述进行相应的接口调用和数据交互。对于特定类型的设备，也需注意根据文档的要求进行相应的配置和管理。如有任何疑问或问题，可联系原子云平台技术支持团队进行咨询和解决。