主题
鉴权
所有 /api/* 请求都必须携带 API Key。支持三种传入方式,任选其一:
| 方式 | 示例 | 建议 |
|---|---|---|
请求头 X-API-Key | X-API-Key: km_xxx | ✅ 推荐,最不易泄漏 |
请求头 Authorization: Bearer | Authorization: Bearer km_xxx | ✅ 常规 OAuth 式风格 |
URL 参数 ?key= | ?key=km_xxx | ⚠️ 兼容 Keepa 调用方式 |
冲突策略:若同时在多个位置传入不同的 Key,服务端返回 400,不会做隐式优先覆盖。多个位置传入相同的 Key 被允许。
获取 API Key
详见 API Key 管理。简单流程:
- 登录 Keepamore
- 打开api页面: /keepamore-api
- 购买任意套餐后 Key 自动创建,可随时在管理页查看和复制
- 丢失或疑似泄漏可随时「重置」
格式
API Key 以 km_ 开头,加 32 位字母数字,总长 35。未传入 API Key 或者 API Key 错误,会返回401错误代码。
cURL 示例
方式 A:X-API-Key(推荐)
bash
curl "https://mcp.keepamore.com/api/quota" \
-H "X-API-Key: km_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"方式 B:Authorization: Bearer
bash
curl "https://mcp.keepamore.com/api/quota" \
-H "Authorization: Bearer km_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"方式 C:URL 参数
bash
curl "https://mcp.keepamore.com/api/quota?key=km_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"鉴权失败的常见返回
| HTTP | code | 含义 |
|---|---|---|
| 401 | 4001 | 未携带、格式非法、或多个位置值冲突 |
| 403 | 4003 | Key 已吊销、用户被停用、或账号不可用 |
| 429 | QUOTA_NO_SUBSCRIPTION | Key 合法但账号未购买任何套餐 |
完整错误码见 错误码。
最佳实践
- 请勿在浏览器端暴露 Key:请使用后端服务调用
- 不要 commit 到代码仓库:用环境变量或密钥管理服务
轮换
重置 Key 会立刻生成新 Key;旧 Key 将在30分钟内失效。请尽快完成切换。