入门
身份验证
如何发送 API 密钥并确保其安全。
每个请求都必须携带你的 API 密钥。请以 Bearer token 的形式放在 Authorization 请求头中发送;如果你的客户端无法设置 Authorization,也可以放在 X-Api-Key 请求头中。
请求头#
Authorization: Bearer xca_live_…
# or
X-Api-Key: xca_live_…curl -s "https://app.xca.fun/api/v1/new-pairs?limit=5" \
-H "X-Api-Key: $XCA_API_KEY"密钥格式#
密钥以 xca_live_ 开头,后接一串随机的 base58 字符串。XCA 只保存密钥的哈希值,因此丢失的密钥无法找回:请创建一个新密钥。
妥善保管密钥#
- 请在你的服务器或机器人中调用 API,切勿在公开网页或移动应用的安装包中调用。
- 不要把密钥提交到代码仓库;请从环境变量或密钥管理服务中加载。
- 每个项目使用单独的密钥,这样吊销其中一个时不会影响其他密钥。
- 被吊销的密钥会立即失效。
轮换密钥#
先创建新密钥并完成部署,确认请求成功后,再在 API 页面吊销旧密钥。
身份验证错误#
缺少密钥、密钥格式错误或已被吊销时,返回 401 unauthorized。密钥有效但所属套餐不含 API 访问权限时,返回 402 planRequired。
401
{
"error": {
"code": "unauthorized",
"message": "Invalid API key"
}
}