# API Keys

集中管理应用的访问凭证

## API Key 列表

**功能说明**

「API Keys」页集中管理应用的访问凭证，用于调用接口的身份鉴权。页面顶部展示接口调用的 Base URL（如 `https://router.fis.aliyuncs.com/finx`，支持一键复制）；列表表头为：**API Key / 描述 / 创建时间 / 操作**，其中「操作」列提供红色「删除」链接。右上角提供「了解更多」文档入口。

**前置条件**

- 已进入目标应用空间。

**操作步骤**

1. 点击侧边栏「API Keys」进入页面。
2. 复制顶部 Base URL，用于客户端接口调用的服务地址配置。
3. 在「搜索描述 / 前缀…」输入框中检索已有 API Key（支持按描述、密钥前缀或 ID 检索；列表中密钥仅显示前缀，如 `dk_sz9m0...`）。

**预期结果**：列表展示当前空间的 API Key 概要信息，明文密钥不在列表中展示。没有密钥时显示「暂无 API Key」，并提示「点击「创建 API Key」生成首个访问凭证」；检索不到时显示「未找到匹配的 API Key」。

![API Keys 列表](/docs/images/tenant-portal/15-api-keys-list.png)

*图 2-17：API Keys 页——顶部为 Base URL，列表仅展示密钥前缀、描述与创建时间，行尾提供「删除」操作。*

## 创建 API Key（分步图解）

**功能说明**

创建流程由「填写信息 → 生成并保存明文」两步弹窗组成。创建弹窗描述原文：「该 API Key 将归属于以下应用空间，可访问该空间下的所有资源，请妥善保管。」

**前置条件**

- 已进入目标应用空间的「API Keys」页。

**操作步骤**

1. 点击列表右上角「创建 API Key」，打开「创建 API Key」弹窗。弹窗中「应用空间」固定显示当前空间（不可更改）。「描述」为选填，用于说明用途（如「主应用的生产环境 API Key」），最长 50 个字符，输入框右侧实时显示字数（如「12/50」）。![创建 API Key 弹窗](/docs/images/tenant-portal/40-apikey-create-dialog.png)*图 2-18：创建 API Key 弹窗——确认归属应用空间并填写描述，点击「生成 API Key」。*
2. 点击「生成 API Key」。系统提示「API Key 创建成功」，并弹出结果窗口（说明「请复制并保存 API Key。」），顶部为醒目警示：「请妥善保存 API Key —— API Key 明文仅在创建时展示一次，关闭此窗口后将无法再次查看完整密钥。」
3. 在结果窗口中点击眼睛图标查看明文，点击复制图标将完整密钥复制到安全的密钥管理工具中妥善保存。![API Key 创建结果弹窗](/docs/images/tenant-portal/41-apikey-created-result.png)*图 2-19：API Key 创建结果——明文仅此一次展示，务必先复制保存，再点击「我已保存，关闭」。*
4. 确认已妥善保存后，点击「我已保存，关闭」关闭窗口。

**预期结果**：系统提示「API Key 创建成功」；列表中出现新密钥的前缀记录。

> API Key 明文仅在创建时展示一次，关闭结果窗口后将无法再次查看完整密钥。若未保存即关闭，只能删除该密钥并重新创建。

## 删除 API Key

**功能说明**

删除操作用于吊销不再使用的 API Key。

**前置条件**

- 确认目标密钥已无线上调用依赖。

**操作步骤**

1. 在列表中找到目标 API Key，点击行尾红色「删除」。
2. 系统弹出「确认删除 API Key」对话框，文案为：「即将删除 API Key dk_ctJhk...，删除后使用该密钥的调用将立即失效，此操作不可撤销。」
3. 确认无误后点击「确认删除」；如需放弃，点击「取消」。

**预期结果**：系统提示「API Key 已删除」，列表中该密钥消失。

![删除 API Key 确认](/docs/images/tenant-portal/42-apikey-delete-confirm.png)

*图 2-20：删除 API Key 二次确认对话框——删除后使用该密钥的调用将立即失效。*

> 删除 API Key 不可撤销，删除后使用该密钥的调用将**立即失效**。请务必先完成调用方的密钥轮转，再执行删除。

**注意事项 / 异常处理**

- API Key 归属于单个应用空间，仅能访问该空间下的资源；跨空间调用请在对应空间分别创建密钥。
- 密钥疑似泄露时，应立即创建新密钥完成替换，随后删除旧密钥。
