AI-First 设计,所有接口响应自带自然语言摘要
https://peiot.net/api/ai/v1
通过 HTTP Header 传递 API Key:
X-API-Key: pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
权限等级:read(读取)、write(写入)、control(控制设备)
| 错误码 | HTTP | 说明 |
|---|---|---|
| 0 | 200 | 成功 |
| 40001 | 401 | API Key 缺失 |
| 40002 | 401 | API Key 无效或已禁用 |
| 40010 | 403 | 权限不足 |
| 40011 | 403 | 设备不在白名单 |
| 42901 | 429 | 请求频率超限(每分钟) |
| 42902 | 429 | 请求次数超限(每日) |
| 44001 | 404 | 设备不存在 |
| 44002 | 404 | 无数据 |
| 50002 | 503 | 设备离线 |
健康检查接口,无需认证。
curl https://peiot.net/api/ai/v1/Ping/index
获取设备列表,含在线状态和数据快照。权限:read
| 参数 | 类型 | 说明 |
|---|---|---|
| page | int | 页码,默认 1 |
| page_size | int | 每页条数,默认 20,最大 100 |
| online | int | 在线过滤:1=仅在线,0=仅离线 |
获取设备实时数据(温湿度气压 + 体感温度/露点/舒适度)。权限:read
| 参数 | 类型 | 说明 |
|---|---|---|
| passkey | string | 设备 passkey(32位),必填 |
查询历史数据,支持多粒度。权限:read
| 参数 | 类型 | 说明 |
|---|---|---|
| passkey | string | 设备 passkey,必填 |
| start | int | 起始时间戳(秒),必填 |
| end | int | 结束时间戳(秒),必填 |
| granularity | string | minute / quarter / hour / day,默认自动 |
| fields | string | 指定字段,逗号分隔 |
获取设备状态(电量、信号、存储、内存等)。权限:read
| 参数 | 类型 | 说明 |
|---|---|---|
| passkey | string | 设备 passkey,必填 |
获取自然语言环境摘要,AI 可直接引用。权限:read
| 参数 | 类型 | 说明 |
|---|---|---|
| passkey | string | 设备 passkey,必填 |
| detail | string | brief / normal / detailed,默认 normal |
下发设备命令,通过 MQTT CMD 通道。权限:control
| 参数 | 类型 | 说明 |
|---|---|---|
| passkey | string | Query 参数,设备 passkey,必填 |
| cmd | string | Body,命令名称(白名单内) |
| params | object | Body,命令参数,可选 |
| timeout | int | Body,等待超时 1-30秒,默认10 |
触发立即采样,返回最新数据。权限:control
| 参数 | 类型 | 说明 |
|---|---|---|
| passkey | string | Query 参数,设备 passkey,必填 |
修改设备配置。权限:write
| 参数 | 类型 | 说明 |
|---|---|---|
| passkey | string | Query 参数,设备 passkey,必填 |
| fast_upload | bool | Body,开启/关闭高速上传 |
| timezone_offset | int | Body,时区偏移(秒) |