api.md 1.1 KB

API 使用标准 HTTP 响应码(Status Code)来表示 API 请求。

通常,状态码:

2xx 代表成功响应

4xx 代表失败响应,并给出失败原因

5xx 代表服务端内部错误

状态码说明

状态码 描述
200 更新/获取资源成功
400 业务错误,具体参见下放业务错误代码
401 认证失败,请返回 认证 检查参数是否有误
403 无权限调用接口,如:未开通 API 功能
404 资源不存在
405 接口请求方式 Method 有误
409 请求冲突,request_id 相同时触发
429 触达限流限制
500 服务器应用发生了错误

业务错误说明

状态码 4xx 的业务错误可通过编码来分别处理不同的处理逻辑,响应将通过 JSON 形式返回,其中包括业务错误码 code 和错误原因 message,例如:

{
    "errors": [{
      "code": "not_found",
      "message": "资源未找到"
    }]
}