¶ GenAuth 错误码

GenAuth V3 API 和 SDK 如果没有特殊说明，所有接口返回的 HTTP 状态码均为 200。一个 HTTP 状态码为 200 的响应，不能视为操作成功，你需要通过响应体的具体内容进行判断。

GenAuth V3 API 和 SDK 的返回数据中，包含了两个状态码：statusCode 和 apiCode：

• statusCode: statusCode 为请求状态码，不包含具体的业务错误信息。
  • 当且仅当 statusCode 为 200 时，表示接口请求成功，此时不会带有 apiCode。
  • statusCode 不为 200 的情况下，表示接口请求失败或者需要进行额外操作（比如登录接口需要进行 MFA 二次验证），你需要对此进行关注，进行必要的错误处理。每个 statusCode 对应一个类型的错误， 具体的错误分类请见下文。在大多数情况下，除非你需要对某些特定的异常做出响应，否则你只需要关注 statusCode，不需要关注 apiCode。
• apiCode: apiCode 为业务状态码，每个 apiCode 具备特定的错误含义，具体的 apiCode 列表见下文。apiCode 只会在 statusCode 非 200 且错误原因具备业务含义时才会返回。

¶ statusCode

¶ apiCode

¶ 响应数据示例

一个成功的请求响应数据示例如下：

{
  // 此响应表示请求成功，所以不会返回 apiCode
  "statusCode": 200,
  "message": "",
  "data": {
    // ... 省略具体数据
  }
}

一个失败的请求响应数据示例如下：

{
  // 此类型错误不具备具体的业务含义，所以不会返回 apiCode
  "statusCode": 429,
  "message": "您的请求已超过最大数量限制，请稍后重试"
}

以及：

{
  // 账号不存在或密码错误具备业务含义，所以返回了对应的 apiCode: 2333
  "statusCode": 403,
  "apiCode": 2333,
  "message": "Account not exists or password is incorrect.",
  "requestId": "xxxxxx-xxxxxx-xxxxxx-xxxxxx"
}

¶ 我该如何处理 statusCode 和 apiCode

在大多数情况下，除非你需要对某些特定的异常做出响应，否则你只需要关注 statusCode，不需要关注 apiCode。 比如登录接口，如果你只需要在用户登录失败的时候给出错误提示，可以不用关心 apiCode；但是如果你需要对某一种 特定的业务错误进行额外处理，就需要根据 apiCode 进行判断。

¶ 获取帮助

有任何建议或者问题反馈，欢迎在 GenAuth 论坛 (opens new window)中提出。