CKEditor 生态系统文档
Search
首页/云服务/开发者资源

指南API 密钥

# API 密钥概述

API 密钥用于系统中最关键部分的身份验证，这些部分的访问权限应受到限制。例如，API 密钥用于 REST API 和 webhook 机制。

出于安全原因，API 密钥应保存在安全的地方。我们还建议将 API 密钥的有效期设置为不超过 3 个月，并定期更换。

# API 密钥管理

您可以使用 CKEditor 生态系统客户仪表板 中的“API 密钥”选项卡最多创建 3 个 API 密钥。这可以更轻松地进行 API 密钥轮换。“API 密钥”选项卡还提供有关特定 API 密钥的创建日期和上次使用日期等信息。

“API 配置”选项卡中的旧 API 密钥仍然有效。如果您需要停用它，请使用 已弃用的说明 重新生成密钥。

List of API secrets in the API secrets tab.

# 创建新的 API 密钥

要生成新的 API 密钥，请点击“API 密钥”选项卡上可见的“创建新的 API 密钥”。

API 密钥的值只会显示一次。请复制新创建的 API 密钥，并将其保存在安全的地方。
将无法再次显示此 API 密钥的完整值。

Value of newly added API secret.

# 设置 API 密钥用于签名 webhook 请求

在“API 密钥”选项卡中创建的第一个 API 密钥将自动设置为用于签名 webhook 请求。

要更改用于签名的 API 密钥，请点击“使用 webhook”列中所需 API 密钥的单选按钮。

您需要确认或取消此更改。

Use API secrets to sign webhooks confirmation modal.

您随时可以删除任何未设置为用于签名 webhook 请求的 API 密钥。
如果您需要删除设置为用于 webhook 的 API 密钥，则必须先设置另一个 API 密钥用于签名 webhook 请求。

# 删除 API 密钥

要删除 API 密钥，请点击“操作”列中您要删除的 API 密钥旁边的“垃圾桶”图标。
此操作无法撤销，因此需要您在确认模态框中输入“remove”一词并点击“确认”按钮才能确认。

API secret remove confirmation modal.

# API 密钥管理（已弃用）

API 密钥在 CKEditor 生态系统客户仪表板 中的每个 SaaS 环境或本地部署中的管理面板中都可用。要找到它，请执行以下步骤

  1. 从环境列表中选择要管理的环境。

Select the environment that you want to manage.

  1. 转到“API 配置”选项卡，并在“API 密钥”部分点击“刷新”按钮。

The API configuration section with the “Refresh” button in the API secret section.
阅读消息并点击“刷新”按钮以创建新的 API 密钥。

The API secret refresh prompt.

  1. 复制新生成的 API 密钥，并将其保存在安全的地方。您将无法再次显示此 API 密钥。

The API configuration section with the newly created API secret displayed.

如果您的 API 密钥意外被公开，应立即使用上面图片中显示的“刷新”按钮更改它。