公共参数
请求公共参数(HTTP Header)
所有 API 请求的鉴权信息都通过 HTTP Header 传递,请求体(body)保持为纯业务 JSON。
| Header | 类型 | 必填 | 说明 |
|---|---|---|---|
X-Loxily-AppKey | string | 是 | 项目 App Key |
X-Loxily-Timestamp | number(字符串形式) | 是 | Unix 秒(或毫秒),有效窗口 5 分钟 |
X-Loxily-Sign | string | 是 | 请求签名,详见签名算法 |
响应公共字段
所有接口响应都含以下顶层字段(成功或失败):
| 字段 | 类型 | 说明 |
|---|---|---|
success | boolean | 是否成功 |
code | number | 业务码;0 表示成功,其它为错误码 |
msg | string | 人类可读的简短消息 |
trace_id | string | 本次请求的链路 ID。用于日志排查;可在开放平台页面「调用日志」中按此 ID 反查完整请求与回调记录 |
data | object | null | 业务数据;失败时为 null |
响应格式
成功
json
{
"success": true,
"code": 0,
"msg": "ok",
"trace_id": "8a3f12ab-4d2a-9f51-7e2c6d8a9101",
"data": { ... }
}响应 Header 额外会返回:
X-Loxily-Trace-Id: 8a3f12ab-...失败
json
{
"success": false,
"code": 401,
"msg": "Invalid sign",
"trace_id": "...",
"data": null
}常见错误码
| 错误码 | 说明 |
|---|---|
| 400 | 请求参数错误 / 缺少签名 header / 请求体非 JSON |
| 401 | 签名校验失败或时间戳过期(超出 5 分钟窗口) |
| 403 | 项目未配置 App Secret |
| 404 | App Key 不存在 |
| 413 | Body / 远程文件过大 |
| 422 | 业务校验失败(如语言不在项目配置) |
| 500 | 服务器内部错误 |
| 502 | 下游(工作流 / 存储)触发失败 |