创建 API Key

在 Sublyx 控制台创建、保存、轮换和停用 API Key。

API Key 是访问 Sublyx API 的凭证。建议为每个环境、应用或团队成员创建独立 Key,以便隔离权限和追踪用量。

创建步骤

进入 API Key 管理

登录 Sublyx 控制台,在侧边栏进入 API Key 管理页面。

创建并命名

使用能说明用途的名称,例如 production-api、staging-worker 或 alice-local。

复制并安全保存

完整 Key 只应保存在密码管理器、CI Secret 或云端密钥管理服务中。

sk-sublyx-example

推荐的隔离策略

场景建议
本地开发每位开发者使用自己的 Key
测试环境为 CI 与测试服务单独创建 Key
生产环境按服务拆分 Key,并定期轮换
临时脚本使用短期专用 Key,用完后停用

环境变量

.env.local
SUBLYX_API_KEY=sk-sublyx-example
src/config.ts
const apiKey = process.env.SUBLYX_API_KEY;

if (!apiKey) {
  throw new Error('缺少 SUBLYX_API_KEY');
}

客户端代码中不要保存 Key

浏览器、移动端安装包和公开仓库都无法安全保存长期 API Key。应由你的服务端代理请求,并在服务端执行权限、配额和审计控制。

轮换与停用

  1. 创建新 Key,并部署到所有依赖服务。
  2. 验证新 Key 的请求与用量记录正常。
  3. 停用旧 Key,观察是否仍有失败请求。
  4. 确认迁移完成后删除旧 Key。

如果 Key 可能泄露,应立即停用,不要等待常规轮换窗口。

本页目录