プッシュ通知
端末へのプッシュ通知の API。ブラウザの Web Push やアプリの登録トークンを登録・解除し、種類ごとの受け取り設定を読み書きする。試しの通知を送ることもできる。
この分類のあらまし
- 誰が呼べるか
ログインした本人の端末。公開鍵を読む入口だけはログインなしで呼べる。
ログイン 6 件・認証なし 1 件
- 件数と印
この分類の API は 7 件
- 契約での分類の説明
プッシュ通知
よく使う順番
上から順に呼ぶことが多い組み合わせ。行を押すと、その API の詳細が右に開く(スマホは下から)。
すべての API7 件
この分類の API をすべて並べている。行を押すと、頁を移らずにその API の詳細が右に開き、送るもの・返るもの・呼び出しの見本が読める。閉じると一覧の同じ位置に戻る。
行の左の札は HTTP のメソッド。GET は情報の取得、POST は作成や操作の実行、PUT と PATCH は更新、DELETE は削除を表す。
- VAPID 公開鍵(無効な環境では enabled=false と理由)GET取得
/api/push/public-key認証なし - ネイティブのシェル(iOS / Android)の FCM 登録トークンを登録する(同じトークンは持ち主を付け替える)POST作成・操作
/api/push/nativeログイン - この端末の Web Push 購読を登録する(PushSubscription.toJSON()。endpoint は https + 既知のプッシュサービスだけ)POST作成・操作
/api/push/subscribeログイン - この端末の購読を消す(自分の購読だけ)POST作成・操作
/api/push/unsubscribeログイン - 自分の有効な購読へ試しの通知を送るPOST作成・操作
/api/push/testログイン - 受け取り設定(種類ごと。既定はすべて on)・「通知に内容を表示」(既定 on)と登録済みの端末GET取得
/api/push/preferencesログイン - 受け取り設定を変える(書いた種類と「通知に内容を表示」だけ)PATCH一部を更新
/api/push/preferencesログイン