调用约定
调用约定
开放平台 HTTP 接口统一为 POST https://openapi.lechange.cn/openapi/[method],请求体与响应体均为 JSON。先 获取 token,再在 params.token 传入 accessToken(除少数免 token 方法外),组装其余 params 后按 签名 计算 system.sign,再发起调用。
接口域名
| 请求类型 | 域名 |
|---|---|
| HTTP POST | https://openapi.lechange.cn:443/openapi/[method] |
[method] 为接口方法名(如 accessToken、bindDevice)。URL 路径不含版本号;协议版本写在请求体 system.ver(当前固定 1.0)。
请求体结构
| 字段 | 类型 | 说明 |
|---|---|---|
system.ver | String | 协议版本,当前为 1.0 |
system.sign | String | 签名,计算见 签名 |
system.appId | String | 应用 ID,在 控制台 · 我的应用 · 应用信息 获取 |
system.time | Long | 客户端 UTC 时间戳(秒),与平台时间误差不超过 5 分钟,否则 SN1002 |
system.nonce | String | 随机字符串;可用标准 UUID(含连字符,见下例)或 32 位十六进制串。5 分钟内不可重复,否则 SN1005 |
params | Map | 各接口业务参数 |
params.token | String | 多数业务接口必填(管理员或子账号 accessToken)。accessToken 等少数方法自身不需要;缺失或无效 → OP1007(见 错误码) |
id | String | 请求唯一 ID,建议 UUID |
获取管理员 token 的请求示例(sign 需按签名规则自行计算):
{
"system": {
"ver": "1.0",
"appId": "lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"time": 1706511734,
"nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
},
"id": "98a7a257-c4e4-4db3-a2d3-d97a3836b87c",
"params": {}
}
响应体结构
| 字段 | 类型 | 说明 |
|---|---|---|
result.code | String | 返回码,0 为成功;分组见 错误码 |
result.msg | String | 返回码描述 |
result.data | Map | 业务数据 |
id | String | 与请求中的 id 一致 |
成功响应示例:
{
"result": {
"msg": "操作成功。",
"code": "0",
"data": {
"expireTime": 259176,
"accessToken": "<yourAccessToken>"
}
},
"id": "98a7a257-c4e4-4db3-a2d3-d97a3836b87c"
}
HTTP 状态码为 200 时仍可能出现业务失败,以 body 内 result.code 为准。
相关
- 签名
- 获取 token → accessToken
- 首次接口调用
- 各业务方法参数见 API 参考 对应分组