Machine-Readable Spec(Agent 可直接解析): /openapi-module.json
快速开始
1
微信小程序
「我的」→ 生成授权码
2
在「控制台」输入授权码
换取 API Token
3
携带 Token 调用 API
读取设备数据
Base URL:  
认证方式:  Authorization: Bearer zk_xxx
频率限制:  60 次/分钟/Token
权限范围:  只读(不可控制设备)
接口列表
GET /openapi/devices
获取用户所有设备及最新传感器数据

      
GET /openapi/devices/{device_name}
获取设备详情
参数位置说明
device_namepath设备序列号

      
GET /openapi/devices/{device_name}/data
获取历史遥测数据(列定义从物模型动态解析,返回 columns + records)
参数位置说明
device_namepath设备序列号
limitquery返回条数,默认 20,最大 100

      
GET /openapi/devices/{device_name}/data/trend
获取按天聚合的趋势数据(温度均值/最高/最低、湿度、光照、土壤湿度)
参数位置说明
device_namepath设备序列号
daysquery查询天数,默认 7,最大 365

      
POST /openapi/exchange-token
用授权码换取 API Token(公开接口,无需认证)
参数类型说明
auth_codestring6位数字授权码
curl -X POST  \
  -H "Content-Type: application/json" \
  -d '{"auth_code": "123456"}'

# Response:
{
  "code": 0,
  "data": {
    "id": 1,
    "name": "默认 Token",
    "scope": "read_only",
    "token": "zk_c80aed38ab90d7eb57e11ccfd7e6c66c"
  }
}
GET /openapi/tokens
列出所有 Token
POST /openapi/tokens
创建新 Token
参数类型说明
namestringToken 名称,便于识别
DELETE /openapi/tokens/{id}
吊销 Token(立即生效)
Agent 接入模板

将以下内容提供给 AI Agent(如 Claude、GPT),即可自动生成调用技能:


      
错误码
code说明
0成功
400参数错误
401Token 无效或已过期
403无权访问该设备
404设备不存在
429请求过于频繁(超过 60 次/分钟)
500服务器内部错误

获取 API Token

输入微信小程序生成的 6 位授权码