Pushwoosh API 概述
Pushwoosh API 允许开发者与 Pushwoosh 平台进行交互。
您可以使用 Pushwoosh API 做什么？
Anchor link to通过 Pushwoosh API，您可以访问一个包含 100 多种方法的广泛库，从而能够：
- 发送个性化的推送通知
- 创建、导入、导出和管理用户细分，以实现精准定位
- 利用批量 API 批量管理用户/设备
- 配置应用程序
- 跟踪用户事件并为用户添加标签，以增强定位和个性化
- 创建和管理 Pushwoosh 实体，如预设、标签、事件、应用程序等。
- 通过 API 启动 Pushwoosh Customer Journey
- 检索有关 Customer Journey 和 Push/Email/SMS 营销活动的全面统计数据。
- 实施地理围栏，以便在用户进入或离开特定地理区域时发送基于位置的通知
- 将第三方服务与 Pushwoosh 无缝集成
要探索所有可用的方法并发现 Pushwoosh API 的广泛功能，请参阅 API 方法参考索引。
身份验证
Anchor link toPushwoosh API 使用 API 令牌来验证请求。令牌有两种类型：服务器 和 设备，每种类型用于特定的 API 范围。
每个 Pushwoosh 账户都带有一个为 Pushwoosh Demo App 创建的默认 API Access Token。您可以在 Pushwoosh Control Panel 中查看、创建和管理您的 API 令牌。
速率限制
Anchor link to速率限制是指 API 在给定时间段内可以接收的请求数量。虽然 Pushwoosh 中的大多数 API 请求没有限制，但 /createMessage 和等效的 Messaging API v2 Notify 请求上限为每分钟 600 次，以确保为所有用户提供服务质量。
所有 API 请求都必须使用 HTTPS，以确保数据传输安全。
Pushwoosh API 通常返回 JSON 响应。
成功和错误代码
Anchor link to成功代码
Anchor link to当您的 API 请求成功处理后，您将在响应中收到一个成功代码。
| HTTP 状态代码 | 状态消息 | 描述 |
|---|---|---|
| 200 | OK | Pushwoosh 已成功处理该请求 |
请注意，当您收到 HTTP 200 响应时，这表示您的请求已被理解并成功处理，但这并不能保证操作成功。因此，请务必检查错误或警告消息（访问被拒绝、应用程序未找到、API 密钥无效等），以确定操作是否成功。
| 状态代码 | 状态消息 |
|---|---|
| 200 | 警告：您已达到订阅者上限。推送消息将仅发送到 1 个随机设备 |
| 200 | 警告：您已超出当前订阅计划允许的活跃设备数量。 |
| 210 | 访问被拒绝或应用程序未找到 |
| 210 | 应用程序未找到 |
| 210 | 应用程序已暂停 |
| 210 | 账户未找到 |
| 210 | 账户已被暂停 |
| 210 | 已暂停的账户无法使用设备过滤 |
| 210 | 未设置 API 令牌或应用程序 |
| 210 | 请至少选择一个平台 |
| 210 | API 令牌无效：账户未找到 |
| 210 | 未提供应用程序或组代码 |
| 210 | 未设置 API 令牌、应用程序或账户 |
错误代码
Anchor link to如果您的请求格式不正确、遇到处理问题或出现任何其他错误，Pushwoosh 将向您发送一个错误代码，以指明问题的性质，帮助您有效地进行故障排除和解决问题。
| HTTP 状态代码 | 状态消息 | 描述 |
|---|---|---|
| 400 | 错误请求 | 由于语法错误，无法完成请求 |
| 401 | 未授权 | 身份验证失败或未提供 |
| 403 | 令牌限制禁止此操作。 | 您的访问令牌缺少执行所请求操作的必要权限。要解决此问题，请在 Pushwoosh 控制面板中查看您的访问令牌权限，并根据需要进行调整，以满足您要执行的特定操作的要求。 |
| 404 | 资源未找到 | 表示请求的资源（例如应用程序）无法在服务器上找到或不存在。 |
| 500 | 内部错误 | 在处理 API 请求时，服务器上出现了意外问题或错误。 |