跳到主要内容

客户端错误 (4XX)

如果 API 请求格式错误，我们的 API 将返回 HTTP 状态码在 400 到 499 范围内的错误。

根据客户端错误的类型，响应将是以下之一。

  • 400 错误请求 - 当请求通过了身份验证和授权检查，但请求没有包含预期的数据时返回。在大多数情况下，这是由于缺少请求属性或属性值不正确。
  • 401 未授权 - 当令牌无效且无法用于授权 API 调用时返回。在这种情况下，请检查 List 4XX errors API 以检查问题的原因。
  • 403 禁止访问 - 当令牌有效但认证客户端无权访问或操作资源时返回。这可能是由于 JWT 中的范围不足、用于签署 JWT 的 API 密钥受限，或资源被锁定。
  • 404 未找到 - 无法找到资源。在少数情况下，资源可能确实存在，但由于权限问题，经过身份验证的客户端无法访问，返回 403 会提供不应该向调用者提供的信息。
  • 405 方法不允许 - 使用的 HTTP 方法不被请求路径识别。
  • 409 重复记录 - 已存在与此资源的唯一约束之一匹配的记录。请查看所调用的 API 文档以检查哪些字段具有唯一约束。
{
  "type": "error", 
  "code": "bad_request",
  "status": 400,
  "message": "Request failed validation",
  "details": [
    {
      "type": "type_error.uuid",
      "pointer": "/payment_method/buyer_id",
      "message": "value is not a valid uuid",
      "location": "body"
    }
  ]
}

字段​

type​

字符串，必需

返回的对象类型。这始终是 error。

code​

字符串，必需

此错误的机器可读代码。这是以下值之一。

  • bad_request
  • unauthorized
  • forbidden
  • not_found
  • method_not_allowed
  • duplicate_record

status​

数字，必需

错误的 HTTP 状态码。

message​

字符串，必需

此错误的人类可读描述。

details​

数组

请求验证错误的列表。

details 字段​

  • type（字符串，必需）：发生的错误类型。
  • pointer（字符串，必需）：指向未通过验证的属性的 JSON 路径指针。
  • message（字符串，必需）：验证错误的人类可读描述。
  • location（字符串，必需）：未通过验证的属性的位置，例如 body、query 或 path。
Powered by Docusaurus