开发者 API

发送推送通知 来自你的后端。

Pocket Alert API 只需一次经过身份验证的 HTTP POST 请求,就能向你的手机发送推送通知。无论从 Node、Python、PHP 还是 Go 发起,都可以附上标题、消息内容和优先级,几乎瞬间就能送达你的 iPhone 或 Android 设备。

<1s 内送达简洁的 RESTNode · Python · Go · PHP更新于
功能

推送通知,一次请求即可实现

所有 Pocket Alert 提醒都由这套 API 驱动。只需一次请求,就能接入你的后端。

纯 REST,无需 SDK

一次经过身份验证的 POST 请求,就能通过你已在用的 HTTP 客户端发送推送。无需 SDK、队列或消息代理。

支持任何语言

Node、Python、PHP、Go 和 Ruby 都可以发送 Pocket Alert 推送通知。

基于密钥的身份验证

你的 API 密钥通过 HTTPS 在 Token 请求头中传输。按你自己的节奏创建、限定范围和轮换密钥。

完全可控

一次调用即可用 application_id 指定路由,用 device_id 指定单台设备,或省略它以送达所有设备。

亚秒级送达

推送可在不到一秒内到达你的 iPhone 或 Android 设备,速度足以支撑实时的后端告警。

支持 CLI 与 Webhook

同一套 API 也驱动着 CLI 和 Webhook。先从代码开始,之后随时可以再加入其中一种。

快速开始

发送你的第一条 API 推送,只需三步

1

获取 API 密钥

在 API 密钥页面创建 API 密钥,并将其保存在环境变量中。

2

发送请求

将 JSON 格式的标题和消息内容,连同 Token 请求头中的密钥,以 POST 方式发送到消息接口。

3

正式上线

你的手机会在一秒内震动。随着需求增长,再添加应用和设备的指定方式即可。

发送你的第一条 API 通知

1. 获取 API 密钥

在 API 密钥页面创建密钥,并在每次请求中通过 Token 请求头发送。

2. 发送 POST 消息

curl -X POST 'https://api.pocketalert.app/v1/messages' \
  -H 'Token: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"Order shipped","message":"Order #1024 is on its way","application_id":"qm47b9pzxzxg"}'

3. 从你的代码中发送

在任何接口报错或自定义事件触发时调用它,例如健康检查失败或产生新订单之后:

await fetch("https://api.pocketalert.app/v1/messages", {
  method: "POST",
  headers: { Token: process.env.POCKETALERT_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    title: "API health check failed",
    message: "GET /v1/orders returned 500",
    application_id: "qm47b9pzxzxg",
    level: "high",
  }),
});

完整的入门文档涵盖了应用和设备的指定方式。

常见问题

常见问题解答

将你的密钥放在 Token 请求头中,并附上包含标题和消息内容的 JSON 请求体,向 Pocket Alert 消息 API 发送 POST 请求。通知会立即到达你的手机。

使用设置页面中的 API 密钥进行身份验证,并通过 HTTPS 在 Token 请求头中发送。你可以随时创建和轮换密钥,并按应用限定提醒范围。

任何能发起 HTTP 请求的语言都可以使用:Node、Python、PHP、Go、Ruby 和 Rust 均支持。无需安装任何东西,直接用你已经在用的 HTTP 客户端发起普通的 REST 调用即可。

设置标题和消息内容,用 application_id 指定发送到哪个应用,用 device_id 指定某台设备(省略则发送到所有设备),并用 level 设置优先级,从静音到紧急不等。紧急消息可以突破 Android 的勿扰模式,也能穿透 iPhone 的专注模式。

可以。Pocket Alert CLI 封装了同一套 API,适合脚本和 CI 使用。如果你不想写代码,可以创建一个 Webhook,并将服务指向它的接收 URL。

一次请求,直达你的手机。

创建 API 密钥,从你的后端发送第一条通知。