管理 API 密钥
API Keys 页面用于创建、查看和管理应用程序调用 FourA API 所需的密钥。
查看密钥
该页面会显示你有权访问的所有密钥:你的个人密钥,以及你所属组织拥有的所有密钥。成员身份即代表拥有访问权限,因此普通成员也可以查看组织的密钥。
| 列 | 说明 |
|---|---|
| Name | 显示名称,以及设置的描述内容(若有) |
| Owner | Personal 或组织名称 |
| Key Prefix | 带有 Reveal 按钮的隐藏前缀 (pk_live_••••••••),旧版密钥则显示锁图标 |
| Status | Active 或 Inactive |
| Created | 密钥创建时间 |
| Last Used | 密钥最近一次发起 request 的时间 |
支持按名称或描述搜索,按 Active 或 Inactive 筛选,以及按任意表头排序。排序方向按降序、升序、关闭依次循环。
Owner 筛选器
如果你至少属于一个组织,搜索框旁会显示 Owner 下拉菜单:包含 Everything、Personal 或各个组织的选项。选择后将仅列出该所有者的密钥。Overview、Metrics、Activity 和 Proxy 页面上的相同控件也会同步该选择,确保这五个页面始终保持一致的流量归属视角。
创建密钥
点击列表上方的 Create Key(在创建首个密钥前的空白页面上为 Create API key)并填写以下内容:
| 字段 | 必填 | 描述 |
|---|---|---|
| Name | 是 | 描述性标签,例如 "production-scraper" 或 "staging-test" |
| Description | 否 | 关于此密钥用途的说明 |
| Owner | 属于组织时必填 | Personal 或你所属的任意组织。仅当你至少属于一个组织时才会显示选择器。 |
组织内的任何成员都可以为其所属组织创建密钥,不受角色限制。此设置的核心目的在于:组织密钥的使用额度将计入组织所有者的账单,开发人员无需使用可能会扣除个人费用而非公司费用的个人密钥。
创建完成后,完整密钥会在弹出的复制对话框中显示一次。后续你也可以通过 Reveal 再次查看。密钥使用 pk_live_ 前缀,格式如 pk_live_a1b2c3d4e5f6...。创建密钥后,你将收到一封确认邮件。
显示密钥完整内容
点击密钥隐藏前缀旁的眼睛图标,即可再次查看完整的 secret。控制台会要求确认,随后打开一个包含明文密钥、复制按钮和简短倒计时的对话框。倒计时结束后,对话框会从页面中清除该 secret。
由于会暴露有效的凭证,每次显示操作都会记录在审计日志中。
密钥的共享对象均可执行显示操作:密钥的个人所有者,或拥有该密钥的组织中的任何成员。
旧版密钥
在显示功能上线前创建的 Key 会显示锁图标而非眼睛图标,且无法被显示。由于系统仅存储了其哈希值,原始 secret 无法恢复。如需迁移旧版 Key,请打开操作菜单并选择 Regenerate。新 secret 此后即可随时显示。
各角色的权限分配
对于个人 Key,您拥有全部权限。对于组织 Key,适用三个权限级别:
| Action | Member | Admin | Owner |
|---|---|---|---|
| Use the key and reveal it | Yes | Yes | Yes |
| Rename it, edit the description | Yes | Yes | Yes |
| Enable or disable it | No | Yes | Yes |
| Regenerate the secret | No | Yes | Yes |
| Delete it | No | Yes | Yes |
| Move it out of the organization | No | No | Yes |
Disable 和 Edit 会保留在行中,但会置灰并附带说明原因的提示。当您的角色无权使用 Regenerate、Transfer 和 Delete 时,这些选项不会出现在菜单中。API 会拒绝相同的操作,因此集成无法绕过界面限制。
权限划分取决于各操作对共享该 Key 的成员产生的影响。重命名没有任何影响。重新生成或禁用操作会在生效瞬间中断所有同事的集成。将 Key 移出组织会将其从公司剥离,并将其用量计入接收者自己的套餐,因此该操作仅限 Owner 执行。
编辑 Key
点击 Edit 可更新名称和描述。所有权无法在此对话框中更改,请使用 Transfer。
操作菜单中的 View Metrics 会打开按该 Key 过滤的 Overview。
启用与停用
在对应行中使用 Disable 或 Enable。停用 Key 会拦截使用该 Key 的所有 API request,您可以随时重新启用它。更改会在数秒内生效。
重新生成 Key
如果您怀疑 Key 已泄露,请打开操作菜单并选择 Regenerate。这将为同一个 Key ID 创建新的 secret。旧 secret 会立即失效。名称、所有者和所有其他设置保持不变。
对话框关闭后,新 secret 仍可随时显示,因此您无需在第一次操作时立即复制。
转移 Key
操作菜单中的 Transfer 可以在个人所有权与组织所有权之间迁移 Key,而无需重新生成 secret。Key ID、其指标数据和活动历史记录均会保留。仅所有者会发生变更,用量计费对象也会随之更改。
| Move | Who can do it |
|---|---|
| Personal key into an organization | Anyone who belongs to that organization |
| Organization key out, to yourself | The organization's owner |
| Between two organizations | The owner of the organization the key is leaving |
移入组织的 Key 会加入其默认的 "Everyone" 团队,使成员能够看到该 Key。移出组织的 Key 会离开其此前所在的所有团队。
删除 Key
打开操作菜单并选择删除。删除曾使用过的密钥会将其禁用:该密钥将停止身份验证,并在列表中保留为未激活状态,以便其活动和指标历史记录继续保留其名称。从未使用的密钥将被彻底移除。
密钥被删除时,您会收到一封电子邮件。
组织密钥与计费
无论由谁发起请求,组织名下密钥的使用量都会计入组织所有者的套餐。所有者的 使用量与限制 页面会将这些密钥与其个人密钥一同统计,并将两者分开展示。