Skip to content

公共参数

请求公共参数(HTTP Header)

所有 API 请求的鉴权信息都通过 HTTP Header 传递,请求体(body)保持为纯业务 JSON

Header类型必填说明
X-Loxily-AppKeystring项目 App Key
X-Loxily-Timestampnumber(字符串形式)Unix 秒(或毫秒),有效窗口 5 分钟
X-Loxily-Signstring请求签名,详见签名算法

响应公共字段

所有接口响应都含以下顶层字段(成功或失败):

字段类型说明
successboolean是否成功
codenumber业务码;0 表示成功,其它为错误码
msgstring人类可读的简短消息
trace_idstring本次请求的链路 ID。用于日志排查;可在开放平台页面「调用日志」中按此 ID 反查完整请求与回调记录
dataobject | 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
404App Key 不存在
413Body / 远程文件过大
422业务校验失败(如语言不在项目配置)
500服务器内部错误
502下游(工作流 / 存储)触发失败