LogoShipSaaS

密钥管理

学习如何在 ShipSaaS 中管理 API 密钥

本文档介绍 ShipSaaS 模板中的 API 密钥管理模块。

核心功能

  • 创建 API 密钥(支持自定义名称)
  • 新建密钥仅展示一次完整密钥,列表中以掩码显示(前缀 + ••••••)
  • 列表展示当前用户的密钥(名称、密钥前缀、创建时间、过期时间)
  • 删除 API 密钥

密钥管理界面

密钥管理入口在 设置 → API 密钥,仅登录用户可访问,用于管理当前账号下的 API 密钥。

  • 创建密钥:点击「创建 API 密钥」,输入名称后确认;创建成功会弹窗展示完整密钥一次,提醒用户及时复制保存,关闭后无法再次查看完整密钥。
  • 列表:表格展示名称、密钥掩码(如 key_••••••••••••)、创建时间、过期时间(未设置则显示「永不过期」)等信息。
  • 删除:通过行内菜单的「删除」移除密钥,删除后该密钥立即失效。

验证 API 密钥

在需要鉴权的接口中,可从请求头读取 API 密钥,并调用 Better Auth 的 auth.api.verifyApiKey 进行校验。

下一步

了解更多相关能力:

On this page