凭证式接入
一次登录取 token,全程走 Bearer 鉴权;凭证申请、有效期、过期重取流程完整说明。
一次登录取 token,全程走 Bearer 鉴权;凭证申请、有效期、过期重取流程完整说明。
站点、设备、传感器实时数据、历史数据、曲线聚合、视频地址、在线状态共 7 类查询接口。
读取控制参数、读取地址值、批量读参数、下发控制指令,附完整 address 地址映射与状态位语义。
WebSocket 长连接推送控制参数与气象站数据,免去高频轮询。
统一返回体(code / message / data / timestamp)、统一时间戳约定、统一错误码表。
业务域名与实时控制域名用途对照,避免混用导致的调用失败。
本平台面向日光温室 / 连栋温室场景,提供设备接入、环境数据采集、远程控制与视频接入能力。 本文档是提供给第三方系统集成方的对外接口说明,覆盖 13 个开放接口与 WebSocket 通道。
文档定位
本文档覆盖数据查询、设备控制、实时推送三类开放接口,每个接口均给出完整的请求参数表、 返回字段表、调用示例与注意事项,并附 address 控制地址全量表。 文档中的所有接口、参数与返回字段均经过真实调用验证。
| 我想…… | 去哪看 |
|---|---|
| 5 分钟内跑通第一个接口 | 快速开始 |
| 申请账号、了解对接流程 | 接入流程 |
| 搞清楚该调哪个域名 | 环境与域名说明 |
| 拿到 token 并正确带上 | 获取访问凭证 · 使用凭证 |
| 查某台设备现在的温湿度 | 传感器实时数据 |
| 画一张温度曲线 | 聚合数据(曲线) |
| 打开某座温室的天窗 | 控制设备 |
| 搞懂 address 地址怎么填 | address 控制地址全量表 |
| 排查报错 | 错误码 |
平台对外开放接口按用途分为三条链路,注意它们分属不同域名:
① 业务查询链路 yunshangwenshi.auto-control.com.cn
登录 / 站点 / 设备 / 历史数据 / 聚合曲线 / 视频 / 全量在线状态
② 实时与控制链路 mqtt.iot.auto-control.com.cn
传感器实时数据 / 单设备在线状态 / 控制参数读写 / 控制指令下发
③ 实时推送链路 ws://mqtt.iot.auto-control.com.cn
控制参数推送 / 气象站数据推送域名不要混用
平台同时提供 yunshangwenshi.auto-control.com.cn(业务)与 mqtt.iot.auto-control.com.cn(实时控制)两个域名,用途不同。 请以每个接口页「请求地址」一节给出的域名为准,详见 环境与域名说明。
| # | 接口 | 方法 | 所属链路 | 说明 |
|---|---|---|---|---|
| 1 | /api/account/sign-in | POST | 业务 | 登录并获取访问凭证 |
| 2 | /api/station | GET | 业务 | 站点列表(树形) |
| 3 | /api/device | GET | 业务 | 设备列表 |
| 4 | /api/sensor-data | GET | 实时控制 | 传感器实时数据 |
| 5 | /api/weather-data/avg | GET | 业务 | 聚合数据(曲线) |
| 6 | /api/weather-data/list | GET | 业务 | 历史数据(分页) |
| 7 | /api/video-data/list | GET | 业务 | 视频地址(HLS / FLV 流) |
| 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 | WS | 实时推送 | 控制参数推送 |
| — | /ws/sensor-data/weather-station-data/{deviceCode} | WS | 实时推送 | 气象站数据推送 |
| — | /ws/set-value | WS | 实时推送 | 设定值推送 |
控制类接口请谨慎
第 13 个接口 /api/set-value 会真实驱动温室里的天窗、遮阳幕、风机、湿帘、灌溉阀门等物理设备。 联调阶段请务必使用测试设备,或在业务低峰期、确认现场安全的情况下调用。