1. 验证
所有对 API 的请求都需要身份验证。您可以通过添加带有 Bearer 令牌类型的授权标头(如下所示)来验证您的请求,并将随机字符串替换为您的沙盒或实时 API 密钥。
Authorization: Bearer 75230addbf8462cd7fd2383e8fc7b895f84a0a7g
Check 支持对生成的 API 密钥配置 IP 限制,以提供额外的安全保障。请联系您的技术客户经理了解更多信息。
2. 错误
Check 使用标准 HTTP 响应代码来指示 API 请求的成功或失败。范围内的代码表示成功,范围内的代码表示客户端错误,范围内的代码表示服务器错误,我们会立即修复。所有 Check 错误均符合以下架构:2xx4xx5xx
3. 幂等请求
Check 支持幂等性,可以安全地重试请求,而不会意外执行两次相同的操作。这对于发出您不希望多次发生的请求非常有用,例如为员工附加工资项目付款。您可以使用相同的幂等性密钥重试请求,以确保不会创建多个实体。
要执行幂等请求,请为请求提供标头。无论成功还是失败,我们都会保存使用给定幂等键发出的第一个请求的响应状态代码和正文。使用相同键的后续请求将返回相同的结果,包括 500 错误。X-Idempotency-Key
幂等性密钥的格式由您决定,但我们建议使用UUID。请注意,密钥在 24 小时后过期,因此如果您在 24 小时后发出相同的请求,该操作将完成。
4. 版本控制
检查 API 已版本化!当对 API 进行向后不兼容的更改时,将发布新的、有日期的版本。请参阅我们的API 变更日志,了解 API 版本及其变更的完整列表。要在特定请求上设置 API 版本,请发送标题。Check-Version
指南详情链接:https://docs.checkhq.com/reference/getting-started-1