认证

在请求头里带 API Key

每一个接口都用 API Key 认证。请求头这样写：

Authorization: Bearer ks_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

• Bearer 和 API Key 之间有一个空格。
• 请求体是 JSON，编码 UTF-8。
• 只能用 HTTPS。

API Key 不对、已经停用、已经删除或者过期，接口都回 HTTP 401：

{"code": 401, "msg": "API Key 无效或已停用", "data": null}

为了安全，接口不会告诉你是哪一种情况，请到控制台核对。

管理 API Key

在 控制台 · API Key 可以：

• 创建多个 API Key，比如测试环境、正式环境各用一个；
• 给 API Key 改名，方便区分；
• 删除不再用的 API Key，删除后马上失效。

每一次调用用的是哪个 API Key、扣了多少钱，在控制台的「用量」「账单」里都能查到。

保管好 API Key

• 只放在服务器端（环境变量或配置文件），不要写进浏览器、App 能看到的代码里，也不要提交到代码仓库。
• 怀疑泄露了，马上在控制台删除并换一个新的。