文档 / API 错误

API 错误处理

适用于 iGaming 集成的统一响应、错误码、临时故障、未知结果、诊断及安全恢复模型。

查看测试
HTTP
请求结果
错误码
明确原因
重试
安全操作
追踪
请求诊断
错误处理流程

从 API 响应到恢复

01
确定结果类型

检查 HTTP 状态、原因码、错误类别及操作状态。

02
保存排查数据

记录请求和操作标识符、端点、时间、提供商引用及安全参数。

03
选择安全操作

修正数据、停止操作、延迟后重试或检查当前状态。

04
恢复并验证

防止重复、执行对账、通知责任团队并解决根本原因。

概览

错误应说明原因及下一步操作

仅返回 HTTP 400 或 500 并不足够。可靠的 API 会返回稳定的原因码,将响应与请求标识符关联,并明确应修正数据、停止操作、重试请求还是单独查询状态。

稳定的原因码

稳定的错误码可用于客户端逻辑、报表及咨询自动分流。

可预测的操作

错误类别应说明请求是否可以重试以及哪些数据需要修改。

诊断关联

请求、操作及提供商标识符可将客户端日志与内部系统和支持团队关联起来。

错误结构

推荐的错误响应结构

响应应简洁、稳定并适合自动处理,同时不泄露内部实现或敏感数据。

错误码

稳定的原因标识符,不会因说明文字调整而变化。

说明

简短且安全的说明,不包含内部代码、数据库查询、机密信息或多余细节。

请求 ID

用于在日志中定位操作并联系支持的唯一标识符。

附加数据

允许的状态、限额、当前状态或安全的拒绝原因。

可重试

明确标示临时错误,同时不取消操作的防重复保护。

重试前延迟

建议的等待秒数或用于请求频率限制和临时不可用场景的 HTTP 头。

字段错误

问题字段列表,包括原因码、值路径及安全说明。

文档引用

说明错误原因及修复方式的固定链接或章节标识符。

错误类别

主要错误类别

HTTP 状态表示总体结果类别,内部错误码则说明具体原因和允许的操作。

输入验证错误

格式无效、缺少必填字段、不支持的值、金额精度错误或请求结构无效。

身份验证错误

缺少、过期或无效的令牌、API 密钥、签名、请求时间戳或 nonce。

权限不足

客户端已识别,但缺少执行该操作所需的角色、品牌、市场或权限。

对象未找到

玩家、支付、回合、KYC 检查、提供商或其他对象不存在,或当前客户端无权访问。

状态冲突

对象版本或状态已变更,或者操作标识符已使用但参数不同。

违反业务规则

余额不足、超出限额、玩家被阻止、市场被禁止或状态转换无效。

请求过多

客户端、方法、角色或关键操作允许的请求数量已超限。

提供商不可用

外部服务不可用、响应缓慢或暂时不接受操作。

内部错误

平台发生意外错误,不泄露内部细节,但会提供诊断标识符。

重试与恢复

请求重试与未知结果

只有在确定错误类型并确认原操作是否可能已经完成后,重试才是安全的。

01

检查是否允许重试

数据、权限及业务规则错误通常需要修正请求,而不是原样重新发送。

02

保持相同的操作键

重试金融、游戏或其他关键操作时不得产生新的结果。

03

增加重试间隔

重试间隔逐步增加,遵守服务器提供的等待时间,并限制总尝试次数。

04

停止并升级人工审核

所有重试用尽后,将操作记录为未完成,并提交人工审核或对账。

没有响应并不代表操作失败

如果请求发送后连接中断,结果可能处于未知状态。重试前应使用操作标识符查询状态,或等待可信通知。

诊断与控制

日志、标识符、指标与告警

诊断应能够还原平台、适配器和外部提供商之间的请求路径,同时避免存储不必要的敏感数据。

排查上下文

请求、关联、操作及外部提供商标识符。
端点、HTTP 方法、环境、客户端、时间及响应耗时。
HTTP 状态、错误码、尝试次数及最终状态。
已遮蔽的敏感字段、安全头信息及签名验证结果。

监控与告警

按方法、提供商、客户端及原因类别统计错误率。
慢响应、HTTP 5xx 错误、无效签名及频率限制事件增加情况。
重试次数、未知结果操作数量及恢复任务数量。
包含阈值、负责人及升级规则的告警。
测试

测试环境中需要测试的内容

测试环境应覆盖每个重要错误类别,并验证客户端、重试和控制逻辑是否正确。

输入验证错误

缺少字段、类型无效、不支持的值、金额精度问题以及多个错误同时出现。

访问与权限

无效密钥、过期令牌、签名错误、未授权角色、被阻止的 IP 以及重复使用的 nonce。

无响应与未知结果

请求发送前、操作已被接受后,以及接收最终响应过程中发生连接故障。

请求频率限制

HTTP 429、建议等待时间、并发请求以及限制解除后的恢复。

提供商错误

服务不可用、维护、响应无效、通知延迟及状态冲突。

重试与保护性停止

限制尝试次数、逐步增加延迟、暂时停止请求、受控恢复及人工升级。

上线前检查清单

生产集成应在验证错误结构、客户端行为、防重复机制及诊断能力后上线。

所有错误均返回稳定的原因码和请求标识符。
错误详情不会泄露机密信息或内部实现。
临时和永久错误类别均已记录在文档中。
关键操作重试时使用相同的幂等键。
未知结果通过状态查询或可信通知进行处理。
已配置日志、指标、告警、恢复队列及升级规则。

需要统一 API 错误格式?

请提供当前 HTTP 响应、错误码、重试规则及问题场景。APIACE 将帮助定义统一错误模型、安全恢复和控制方案。