Skip to main content

API Key

API Key 概述​

API Key 是调用 SCP 工具服务时使用的鉴权凭证，位于【系统设置 - API Key】页签下。用户可以在【密钥管理】中创建和管理 API Key。

API Key 属于敏感信息。请妥善保管并定期更换，不要将其直接写入公开代码仓库、文档或日志，也不要提供给无关人员。

密钥管理​

进入【系统设置】，点击【API Key】，然后选择【密钥管理】。

API Key 密钥管理页面

页面会显示 API Key 的安全提示、限流策略和【创建 API Key】入口。当前限流策略如下：

· 默认有效期：6 个月。

· RPM：默认每分钟发送的请求数限制最大为 500。

RPM 表示每分钟允许发送的请求数。实际调用时，请根据页面显示的限流策略合理控制请求频率。

创建 API Key​

  1. 在【密钥管理】中点击【创建 API Key】。

  2. 在弹窗中输入名称。名称支持中文、英文、数字以及 . - _，最多 30 个字符。

  3. 点击【确认】，完成创建。

创建 API Key

建议使用能够体现用途或使用环境的名称，例如 scp-test 或 project_a，便于后续区分不同的 API Key。

创建完成后，请按照页面提示及时保存 API Key。不要通过聊天、邮件或公开文档传递密钥，也不要在截图中展示完整密钥。

查看与管理 API Key​

创建完成后，可返回【密钥管理】查看账号下的 API Key。需要更换凭证时，请创建新的 API Key，并在调用端完成替换后停止使用旧凭证。

API Key 默认有效期为 6 个月。建议定期检查正在使用的凭证，并在到期前完成更新，避免调用因凭证失效而中断。具体可用操作以页面实际显示为准。

安全使用说明​

· 不要将 API Key 硬编码到需要公开或共享的源代码中。

· 不要将 API Key 上传到公共代码仓库，或记录在可被他人访问的日志中。

· 建议通过环境变量或受控的密钥管理方式保存 API Key。

· 如果怀疑 API Key 已泄露，请尽快停止使用该凭证，并创建新的 API Key 完成替换。

常见问题​

  1. 为什么无法创建 API Key？

    请确认名称已填写，并且不超过 30 个字符。名称仅支持中文、英文、数字以及 . - _。如果仍无法创建，请根据页面提示检查填写内容后重试。

  2. API Key 的默认有效期是多久？

    默认有效期为 6 个月。请定期检查并更换正在使用的 API Key，避免凭证到期影响调用。

  3. 每分钟最多可以发送多少个请求？

    RPM 默认最大为 500，即默认每分钟最多发送 500 个请求。实际限制以页面显示为准。

  4. API Key 泄露后怎么办？

    请尽快停止使用泄露的凭证，创建新的 API Key，并更新调用端配置。完成替换后，请确认旧凭证不再被代码、脚本或服务使用。

上一页
下一页