Subotiz 的 API 密钥 为商户将自有网站、应用或其他业务系统接入 Subotiz 提供所需的 API 接入信息。商户可在 接入设置 中查看标准密钥和访问号,并在需要更新密钥时执行 密钥轮换,帮助保障 API 集成 和身份验证安全。
查看 API 密钥
- 进入接入设置: 登录 Subotiz 后台,前往 开发者 > 接入设置。

- 打开 API 密钥: 点击 API 密钥页签,查看当前账户的标准密钥和基础信息。

查看标准密钥
标准密钥用于 API 接入,并拥有完整的 API 访问权限。
如当前账户显示标准密钥,可查看以下信息:
- 名称: 标准密钥的名称。
- ID: 标准密钥的唯一标识。
- 令牌: 用于 API 接入的密钥信息。
- 状态: 标准密钥当前的使用状态,例如 激活。
- 有效期: 显示当前密钥的有效期限。
注意: 标准密钥属于敏感凭证,请妥善保管,避免泄露。标准密钥的显示情况以当前账户的 API 密钥页面为准。

查看访问号
访问号 显示在 基础信息 区域,用于系统集成。进行 API 接入时,请根据相关 API 文档使用访问号。

轮换 API 密钥
密钥轮换用于生成新的 API 密钥,并设置当前密钥的失效时间。轮换后新密钥立即生成,商户可设置当前密钥继续保持有效的时间,为业务系统切换至新密钥预留时间。
- 打开密钥操作菜单: 在 标准密钥 区域找到需要轮换的密钥,点击右侧 ··· > 轮换密钥。

- 确认密钥信息: 在 轮换 API 密钥 窗口中确认需要轮换的密钥 ID 和令牌。

- 选择有效期: 点击 有效期,选择当前密钥继续保持有效的时间。支持以下选项:
- 现在
- 1小时内
- 24小时内
- 3天内
- 7天内

- 确认轮换: 点击 轮换 API 密钥 生成新密钥。系统将根据所选有效期处理当前密钥的失效时间。

注意:
生成新密钥: 轮换后将立即生成新密钥。 选择现在: 当前密钥将在 3 分钟后失效。 设置延迟轮换: 新旧密钥在所选有效期内同时有效,旧密钥过期后将无法继续使用。 Webhook 密钥切换: Webhook 端点会优先使用旧密钥,待旧密钥过期后自动切换至新密钥。
安全使用建议
- 按需轮换密钥: 根据企业安全策略或密钥管理要求轮换 API 密钥。
- 预留切换时间: 如业务系统仍在使用当前密钥,可选择适当的延迟轮换时间,并在旧密钥失效前完成新密钥配置。
- 保护令牌: 请勿将密钥令牌公开在网页、前端代码、公共文档、截图或即时通讯工具中。
- 安全存储密钥: 将密钥保存在安全的服务器环境、环境变量或密钥管理工具中。
Subotiz API 密钥为商户进行 API 集成提供必要的接入信息,并支持通过密钥轮换更新安全凭证。合理设置密钥有效期并及时完成新旧密钥切换,有助于保障 API 集成的连续性和账户安全。