> ## Documentation Index
> Fetch the complete documentation index at: https://docs.55-tech.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ABP 身份验证 - API密钥设置

> 了解如何使用 x-api-key 头进行 ABP API 请求身份验证。API密钥解析、速率限制和WebSocket身份验证。

所有 ABP 端点都需要通过 `x-api-key` 头进行身份验证，但无需身份验证的基础设施端点（`/health`、`/ready`、`/status`、`/metrics`）除外。

## 如何验证

在 `x-api-key` 请求头中传入您的API密钥：

```bash theme={null}
curl -H "x-api-key: your-api-key" \
  https://v2.55-tech.com/accounts
```

## API密钥元数据

每个API密钥解析为一个客户及其访问规则：

| 字段           | 描述                        |
| ------------ | ------------------------- |
| `clientName` | 您的客户标识符 — 所有账户、订单和投注均按此过滤 |
| `bookmakers` | 允许的博彩公司标识（空=全部博彩公司）       |
| `rps`        | 此客户允许的每秒请求数（默认：100）       |
| `active`     | 此密钥是否激活                   |

您的API密钥决定您可以访问哪些账户、订单和投注。所有数据按您的 `clientName` 过滤。

## WebSocket 身份验证

对于WebSocket连接，在连接后通过登录消息进行身份验证（`/ws` 端点本身不需要 `x-api-key` 头）：

```json theme={null}
{
  "type": "login",
  "apiKey": "your-api-key",
  "channels": []
}
```

您必须在连接后 **30秒** 内发送登录消息，否则连接将被关闭。详见 [WebSocket](/zh/abp-api/websocket)。

## 速率限制

请求**按客户端**限流——默认每秒 100 个请求，每个 API 密钥最多 5 个并发 WebSocket 连接。完整细节、响应头与退避指引见[速率限制](/zh/abp-api/reliability#速率限制)。

## 错误响应

<Note>
  身份验证中间件在 `error` 键下返回错误，而应用层错误（验证、未找到等）使用 FastAPI 标准的 `detail` 键。请同时处理这两种格式。
</Note>

| 情况                          | 状态码   | 正文                                                                    |
| --------------------------- | ----- | --------------------------------------------------------------------- |
| 缺少头                         | `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}` |

## 后续步骤

<Columns cols={2}>
  <Card title="快速开始" icon="rocket" href="/zh/abp-api/quickstart">
    5 步完成首次下注。
  </Card>

  <Card title="额度与可靠性" icon="gauge-high" href="/zh/abp-api/reliability">
    按客户端的限制、熔断器与紧急模式。
  </Card>
</Columns>