管理 API 密钥
API Keys 页面允许您创建、查看和管理您的应用程序用于调用 FourA API 的密钥。
查看您的密钥
该页面显示您有权访问的所有密钥:
- 个人密钥:您直接创建的密钥。
- 组织密钥:如果您是组织所有者或管理员。
- 团队密钥:通过团队成员身份与您共享的密钥。
表格中的每一行显示:
| 列 | 显示内容 |
|---|---|
| 名称 | 显示名称和(可选)描述 |
| 密钥 | 遮蔽的前缀(例如 pk_live_••••••••),旁边有 Reveal 按钮 |
| 所有者 | 个人密钥显示为 ME,组织或团队共享密钥显示为 TEAM |
| IP 白名单 | 如果已设置则显示受限制的 IP,未限制则显示 "All IPs" |
| 过期时间 | 如果已设置则显示过期日期,否则显示 "Never" |
| 状态 | Active 或 Inactive |
| 创建时间 | 密钥创建的时间 |
| 上次使用 | 密钥上次发起 request 的时间 |
使用搜索框按名称或描述进行过滤,并使用状态过滤器仅显示处于 active 或 inactive 状态的密钥。
创建密钥
点击 Create Key 并填写:
| 字段 | 必填 | 描述 |
|---|---|---|
| 名称 | 是 | 描述性标签(例如 "production-scraper" 或 "staging-test") |
| 描述 | 否 | 关于此密钥用途的说明 |
如果您属于某个组织,还可以将该密钥分配给该组织,而不是您的个人账户。
创建成功后,完整的密钥会在一个便于复制的对话框中显示一次。只要该密钥是在 Reveal 功能发布后创建的,您稍后也可以通过 Reveal(见下文)重新查看它。
密钥使用 pk_live_ 前缀,格式类似于:pk_live_a1b2c3d4e5f6...。创建新密钥时,您将收到一封电子邮件确认信。
显示密钥
点击密钥遮蔽前缀旁边的眼睛图标,即可再次查看其完整的 secret。Dashboard 会要求您确认,然后打开一个对话框,其中包含明文密钥、复制按钮和 15 秒倒计时。倒计时结束后,对话框会从页面中清除该 secret。
每次执行 reveal 操作都会记录在审计日志中,因为它暴露了活动的凭据。
历史密钥
在此功能发布之前创建的密钥会显示锁图标而不是眼睛图标,且无法被显示。由于系统仅存储了它们的哈希值,因此原始 secret 无法恢复。要转换历史密钥,请点击操作菜单并选择 Regenerate。此后,新的 secret 将可以被显示。
谁可以执行 Reveal
| 角色 | 是否可以显示 |
|---|---|
| 密钥所有者 | 是 |
| 组织所有者 / 管理员(针对组织密钥) | 是 |
拥有 write 或 admin 权限的团队成员 |
是 |
拥有 read 权限的团队成员 |
否 |
编辑密钥
点击任意行上的 Edit 以更新:
- 显示名称和描述
- IP 白名单(每行一个 IP;留空允许任何源 IP)
- 过期日期(留空表示永不过期)
其他设置(组织分配、所有者)无法编辑。如果您需要更改所有权,请创建一个新密钥。
启用和禁用
使用行上的 Disable / Enable 按钮来切换密钥状态。禁用密钥会阻止所有使用该密钥的 API request。您可以随时重新启用它。更改将在几秒钟内生效。
重新生成密钥
如果您怀疑密钥已泄露,请打开操作菜单(三点按钮)并选择 Regenerate。这将为相同的密钥 ID 创建一个新的 secret。旧的 secret 将立即失效。所有其他设置(名称、组织分配、IP 白名单、过期时间)保持不变。
对话框关闭后,新的 secret 仍然可以显示,因此您无需在第一次尝试时就完美地复制它。
删除密钥
打开操作菜单并选择 Delete。默认情况下,删除操作会禁用该密钥(软删除)。您可以在确认对话框中将其永久删除。
删除密钥后,您将收到一封电子邮件通知。
组织密钥
在组织下创建的密钥会根据组织成员的角色与他们共享:
- 所有者和管理员可以查看和编辑所有组织密钥。
- 成员只能查看分配给他们所属团队的密钥。
组织密钥在创建时会自动添加到组织的默认团队中。
通过团队管理密钥权限
团队控制谁可以访问哪些密钥。每个团队-密钥分配都具有一个权限级别:
| 权限 | 查看密钥 | Reveal | 编辑密钥设置 |
|---|---|---|---|
| read | 是 | 否 | 否 |
| write | 是 | 是 | 是 |
| admin | 是 | 是 | 是 |
相关内容
- Authentication:API 密钥如何与 API 配合使用
- Organizations and Teams:设置共享访问权限
- Dashboard Overview:所有 Dashboard 板块