API Error Codes Reference
本文档全面列出了 PlayerAuctions 卖家(Seller)API 返回的所有错误代码,并包含了这些代码的含义及常见原因。
i. 错误代码概述
错误代码通过 API 响应中的 code 字段返回。错误代码的格式为 5 位数字,其中首位数字代表错误的类别:
- 1xxxx - 成功与参数错误
- 2xxxx - 签名与身份验证错误
- 3xxxx - 授权错误
- 4xxxx - 业务逻辑错误
- 5xxxx - 内部服务器错误
ii. 完整错误代码列表
| 错误代码 | 名称 | 类别 | 描述 |
|---|
| 10000 | Success | Success (成功) | 操作已成功完成。 |
| 10001 | MissingHeader | Parameter (参数) | 请求中缺少必需的 HTTP 请求头。 |
| 10002 | InvalidParameter | Parameter (参数) | 一个或多个请求参数无效或格式不正确。 |
| 20001 | InvalidSignature | Signature (签名) | 请求签名验证失败。 |
| 30001 | AuthenticationError | Authentication (身份验证) | 身份验证失败。凭证无效或缺失。 |
| 30002 | AuthrizationError | Authorization (授权) | 授权失败。用户没有执行此操作的权限。 |
| 40001 | BusinessError | Business (业务) | 业务规则验证失败。 |
| 50001 | InternalServerError | Server Error (服务器错误) | 服务器发生意外错误。 |
iii. 错误返回格式
报错示例
{
"code": 10002,
"message": "Invalid parameter",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
错误响应参数
| 参数 | 类型 | 描述 |
|---|
| code | int | 报错代码,表示发生的错误类型。 |
| message | string | 报错详情。 |
| requestId | string | 请求标识号,用以追溯。 |
iv. 详细错误代码描述
1xxxx - 成功与参数错误
| 错误代码 | 描述 | 常见原因 | 解决方案 |
|---|
| 10000 | 成功 | 不适用 (N/A) | 操作已成功完成。无需执行任何操作。 |
| 10001 | 缺少请求头 | 缺少必需的 HTTP 请求头(例如:Authorization、X-Timestamp、X-Signature)。 | 确保请求中包含了所有必需的请求头。 |
| 10002 | 无效参数 | 参数缺失、类型错误或包含无效值。 | 请对照 API 文档检查请求参数,并修正相关问题。 |
2xxxx - 签名错误
| 错误代码 | 描述 | 常见原因 | 解决方案 |
|---|
| 20001 | 无效签名 | 由于密钥错误、时间戳不匹配或签名格式不正确,导致请求签名与预期值不匹配。 | 请核对您的 API 密钥(Secret Key),确保系统时间已同步,并检查签名生成算法是否正确。 |
3xxxx - 身份验证与授权错误
| 错误代码 | 描述 | 常见原因 | 解决方案 |
|---|
| 30001 | 身份验证错误 | API 密钥无效、凭证已过期,或身份验证方式不正确。 | 请核实您的 API 凭证是否有效且未过期,并检查身份验证方式是否正确。 |
| 30002 | 授权错误 | 用户没有访问所请求资源或执行该操作的权限。 | 请确保您的账号拥有必要的权限。如有需要,请联系技术支持。 |
4xxxx - 业务逻辑错误
| 错误代码 | 描述 | 常见原因 | 解决方案 |
|---|
| 40001 | 业务错误 | 请求违反了业务规则(例如:余额不足、报价状态无效、重复操作)。 | 请仔细查看错误信息(message)中关于具体违规业务规则的详细说明,并据此调整您的请求。 |
5xxxx - 服务器错误
| 错误代码 | 描述 | 常见原因 | 解决方案 |
|---|
| 50001 | 内部服务器错误 | 意外的服务器错误、数据库连接问题或服务不可用。 | 请稍作延迟后重试请求。如果错误持续存在,请联系客服并提供requestId。 |
注意事项
- 向客服反馈问题时,请务必提供
requestId,这有助于追踪定位发生失败的具体请求。 - 错误信息中可能包含关于具体问题的更多细节,请务必仔细查看
message 字段。