GetRouter文档
  • 简体中文

    • API Key 管理

    API Key 是调用 GetRouter 和连接第三方工具的凭据。请为不同应用、环境和人员分别创建 Key，不要共享一把长期无限制的 Key。

    可配置项目

    当前 API Key 页面支持以下配置：

    配置用途建议
    名称标识应用或用途使用 项目-环境-用途 命名
    分组选择可用服务分组不确定时使用默认分组
    跨组重试当前分组失败后尝试后续分组需要容错时开启，并监控费用与延迟
    有效期到期后停止使用临时测试和外部工具建议设置
    剩余额度限制该 Key 可消耗额度为 Agent 和自动任务设置上限
    无限额度不限制该 Key 的额度仅用于受控服务端场景
    模型限制只允许指定模型生产环境建议开启
    IP 白名单只允许指定 IP / CIDR适合固定出口服务；不要把它当作唯一安全措施
    Note

    API Key 表单当前不提供单 Key RPM/TPM 数字输入。并发和速率限制仍可能由账户、分组、模型或上游策略决定。

    推荐的 Key 划分

    backend-production
backend-staging
codex-personal
claude-code-personal
chat-client-laptop
ci-readonly-test

    这样可以单独查看用量、设置额度，并在某个工具泄露时只撤销对应 Key。

    创建流程

    1. 打开 API Keys。
    2. 点击创建，填写清晰名称。
    3. 设置有效期和额度。
    4. 如已确定模型，开启模型限制。
    5. 固定出口服务可配置 IP 白名单。
    6. 保存后立即放入密码管理器或安全的环境变量系统。

    轮换与撤销

    1. 先创建新 Key。
    2. 更新应用或工具配置并重启。
    3. 发送最小测试请求。
    4. 在使用记录确认新 Key 已生效。
    5. 禁用旧 Key，观察无异常后再删除。

    安全底线

    • 不提交到 Git、镜像、前端 bundle、笔记或截图。
    • 不在浏览器端 JavaScript 直接调用需要保密 Key 的接口。
    • 不在支持工单中发送完整 Key；用名称、末尾几位和 Request ID 定位。
    • 第三方工具优先使用系统密钥链、环境变量或工具自己的安全存储。
    • 发现泄露时立即禁用并轮换，不要只修改名称。