開発者向け API

プッシュ通知を送信 バックエンドから。

Pocket Alert API は、認証付きの HTTP POST を 1 回送るだけで、スマホにプッシュ通知を届けられます。Node、Python、PHP、Go などから title、message、優先度 level を指定して送信すれば、iPhone や Android にほぼ瞬時に届きます。

<1 秒で配信シンプルな RESTNode · Python · Go · PHP 更新
機能

プッシュ通知は 1 回のリクエストで

Pocket Alert のすべての通知は API を経由しています。バックエンドに 1 回のリクエストを組み込むだけで連携できます。

シンプルな REST、SDK 不要

認証付きの POST を 1 回送るだけで、普段お使いの HTTP クライアントからプッシュ通知を送信できます。SDK やキュー、ブローカーは不要です。

あらゆる言語に対応

Node、Python、PHP、Go、Ruby のいずれからでも Pocket Alert の通知を送信できます。

キーによる認証

API キーは HTTPS 経由で Token ヘッダーに含めて送信します。キーの作成、スコープ設定、ローテーションはお好みのタイミングで行えます。

細かな制御

application_id で振り分け、device_id で 1 台を指定するか、省略してすべてのデバイスに届けるかを、1 回の呼び出しで決められます。

1 秒以内の配信

プッシュ通知は iPhone や Android に 1 秒以内に届くため、リアルタイムのバックエンド通知にも十分な速さです。

CLI・Webhook にも対応

同じ API が CLI と Webhook の基盤にもなっています。まずはコードから始めて、後から必要に応じて追加できます。

はじめ方

API プッシュ通知を送るまでの 3 ステップ

1

API キーを取得

API キーのページで API キーを作成し、環境変数に保存します。

2

リクエストを送信

Token ヘッダーにキーを指定し、JSON の title と message をメッセージのエンドポイントに POST します。

3

公開して運用

1 秒以内にスマホが振動します。必要に応じて、アプリケーションとデバイスの指定を追加してください。

最初の 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",
  }),
});

アプリケーションやデバイスの指定方法について詳しくは、はじめに のドキュメントをご覧ください。

FAQ

よくある質問

Token ヘッダーに API キーを指定し、title と message を含む JSON ボディを付けて Pocket Alert のメッセージ API に POST してください。通知はすぐにスマホへ届きます。

設定ページで発行した API キーを、HTTPS 経由で Token ヘッダーに含めて認証します。キーは必要に応じて作成・ローテーションでき、アプリケーションごとに通知の範囲を設定できます。

HTTP リクエストを送れる言語であればどれでも使えます。Node、Python、PHP、Go、Ruby、Rust に対応しています。インストールは不要で、普段お使いの HTTP クライアントから通常の REST 呼び出しを行うだけです。

title と message を設定し、application_id で特定のアプリケーションへ振り分け、device_id で 1 台のデバイスを指定できます(省略するとすべてのデバイスに届きます)。level で優先度を silent から critical まで設定できます。critical のメッセージは、Android ではおやすみモードを貫通し、iPhone では集中モードでも届きます。

はい。Pocket Alert CLI は同じ API をスクリプトや CI から扱えるようにしたものです。コードを書きたくない場合は、Webhook を作成して、サービス側の送信先に受信 URL を設定してください。

1 回のリクエストで、スマホへ直接届きます。

API キーを作成して、バックエンドから最初のプッシュ通知を送信しましょう。