送信方法
通知は 1 件ごとに push.breezelabs.dev への HTTPS リクエストです。使うツールに合った方法を選んでください。どの方法でも同じパラメーターを使えます。暗号化されていない HTTP は受け付けません。
キー#
キーはアプリに表示されるプッシュ用リンクの最後の部分で、27 文字です。1 台の端末用は bz_d_、共有グループ用は bz_g_、専用ターゲット用は bz_t_ で始まります。どれも送り方は同じです。
キーでできるのは送信だけで、履歴の閲覧や端末の管理はできません。キーが漏れた場合はアプリでリンクをリセットしてください。古いキーは次のリクエストから無効になるので、自動化の設定を新しいリンクに更新します。
URL で送る#
リンクを開くことしかできないツールでは、本文をパスに入れます。各セグメントは個別にエンコードしてください。たとえばスペースは %20 です。
https://push.breezelabs.dev/YOUR_KEY/Body
https://push.breezelabs.dev/YOUR_KEY/Title/Body
https://push.breezelabs.dev/YOUR_KEY/Title/Subtitle/Body
ほかのパラメーターはクエリ文字列で指定します。
https://push.breezelabs.dev/YOUR_KEY/Deploy%20finished?group=deploys&url=https://example.com
GET https://push.breezelabs.dev/v1/YOUR_KEY?body=Hello も使えます。これらの形式は Bark のスクリプトと互換性があり、ホストとキーを差し替えるだけでそのまま動きます。
POST で送る#
プレーンテキスト、フォームデータ、JSON のいずれかをリンクに POST します。
# Plain text becomes the body
curl https://push.breezelabs.dev/v1/YOUR_KEY -d 'Build passed'
# Form data
curl https://push.breezelabs.dev/v1/YOUR_KEY -d 'title=Build' -d 'body=All checks passed'
# JSON
curl https://push.breezelabs.dev/v1/YOUR_KEY \
-H 'Content-Type: application/json' \
-d '{"title":"Build","body":"All checks passed","group":"ci"}'
キーを URL に含めない#
リンクはプロキシのログ、シェルの履歴、スクリーンショットに残りがちです。頻繁に動く自動化では /v1/send に送り、キーはヘッダーに入れてください。
curl https://push.breezelabs.dev/v1/send \
-H 'Authorization: Bearer YOUR_KEY' \
-H 'Content-Type: application/json' \
-d '{"title":"Backup","body":"Finished in 4 minutes"}'
複数の端末に送る#
device_keys に最大 20 個のキーを並べます。キーが重複しても、各端末には 1 回だけ届きます。
curl https://push.breezelabs.dev/push \
-H 'Content-Type: application/json' \
-d '{"device_keys":["KEY_ONE","KEY_TWO"],"title":"Server","body":"Disk usage is above 90%"}'
iPhone と Android を同じリクエストに含める場合は、両方が対応するパラメーターだけを使ってください。パラメーターのプラットフォーム列をご覧ください。
レスポンスを確認する#
{"code":200,"message":"accepted","request_id":"example-request-id","data":{"accepted":1,"failed":0}}
| ステータス | 意味 |
|---|---|
| 200 | Apple または Google が受け付けました。端末を確認してください |
| 207 | 一部の端末だけが受け付けました。グループ全体に再送しないでください |
| 404 | キーが存在しないか、リセットされています。アプリから現在のリンクをコピーしてください |
| 422 | 送信先のプラットフォームが対応していないパラメーターがあります |
| 429 | リクエストが多すぎます。Retry-After の時間だけ待ってください |
ネットワークのタイムアウトは配信後に起きることもあるため、再試行すると通知が 2 回表示される場合があります。問い合わせの際は request_id を控えてください。すべてのステータスとエラーは API リファレンスにあります。