文档中心 / 接口文档

云智联开放 API v2

面向应用开发者与 AI 智能体的只读/控制接口。Base URL：https://open.yzlkj.com；请求头携带 YZLIOT-APIKEY（在小程序「我的」→「开放接口」生成）。

端点一览

方法	路径	说明	限流
GET	/open/ping	连通性与鉴权自检	未文档化
GET	/open/device/all	获取全部设备（简易信息，不含设施集）	10 次 / 10 秒
GET	/open/device/list	分页获取设备列表（含设施集），支持 SkipCount / MaxResultCount（≤50）/ Filter	5 次 / 10 秒
GET	/open/device/{id}	获取设备详情（含 facilitys 设施集）	10 次 / 10 秒
GET	/open/history	获取设施值历史：facilityId / StartTime / EndTime / MaxCount（格式 YYYY-MM-DD HH:mm:ss）	2 次 / 10 秒
POST	/open/command/send	下发控制指令：deviceId / type（如 SetFac）/ args / waitConfirm / waitTimeout(5~20s)	2 次 / 5 秒
GET	/open/command/list	分页获取指令记录：DeviceId / SkipCount / MaxResultCount	2 次 / 10 秒
GET	/open/command/{id}	获取单条指令状态	2 次 / 5 秒

设施键与型号对照

设施键	含义	取值 / 单位	适用型号
wd	温度	℃	土壤温湿度云传感器（YZLSTM1 / STMCBL / STMCS1）
sf	湿度	%	土壤温湿度云传感器
kk1	开关	1=开 / 0=关	远程电磁阀（WA1CB1 / WANCD1）
yw	液位	—	低功耗液位传感器（YZLWP01）

响应与状态码

成功响应统一为 { code: 0, data: ... }；业务状态码：0 成功、400 参数错误、401 未授权 / 无效 APIKey、 403 权限不足、429 请求频率超限、500 服务器错误。

开阀示例

POST /open/command/send
YZLIOT-APIKEY: <你的 Token>

{
  "deviceId": "WANCD1-0000000001",
  "type": "SetFac",
  "args": ["WANCD1-0000000001", "kk1", "1"],
  "waitConfirm": true,
  "waitTimeout": 10
}

本文档依据客户已公开的开放接口说明整理；完整 OpenAPI 3.1 描述文件可向我方索取。内部中间件协议（南向设备连接 / 北向数据接口）不在本文档范围内。