跳转到主要内容
您的 OneSignal 账户包括公开 ID 和私有 API 密钥，这些对于配置您的应用和访问 OneSignal API 至关重要。本指南解释了在哪里可以找到它们、如何管理它们以及安全使用的最佳实践。

​
应用 ID

应用 ID 是您 OneSignal 项目的唯一公开标识符，格式为 UUID v4。它与您的私有 API 密钥不同，需要用于： 在 OneSignal 仪表板的 设置 > 密钥和 ID 下或通过 查看应用 API 找到您的应用 ID。

密钥和 ID 页面，用于查找您的应用 ID 和应用 API 密钥。


示例：在哪里找到您的应用 ID。

​
组织 ID

您的组织 ID（Org ID）是 UUID v4 格式的唯一标识符，用于将您计费计划下的所有应用分组。它用于以下相关 API： 您可以在仪表板的 组织 > 您的组织 下或通过 查看应用 API 找到您的 organization_id。

示例：如何在 OneSignal 仪表板中找到您的组织 ID。

​
API 密钥

有两种类型的 API 密钥：
  1. 应用 API 密钥
  2. 组织 API 密钥 – 用于在组织内配置应用和 API 密钥的私有密钥。

​
应用 API 密钥

您的应用 API 密钥是用于大多数与特定应用相关的 REST API 请求的私有密钥。
  • 应用 API 密钥可以在 设置 > 密钥和 ID 下创建或通过 创建 API 密钥 创建。
  • 它们只能在创建后查看一次。
  • 使用 key 身份验证方案在 Authorization 标头中包含此密钥： 
    Authorization: key YOUR_REST_API_KEY
像密码一样对待应用 API 密钥。不要共享、在应用代码中暴露或存储在 GitHub 等公共存储库中。

​
组织 API 密钥

您的组织 API 密钥是用于在组织内管理应用和应用 API 密钥的私有密钥。以下 API 请求需要它： 要创建组织 API 密钥，请在 OneSignal 仪表板中导航到 组织 > 您的组织 > 密钥和 ID。

组织 API 密钥替代传统的用户身份验证密钥。

与应用 API 密钥一样，您可以配置多达 16 个组织密钥并包含 IP 允许列表配置。

​
创建 API 密钥

  • 应用 API 密钥 – 转到您应用的设置 > 密钥和 ID或使用创建 API 密钥 API。
  • 组织 API 密钥 – 转到您组织的密钥和 ID部分。
点击添加密钥打开创建模态框。

API 密钥仅显示一次。使用 添加密钥 来生成一个。

为您的密钥起一个描述性名称（如”CRM 同步服务”）。

​
IP 白名单

可选地，通过启用 IP 允许列表将 API 密钥使用限制为特定 IP 地址。 输入以空格分隔的 CIDR 块（如 192.0.2.0/24 192.0.2.123/32）。 来自非允许 IP 的请求将被拒绝。

创建带有可选 IP 允许列表的 API 密钥。

​
查看 API 密钥

点击创建后，您的 API 密钥将只显示一次。请安全保存。

生成的 API 密钥（仅显示一次）。

点击继续后，将无法再查看该密钥。

​
密钥管理

创建密钥后，您可以通过密钥列表界面管理它：

密钥 ID 仅是供参考的标签，不是实际的 API 密钥。

​
编辑 API 密钥

通过仪表板或更新 API 密钥 API：
  • 更新名称或 IP 允许列表
  • 不更改密钥—无需更改应用代码

​
轮换 API 密钥

通过仪表板或轮换 API 密钥 API：
  • 更换密钥的秘密
  • 保持相同的名称和 IP 设置
  • 您必须使用新密钥更新您的应用或集成

​
删除 API 密钥

通过仪表板或删除 API 密钥 API：
  • 永久删除密钥
  • 阻止使用该密钥的任何进一步 API 访问

​
从传统 API 密钥迁移

我们在 2024 年 11 月 14 日引入了丰富的 API 密钥管理功能。 迁移步骤
  1. 创建一个新的丰富 API 密钥（见上文）。
  2. 在您的代码库中替换传统密钥。
  3. 更新 API 调用以使用 https://api.onesignal.com 而不是旧的 https://onesignal.com/api/v1/ URL。
  4. 从密钥和 ID 页面删除传统密钥或点击”禁用传统密钥”。

​
禁用您的应用

禁用应用将阻止：
  • 新通知
  • 等待发送的计划通知
它不会阻止新设备订阅。要防止这些，您必须从应用中移除 OneSignal 代码。 禁用的应用可以随时在仪表板中重新启用。
⌘I