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

# 认证 - API 密钥、轮换与撤销

> 如何获取 Apexium API 密钥、通过 x-api-key 头发送密钥、无停机轮换密钥以及撤销密钥。

每个请求都在 `x-api-key` 头中携带一个 API 密钥。该密钥标识您的账户：API 返回的每个订单、注单和数字都属于该账户。

唯一的例外是 [`GET /v1/health`](https://docs.apexiumbet.com/zh/api-reference/overview#健康状态)，它无需密钥。发送给它的密钥会被忽略。

```bash theme={null}
curl https://api.apexiumbet.com/v1/me \
  -H "x-api-key: apx_live_…"
```

## 获取密钥

1. **权限。** 您的代理在您的账户上启用 API 访问权限。在此之前，您无法创建密钥。
2. **密钥。** 在仪表板中打开 **Preferences → API** 并创建密钥。
3. **保存。** 密钥只会完整显示一次。Apexium 只存储其哈希值，无法再次显示：请将其保存在密钥管理器中。此后仪表板只显示其前缀和最后四个字符。

密钥形如 `apx_live_…`。集成期间可按需提供测试环境，它有自己的基础 URL 和密钥。密钥只能在签发它的环境中使用。

## 有效密钥

您同一时间最多可以有 **两个有效密钥**。这足以实现无停机轮换。要创建第三个，请先撤销其中一个。

## 轮换密钥

在同一位置轮换密钥。轮换会签发一个新密钥，并为旧密钥设定截止时间。由您选择旧密钥何时停止生效：

| 选项 | 旧密钥失效时间 |
| - | - |
| Now | 立即失效 |
| In 1 hour | 一小时后 |
| In 24 hours | 一天后 |
| In 7 days | 一周后 |

请在两个密钥都有效期间部署新密钥，然后让旧密钥到期。轮换需要一个空闲名额：已有两个有效密钥时，请先撤销其中一个，再轮换另一个。

## 撤销密钥

撤销会使密钥立即失效。一旦怀疑密钥泄露，请立即撤销。如果您的代理撤回账户的 API 访问权限，该账户的所有密钥会同时失效。

## 认证失败

没有密钥的请求，或使用未知、已撤销或已过期密钥的请求，会返回 `401 INVALID_API_KEY`。当账户不再具有 API 访问权限或已被暂停时，即使密钥有效，也会返回 `403 API_ACCESS_DENIED`。

来自同一地址的重复失败会被限流：在一分钟内出现 20 次失败请求后，来自该地址的每个请求都会返回 `429 RATE_LIMITED`，直至该分钟结束，无论其携带哪个密钥。参见[限额](https://docs.apexiumbet.com/zh/api-reference/limits.md)。

## 请求标识符

每个响应都带有 `x-request-id` 头。就某个请求联系支持团队时，请附上它。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.