Skip to content

API 密钥

API 密钥用于服务端 SDK 和 HTTP API 的每一次请求鉴权。 密钥按项目隔离——丢失或轮换一个密钥只影响所在项目,不会波及其他项目。

Settings → SDK&Key 页面,包含 SDK setup 卡片网格和 API keys 列表

在哪里管理

左侧栏点 Settings → SDK&Key,页面分为两个区块:

  • SDK setup —— 一个卡片网格,展示当前项目可用的 SDK。gohttp 已可用; AndroidiOSJavaScriptC++ 标记为 Coming soon。卡片只是状态展示, 点击不会跳转。
  • API keys —— 当前项目所有可用于鉴权的密钥列表。

新建项目时,平台会自动签发一个默认密钥,名字形如 {projectId}_default_{后缀}—— 例如项目 6666 下的 6666_default_193444。默认密钥从创建起就是 Active 状态, 且不允许停用——对应行的 Deactivate 按钮是灰色不可点击的。

API keys 列表里每一行的字段:

字段说明
Name人类可读的名字。命名规则见下方"创建密钥"。
StatusActive 可以服务流量;Deactivated 会立刻被拒绝。
Token实际下发给 SDK / HTTP 客户端的密文,默认打码。
Description可选的文字备注,用来标记这个密钥的用途。
Created by创建该密钥的成员及创建时间。

创建密钥

New API Key 弹窗,包含 Name 和 Description 字段

  1. 进入 Settings → SDK&Key
  2. 在 API keys 表格右上角点 + New API Key
  3. 填写弹窗:
    • Name——必填。平台限制名字只能由字母、数字、下划线_)组成; 连字符、点、空格都不被接受。建议带消费者标识,例如 ios_prodserver_prodhttp_batch
    • Description——可选。一句话备注这个密钥给谁用。
  4. Create。新密钥会出现在列表里,状态 Active,可以立即开始使用。

不要把 token 写进源代码仓库。把它和你已有的密钥管理(Vault、AWS Secrets Manager、 腾讯云 SSM 等)打通,并按周期轮换。

停用或轮换密钥

点击 Deactivate 后,该密钥立即失效——任何还在使用旧 token 的请求都会被拒绝。 请先把新密钥铺开,再停用旧密钥:

  1. Settings → SDK&Key+ New API Key,创建替换用的新密钥。
  2. 把新 token 通过密钥管理系统、环境变量或部署配置下发给全量节点,与旧密钥并行 运行,等流量稳定。
  3. 回到 Settings → SDK&Key,在旧密钥那一行点 Deactivate
  4. 在服务日志里确认旧 token 的请求已经降到 0,再把旧 token 归档保存。

默认密钥(即 {projectId}_default_{后缀} 那一行)不允许停用。如果怀疑它已经泄露, 请按已泄露处理:先创建新密钥承接生产流量,再联系平台支持轮换默认 token。

给不同接入方分配密钥

按"环境 × 消费者"分配密钥是最稳的做法——这样停用任何一把都不会牵连到其他链路。 典型布局:

  • server_prod —— 生产环境的 Go 服务。
  • server_staging —— 预发环境的同一批服务。
  • http_batch —— 临时 HTTP 客户端(CI 任务、脚本、BI 工具)。

未来 AndroidiOSJavaScript 客户端 SDK 上线后, 出现在浏览器和移动端的密钥要按"公开密钥"来管理:不要把它们和服务端密钥混用, 每个平台分别开一把专用密钥。C++ 服务端 SDK 同样标记为 Coming soon,在它上线之前, C++ 运行时可以用一把服务端作用域的 key 通过 HTTP API 接入平台。