外观
变更记录
本页记录文档与接口的版本变更。对接方在升级前请先查看本页,确认是否有影响你的改动。
v3.0 当前版本
文档
首个正式版本。覆盖数据查询、设备控制、实时推送三类开放接口,共 13 个 HTTP 接口与 3 个 WebSocket 通道。
内容组织:
| 章节 | 内容 |
|---|---|
| 一、接入指南 | 快速开始、接入流程、环境与域名说明 |
| 二、认证鉴权 | 获取访问凭证、使用凭证 |
| 三、接口规范 | 通用说明、错误码 |
| 四、数据查询 | 站点、设备、实时数据、历史数据、聚合曲线、视频地址、在线状态(7 个接口) |
| 五、设备控制 | 读取控制参数、读取地址值、批量读控制参数、控制设备(4 个接口) |
| 六、实时推送 | WebSocket 接口(3 个通道) |
| 七、附录 | address 控制地址全量表、因子对照表、设备类型映射表 |
文档中的接口地址、请求参数、返回字段、错误码,均以真实调用结果为准。
接口契约
| 项 | 说明 |
|---|---|
| 接口地址 | 无变化 |
| 请求方法 | 无变化 |
| 请求参数 | 无变化 |
| 返回字段 | 无变化 |
本文档不做接口变更
本文档只描述平台当前生效的接口行为。接口如有变更,会先在本页登记。
接口清单
数据查询
| # | 接口 | 方法 | 域名 |
|---|---|---|---|
| 1 | /api/account/sign-in | POST | 业务 |
| 2 | /api/station | GET | 业务 |
| 3 | /api/device | GET | 业务 |
| 4 | /api/sensor-data | GET | 实时控制 |
| 5 | /api/weather-data/list | GET | 业务 |
| 6 | /api/weather-data/avg | GET | 业务 |
| 7 | /api/video-data/list | GET | 业务 |
设备控制与状态
| # | 接口 | 方法 | 域名 |
|---|---|---|---|
| 8 | /api/mqtt-client-status | GET | 实时控制 |
| 9 | /api/control/mqtt | GET | 业务 |
| 10 | /api/device_status | GET | 实时控制 |
| 11 | /api/get-value | GET | 实时控制 |
| 12 | /api/set-value/flush | GET | 实时控制 |
| 13 | /api/set-value | POST | 实时控制 |
实时推送
| 通道 | 协议 | 域名 |
|---|---|---|
/ws/device-status | WebSocket | 实时控制 |
/ws/sensor-data/weather-station-data/{deviceCode} | WebSocket | 实时控制 |
/ws/set-value | WebSocket | 实时控制 |