API 访问令牌

API 访问令牌是分配给您账户中一个或多个项目的唯一标识符。它通过 API 对您的账户进行身份验证，以便管理您的项目，包括账户修改、发送消息、编辑项目等。

API 访问令牌类型

Pushwoosh 提供两种不同的 API 访问令牌类型：服务器 (Server) 和 设备 (Device)。

每种令牌类型仅在其特定的 API 范围内有效。如果使用不正确的令牌，将会发生身份验证错误。

服务器 API 令牌

服务器 API 令牌用于除设备 API 下的方法外的所有 API 方法。它应包含在请求正文的 auth 字段中。

设备 API 令牌

设备 API 令牌专用于设备 API 方法。它应使用 Authorization 标头包含在 HTTP 请求标头中。以下是正确标头格式的示例：

Authorization: Token <device_api_token>

将 <device_api_token> 替换为您的实际设备 API 令牌值。

创建和管理 API 访问令牌

您可以在 Pushwoosh 控制面板的 API 访问 (API Access) 部分查看、创建和管理您的 API 访问令牌。要访问它，请转到 设置 (Settings) → API 访问 (API Access)。 Pushwoosh 演示应用令牌

默认情况下，每个账户都包含一个名为 Pushwoosh Demo App 的令牌，该令牌被设置为服务器令牌。

创建新的 API 访问令牌

要创建新的 API 访问令牌：

在控制面板中转到 API 访问 (API Access) 部分。
点击 生成新令牌 (Generate New Token)。
在出现的窗口中，选择令牌类型：
- 服务器 (Server) 用于大多数 API 方法（不包括设备 API 方法）。
- 设备 (Device) 仅用于设备 API 方法。
为令牌输入一个名称。
点击 生成 (Generate) 来创建令牌。

生成新令牌

重要提示： 请确保为令牌授予您 Pushwoosh 控制面板中正确应用的访问权限。了解更多

新令牌将出现在 API 访问列表中。您可以从那里复制其值以在 API 请求中使用，或根据需要管理其访问权限。

管理令牌

要管理现有 API 令牌，请点击 API 访问 (API Access) 部分中令牌条目旁边的三点菜单 (⋮)。

管理令牌

提供以下选项：

授予所有项目的访问权限

为令牌授予您账户中所有项目的访问权限。这允许它在所有项目中完全使用 API。

撤销所有项目的访问权限

移除令牌对您账户中所有项目的访问权限。在再次授予访问权限之前，该令牌将无法再使用 API。

编辑令牌

打开 编辑 API 令牌权限 (Edit API Token Permissions) 屏幕，您可以在其中：

更改令牌名称
复制令牌值
通过在列表中选择或取消选择项目来选择令牌可以访问哪些项目

管理令牌

完成更改后，点击 保存 (Save) 以应用它们。

删除令牌

从您的账户中永久删除该令牌。

授权 API 请求

要授权 API 请求，请根据您调用的 API 方法类型使用正确类型的 API 访问令牌：

对于服务器 API 方法

将令牌包含在请求正文的 “auth” 字段中：

示例：

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "yxoPUlwqm…………pIyEX4H", // 在此处粘贴您的服务器令牌
    "notifications": [{
      "send_date": "now",
      "content": "Hello world"
    }]
  }
}

对于设备 API 方法

使用设备令牌。使用以下格式将其包含在 HTTP 请求标头中：

Authorization: Token <device_api_token>

将 <device_api_token> 替换为您的实际令牌值。