x-api-key 头进行身份验证,但无需身份验证的基础设施端点(/health、/ready、/status、/metrics)除外。
如何验证
在x-api-key 请求头中传入您的API密钥:
API密钥元数据
每个API密钥解析为一个客户及其访问规则:| 字段 | 描述 |
|---|---|
clientName | 您的客户标识符 — 所有账户、订单和投注均按此过滤 |
bookmakers | 允许的博彩公司标识(空=全部博彩公司) |
rps | 此客户允许的每秒请求数(默认:100) |
active | 此密钥是否激活 |
clientName 过滤。
WebSocket 身份验证
对于WebSocket连接,在连接后通过登录消息进行身份验证(/ws 端点本身不需要 x-api-key 头):
速率限制
请求按客户端限流——默认每秒 100 个请求,每个 API 密钥最多 5 个并发 WebSocket 连接。完整细节、响应头与退避指引见速率限制。错误响应
身份验证中间件在
error 键下返回错误,而应用层错误(验证、未找到等)使用 FastAPI 标准的 detail 键。请同时处理这两种格式。| 情况 | 状态码 | 正文 |
|---|---|---|
| 缺少头 | 403 | {"detail": "Missing API key header: x-api-key"} |
| 密钥无效 / 停用 / 过期 | 401 | {"error": "Invalid or inactive API key"} |
| 密钥有效但不允许访问该端点 / 运动项目 / 博彩公司 | 403 | {"error": "Access denied to endpoint"} |
| 超出速率限制 | 429 | {"detail": "Rate limit exceeded", "limit": "100", "retry_after": 1} |
后续步骤
快速开始
5 步完成首次下注。
额度与可靠性
按客户端的限制、熔断器与紧急模式。