JSON 规范

所有服务接口均采用 JSON 格式。本页面记录了通用的模式。

端口

港口	界面	版本
10001	HTTP REST + WebSocket（模拟通道）	v3.1（当前版本）
10020	WebSocket（事件通道，只读）	—
10000	旧版 WebSocket（v3.0 — 将在 v4.0 中移除）	v3.0

HTTP 响应封装

每个 HTTP 响应都使用相同的封装：

成功（基于数据）：

{ "ok": true, "data": { … } }

成功（无数据——仅限突变相关终点）：

{ "ok": true }

错误：

{ "ok": false, "error": "reason string" }

已弃用的端点：

{ "ok": true, "deprecation_warning": "This route is deprecated. Use …" }

HTTP 状态码

代码	含义
200	成功
400	请求错误 — 请求体无效、选择器不明确、缺少必填字段
404	找不到设备、会话或资源
405	方法不被允许

WebSocket 消息格式

消息是 JSON 对象。顶级键是设备组名称 (inverse3, verse_grip, wireless_verse_grip) 以及一个可选的 session 会话级命令的键。

客户端 → 服务（命令）：

{
  "session": { "configure": { … } },
  "inverse3": [
    { "device_id": "049D", "configure": { … }, "commands": { … } }
  ]
}

服务 → 客户（状态）：

{
  "session_id": 7,
  "inverse3": [
    { "device_id": "049D", "config": { … }, "state": { … }, "status": { … } }
  ]
}

该服务发送的首条消息包含 config （完整快照）；后续 消息仅包含 state 和 status. 参见 WebSocket 协议 查看完整工作流程。

内容类型

所有带有正文的 HTTP 请求都必须发送 Content-Type: application/json. WebSocket 消息始终是明文 JSON 帧。

未知键

未知键将被静默忽略

该服务目前会忽略未识别的 JSON 键，且不会报错。如果某个 命令似乎没有生效，请检查服务日志，并对照API 参考文档核对字段 名称。 计划在未来版本中更改此行为（未知键将 触发警告事件）。