API 密钥¶
NereidHorizon 中的 API 密钥允许合作方通过只读的 Partner API(GET /api/v1/{org}/...)访问本组织数据,而无需登录控制台。当外部系统需要以编程方式拉取本组织的服务、模式、策略或节点信息时,使用 API 密钥。
密钥格式与存储¶
- 密钥格式为
nk_live_<随机>或nk_test_<随机>。 - Horizon 仅存储密钥的 SHA-256 哈希,明文密钥仅在创建时显示一次。
谁可以管理密钥¶
| 角色 | 能力 |
|---|---|
| 合作方(Partner) | 仅能为自己的组织创建和吊销密钥,不能操作其他组织 |
| 平台(Platform) | 可以为任意组织创建和删除密钥 |
创建密钥¶
- 打开「API 密钥」页面。
- 填写用于辨识用途的标签(label)。
- 设置有效期(天),或选择永不过期。
- 立即复制创建弹窗中显示的明文密钥。
吊销与删除¶
已吊销的密钥立即失效,使用该密钥调用 Partner API 将返回 401。删除密钥则会将其彻底移除。
请妥善保管密钥
明文密钥只在创建弹窗中展示一次,请立即复制并妥善保存;一旦泄露应立即吊销。