公共约定
公共约定
所有 OpenAPI 方法共用同一套 URL、统一 JSON 请求体、签名与返回码。本组按主题拆分;第一次接入建议按下列顺序阅读,再进入具体方法页。
建议阅读顺序
| 步骤 | 主题 | 说明 |
|---|---|---|
| 1 | 调用约定 | 域名、system / params / id、响应结构 |
| 2 | 签名 | system.sign 计算与标准试算 |
| 3 | 获取 token | 管理员 accessToken 种类、有效期与换取流程 |
| 4 | accessToken | 换取管理员 token 的方法页(参数表与错误码) |
| 5 | 首次接口调用 | 串联一次完整 HTTP 调用 |
| 6 | 错误码 | result.code 按业务场景分表(见 公共约定 → 错误码) |
| 7 | 限额与频率 | 日调用量、账号/设备频率上限 |
| 8 | 版本与变更策略 | system.ver、SDK 与文档 permalink 变更 |
本组索引
| 页 | 用途 |
|---|---|
| 调用约定 | 请求/响应体结构(分主题正文) |
| 签名 | 鉴权 sign(分主题正文) |
| 获取 token | token 概念与 accessToken 衔接 |
| 错误码 | 全站错误码分表(本组 04.错误码) |
| 限额与频率 | 配额与频率唯一正文 |
| 版本与变更策略 | 协议版本、SDK 与文档变更 |
需要单页打印或离线查阅时,可使用合并版 开发规范(与调用约定、签名片段同源)。