管理 API 密钥
API Keys 页面用于创建、查看和管理应用程序调用 FourA API 所需的密钥。
查看密钥
该页面会显示你有权访问的所有密钥:你的个人密钥,以及你所属组织拥有的所有密钥。成员身份即代表授予访问权限,因此普通成员也可以查看组织的密钥。
| 列 | 显示内容 |
|---|---|
| Name | 显示名称,以及设置的描述(若有) |
| Owner | Personal,或组织名称 |
| Key Prefix | 密钥前缀,后接掩码(pk_live_a1b2••••••••),附带 Reveal 按钮,旧版密钥则显示锁图标 |
| Status | Active 或 Inactive |
| Created | 密钥创建时间 |
| Last Used | 密钥最近一次发起请求的时间 |
支持按名称或描述搜索,按 Active 或 Inactive 筛选,并按 Name、Owner、Status、Created 或 Last Used 排序。排序方向依次为降序、升序、关闭。
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...。你将收到一封确认密钥已创建的电子邮件。
你拥有的有效密钥配额由套餐决定:包含你的个人密钥以及你所拥有组织的密钥。为组织创建的密钥计入该组织所有者的套餐配额。达到上限后,系统将拒绝创建密钥并提示套餐配额限制,此时可停用或删除不再使用的密钥,或者升级套餐。
显示密钥完整内容
点击密钥掩码前缀旁的眼睛图标,即可重新查看完整密钥。控制台会要求确认,然后打开一个对话框,其中包含明文密钥、复制按钮和简短倒计时。倒计时结束后,对话框将从页面中清除该密钥。
由于该操作暴露了有效凭据,每次显示操作都会记录在审计日志中。
任何与其共享密钥的人都可以查看该密钥:其个人所有者,或拥有该密钥的组织的任何成员。
旧版密钥
在查看功能上线前创建的密钥会显示锁定图标而非眼睛图标,且无法查看。系统仅存储了这些密钥的哈希值,因此原始密钥无法恢复。若要转换旧版密钥,请打开操作菜单并选择 Regenerate。新生成的密钥此后均可查看。
各角色的权限
对于个人密钥,你可以执行所有操作。对于组织密钥,适用以下三个权限级别:
| 操作 | 成员 | 管理员 | 所有者 |
|---|---|---|---|
| 使用密钥并查看 | 是 | 是 | 是 |
| 重命名、编辑描述 | 是 | 是 | 是 |
| 启用或停用 | 否 | 是 | 是 |
| 重新生成密钥 | 否 | 是 | 是 |
| 删除密钥 | 否 | 是 | 是 |
| 移出组织 | 否 | 否 | 是 |
Disable 和 Edit 仍保留在行中,但会显示为灰色并附带原因说明。当你的角色无权使用 Regenerate、Transfer 和 Delete 时,这些选项不会出现在菜单中。API 同样会拒绝这些操作,因此集成无法绕过界面限制。
权限划分取决于各项操作对密钥共享成员产生的影响。重命名没有任何破坏性。重新生成或停用会立即中断所有同事的相关集成。将密钥移出会将其从公司收回,并将其用量计入接收者自己的套餐,因此该操作仅限所有者执行。
编辑密钥
点击 Edit 可更新名称和描述。此对话框中不能更改所有权:请使用 Transfer。
操作菜单中的 View Metrics 会打开按该密钥筛选的 Overview。
启用和停用
使用行操作中的 Disable 或 Enable。停用密钥会阻止使用它的所有 API request,你可以随时重新启用它。更改会在一分钟内生效。
重新生成密钥
如果你怀疑密钥已泄露,请打开操作菜单并选择 Regenerate。这将为相同的密钥 ID 创建新的 secret。旧的 secret 会在一分钟内失效。名称、所有者和所有其他设置均保持不变。
对话框关闭后,新 secret 仍可查看,因此无需在首次弹出时必须一次性复制成功。
转移密钥
操作菜单中的 Transfer 可在个人和组织所有权之间转移密钥,无需重新生成 secret。密钥 ID、指标和活动历史记录均会保留。仅所有者发生更改,账单结算对象也随之变更。
| 转移类型 | 操作权限所有者 |
|---|---|
| 个人密钥转入组织 | 该组织的任何成员 |
| 组织密钥转出至个人 | 组织所有者 |
| 在两个组织之间转移 | 密钥转出方组织的所有者 |
转入组织的密钥会加入其默认的 "Everyone" 团队,使组织成员均可见。转出的密钥将退出其之前所在的所有团队。
删除密钥
打开操作菜单并选择删除。删除曾使用过的密钥会将其停用:该密钥将停止身份验证,并作为非活跃状态保留在列表中,以便其活动和指标历史记录保留其名称。从未使用的密钥会被彻底移除。
密钥被删除时,您会收到一封电子邮件。
组织密钥与结算
无论请求由谁发起,组织拥有的密钥的使用量都会计入组织所有者的套餐。所有者的 使用量与限额 页面会将这些密钥与其个人密钥并列统计,并将两者分开展示。