API Access Token

API Access Token 是分配给您帐户中特定项目或多个项目的唯一标识符。它用于验证您的帐户，以便通过 API 管理项目，包括修改帐户、发送消息、编辑项目等。

API Access Token 类型

Pushwoosh 提供两种不同类型的 API Access Token：Server 和 Device。

每种令牌类型仅对其特定的 API 范围有效。如果使用了错误的令牌，将发生身份验证错误。

Server API Token

Server API Token 用于所有 API 方法，除了 Device API 下的方法。它应包含在请求体的 auth 字段中。

Device API Token

Device API Token 专用于 Device API 方法。它应包含在 HTTP 请求头中，使用 Authorization 头。以下是正确的头部格式示例：

Authorization: Token <device_api_token>

将 \<device_api_token\> 替换为您的实际 Device API Token 值。

创建和管理 API Access Token

您可以在 Pushwoosh 控制面板的 API Access 部分查看、创建和管理您的 API Access Token。要访问它，请转到 Settings → API Access。 Pushwoosh Demo App 令牌

默认情况下，每个帐户都包含一个名为 Pushwoosh Demo App 的令牌，该令牌设置为 Server 令牌。

创建新的 API Access Token

要创建新的 API Access Token：

转到控制面板中的 API Access 部分。
点击 Generate New Token。
在出现的窗口中，选择令牌类型：
- Server 用于大多数 API 方法（不包括 Device API 方法）。
- Device 仅用于 Device API 方法。
输入令牌名称。
点击 Generate 创建令牌。

生成新令牌

重要提示： 请务必在 Pushwoosh 控制面板中授予令牌对正确应用程序的访问权限。了解更多

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

管理令牌

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

管理令牌

可用选项如下：

Grant access to all projects（授予所有项目的访问权限）

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

Revoke access from all projects（撤销所有项目的访问权限）

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

Edit token（编辑令牌）

打开 Edit API Token Permissions 屏幕，您可以在其中：

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

管理令牌

完成更改后，点击 Save 应用更改。

Delete token（删除令牌）

从您的帐户中永久移除令牌。

授权 API 请求

要授权 API 请求，请根据您调用的 API 方法类型使用正确类型的 API Access Token：

对于 Server API 方法

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

示例：

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

对于 Device API 方法

使用 Device Token。使用以下格式将其包含在 HTTP 请求头中：

Authorization: Token <device_api_token>

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