从这里开始
身份验证
每次调用都在请求正文中携带你的 API 密钥。密钥用于识别账户、应用该账户的速率限制,并将每个操作限制在该账户的数据范围内。
在哪里放置 key
将 key 作为表单编码请求体中的 key 字段传入。不支持基于请求头的身份验证——v2 规范使用请求体参数,以兼容现有的分销商 SDK。
Content-Type: application/x-www-form-urlencoded
key=YOUR_API_KEY&action=services如何发送请求
发送 POST,可以使用表单字段(application/x-www-form-urlencoded),也可以使用字段名相同的扁平 JSON 对象。正文最大为 32 KB。未知参数会被忽略,空值视为未提供。任何其他方法都会被 METHOD_NOT_ALLOWED 拒绝。
每次请求都会检查什么
密钥、账户和 API 开关会在每次调用时重新检查,因此被暂停的账户或被撤销的密钥会立即失效。账户必须处于启用状态,且电子邮箱已验证。
- 401
INVALID_KEY
Invalid API key密钥缺失、错误或已被撤销。 请先修正请求。
- 403
INACTIVE_ACCOUNT
Account suspended账户已被暂停。 请先修正请求。
- 403
EMAIL_UNVERIFIED
Email verification required账户的电子邮箱尚未验证。 请先修正请求。
- 503
API_DISABLED
The API is temporarily disabledAPI 暂时关闭。Retry-After 会说明何时重试。 重试可能有帮助。
- 405
METHOD_NOT_ALLOWED
Use POST请求不是 POST。 请先修正请求。
- 413
BODY_TOO_LARGE
Request body too large请求正文过大。 请先修正请求。
key=YOUR_API_KEY&action=balance{
"error": "Invalid API key",
"error_code": "INVALID_KEY",
"retryable": false
}创建和替换密钥
可在 /dashboard/api 中生成和吊销 key。原始 key 只显示一次。服务器仅保留单向验证值和简短的非敏感标识,因此之后无法恢复原始值。
每个账户最多 5 个有效 key
。旧 key 可单独吊销。无停机替换。
先创建替换 key、更新集成,再吊销旧 key。被吊销的 key 会在新请求中被拒绝。需要有效的仪表盘会话。
生成 key 需要已认证且非模拟登录的仪表盘会话,不会再要求邮箱验证码或密码。
API 密钥不能做什么
v3 API 密钥仅限执行文档列出的操作,不能访问已登录的控制面板会话或其他账户的数据。
- 提现或转移余额。
- 更改账户邮箱、密码或 2FA 设置。
- 通过 API 生成或吊销其他 API key。
- 访问管理员或审核端点。
妥善保管密钥
- 仅限服务器端使用。切勿将 API key 嵌入浏览器打包文件、移动应用,或任何他方可反编译的客户端中。
- 使用环境变量。不要将 key 提交到 git。
.env文件应放入.gitignore。 - 怀疑泄露时立即吊销。如果 key 出现在日志、截图或共享聊天中,请创建替换 key 并吊销已暴露的 key。
- 在合适时用 webhook 减少轮询。投递为带重试的尽力而为模式,因此处理程序应保持幂等,并使用
action=status核对重要状态。