管理 API 密钥
API Keys 页面允许您创建、查看和管理应用程序用来调用 FourA API 的密钥。
查看您的密钥
此页面显示您有权访问的所有密钥:
- 您直接创建的个人密钥。
- 如果您是组织所有者或管理员,或者是您拥有的密钥已转移到您的某个组织,则显示组织密钥。
表格的每一行显示:
| 列 | 显示内容 |
|---|---|
| Name | 显示名称和(可选)描述 |
| Key | 屏蔽的前缀(例如 pk_live_••••••••),旁边有一个 Reveal 按钮 |
| Owner | 个人密钥显示 Personal,组织拥有的密钥显示组织名称 |
| Status | Active 或 Inactive |
| Created | 创建密钥的时间 |
| Last Used | 密钥最后一次发起 request 的时间 |
使用搜索框按名称或描述过滤,使用状态过滤器仅显示活动的或非活动的密钥。所有列标题均可排序。
创建密钥
点击 Create Key 并填写:
| 字段 | 必填 | 描述 |
|---|---|---|
| Name | 是 | 描述性标签(例如,"production-scraper" 或 "staging-test") |
| Description | 否 | 关于此密钥用途的说明 |
| Owner | 如果您在组织中则是 | 个人,或您所属的组织之一。仅当您至少拥有一个组织时,选择器才会显示。 |
创建后,完整密钥会立即在可复制的对话框中显示一次。您也可以稍后通过 Reveal 将其找回(见下文)。
密钥使用 pk_live_ 前缀,看起来像 pk_live_a1b2c3d4e5f6...。创建新密钥时,您将收到一封确认邮件。
显示密钥
点击密钥被屏蔽前缀旁边的眼睛图标,再次查看其完整的 secret。仪表板会要求您确认,然后打开一个包含明文密钥、复制按钮和短倒计时的对话框。倒计时结束后,对话框会从页面中清除 secret。
每一次显示都会记录在审计日志中,因为它暴露了有效的凭证。
旧版密钥
在显示功能发布之前创建的密钥会显示锁定图标而不是眼睛图标,且无法显示。由于只存储了其哈希值,因此原始 secret 无法恢复。要切换旧版密钥,请点击操作菜单并选择 Regenerate。从此以后,新的 secret 就可以显示了。
谁可以显示
| 角色 | 可以显示 |
|---|---|
| 密钥所有者 | 是 |
| 组织所有者或管理员(对于组织拥有的密钥) | 是 |
| 其他任何人 | 否 |
编辑密钥
点击任何行上的 Edit 以更新显示名称和描述。此处不更改所有权(个人与组织)。使用下面的 Transfer 在所有者之间移动密钥。
启用和停用
使用行上的 Disable / Enable 按钮来切换密钥的状态。停用密钥会阻止使用它的所有 API request。您可以随时重新启用它。更改将在几秒钟内生效。
重新生成密钥
如果您怀疑密钥已泄露,请打开操作菜单(三点按钮)并选择 Regenerate。这将为相同的密钥ID创建一个新的secret。旧的secret会立即失效。名称、组织分配和其他设置保持不变。
对话框关闭后,新的secret仍可显示,因此您不必在第一次尝试时就完美复制它。
转移密钥
每行的菜单中都有一个 Transfer 操作。使用它在个人和组织所有权之间移动密钥,而无需重新生成secret。密钥ID、其指标及其活动历史记录将被保留;只有所有者发生变化。
常见情况:
- 将您为共享项目构建的个人密钥移至组织中,以便队友在您之后进行管理。
- 如果项目分拆,请将组织密钥重新分配给您自己。
您可以将您拥有的密钥(个人)转移到您担任所有者或管理员的任何组织中,也可以将您管理的组织密钥转移给自己或在您管理的组织之间进行转移。
删除密钥
打开操作菜单并选择 Delete。删除您以前使用过的密钥会将其软删除: 密钥停止身份验证,但其活动和指标历史记录保持完好。从未使用过的密钥可以被硬删除。
密钥被删除时,您将收到一封电子邮件通知。
组织密钥
组织拥有的密钥对组织所有者和管理员可见。没有所有者或管理员角色的成员看不到它们。
组织拥有的密钥的使用量计入组织所有者的计划中。
相关内容
- Authentication: API密钥如何与API配合使用
- Organizations and Teams: 设置共享访问权限
- Dashboard Overview: 所有仪表板部分