> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 管理 API 密钥

> 查看、保护和轮换用于验证 YCloud API 请求的账户级 API 密钥。

YCloud API 密钥是用于验证对 YCloud API 请求的账户级凭据。请在受信任的服务端系统中通过 `X-API-Key` 请求标头发送该密钥。

账户 API 密钥可以调用您 YCloud 账户可用的所有 API。它不局限于单个用户、团队或 WhatsApp Business 电话号码，因此请将其视为高度敏感的机密。

<Warning>
  切勿在浏览器或移动应用代码、源代码管理系统、日志、屏幕截图、工单或聊天消息中泄露 API 密钥。请将其存储在机密管理器中，并且仅向需要使用它的系统和人员授予访问权限。
</Warning>

## 谁可以查看 API 密钥

仅当账户成员被分配的角色授予访问 **Developers** > **API key** 的权限时，才能打开页面并显示密钥。请在 [Users and Teams](/zh/documentation/account-management/users-and-teams) 中查看账户角色和权限。

显示 API 密钥需要双重身份验证（2FA）。每位授权用户在查看密钥之前，都必须为其 YCloud 登录配置 2FA。

要配置或更新 2FA，请打开 [Security settings](https://www.ycloud.com/console/#/app/userSettings/security)。

## 查看 API 密钥

1. 登录 [YCloud 控制台](https://www.ycloud.com/console/)。
2. 前往 **Developers** > **API key**。
3. 找到您要使用的密钥。
4. 点击 **API key** 列中的眼睛图标。
5. 根据提示完成 2FA 验证。
6. 复制密钥并将其存储在机密管理器中。

<Note>
  密钥默认处于隐藏状态。每当授权用户需要显示密钥时，YCloud 都会要求进行 2FA 验证。
</Note>

<Frame caption="The key remains masked. Use the eye icon only when you are ready to complete verification and store the key securely.">
  <img src="https://mintcdn.com/lchnan/gXEJIQXV2JH2VUQJ/product-assets/english-help-2026-09-22/developer-api-key-annotated.svg?fit=max&auto=format&n=gXEJIQXV2JH2VUQJ&q=85&s=7ee360174263ec1e31c2414807c821bb" alt="API 密钥页面，默认密钥已隐藏并标有眼睛图标。" width="3024" height="1656" data-path="product-assets/english-help-2026-09-22/developer-api-key-annotated.svg" />
</Frame>

## 轮换泄露的 API 密钥

YCloud 为标准集成提供一个账户级 API 密钥。如果您认为密钥已泄露，请创建一个替换密钥并谨慎轮换您的系统。

<Warning>
  创建替换密钥不会自动删除或禁用旧密钥。旧密钥将保持可用状态，直到您手动将其删除。
</Warning>

1. 前往 **Developers** > **API key**。
2. 点击 **Add API Key** 生成替换密钥。
3. 安全存储新密钥。
4. 在组织使用的所有服务、环境和机密存储中替换旧密钥。
5. 使用新密钥测试受影响的集成。
6. 确认所有系统均已使用新密钥后，手动删除旧密钥。

在系统完全切换到替换密钥之前，请勿删除旧密钥，否则仍在使用旧密钥的 API 请求将会失败。

## 通过自定义应用使用多个密钥

如果您的组织需要为多个集成使用单独的密钥，请使用[自定义应用](/zh/documentation/developer/create-and-configure-a-custom-app)。

每个自定义应用都有自己独立的 API 密钥，并允许您控制其 API 权限、WhatsApp 资产和 Webhook 配置。当集成需要单独的凭据或不同的访问范围时，推荐使用此方法。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.