APIを利用して、特定のユーザーにWEBプッシュを送信する方法

このマニュアルでは、PUSHCODEのAPIを利用して、都度異なる内容の通知を特定のユーザーに送信する場合の例をご説明いたします。

1. useridの付与

PUSHCODE導入時に設定頂く通知許諾タグの中で、useridを指定頂けます。

指定頂くuseridはサイト側で管理しているIDです。

下記のように、PushCode.initでuseridにユーザーを特定する任意の値を指定してください。

window.addEventListener('load', function() {
  try {
    if (PushCode && PushCode.isSupport()) {
      PushCode.init({ domainToken: 'サイト毎に異なるTokenが発行されます', userid: 'user001' });
      if (PushCode.components) {
        PushCode.components.openSubscribeDialog();
      } else {
        PushCode.requestPermission();
      }
    }
  }
  catch (err) {
    console.error(err);
  }
});

2. プッシュ通知作成

API利用のプッシュ通知作成

新規プッシュ作成ページでWho/When/Whatの項目をAPI指定にして登録する事で、APIで利用可能なプッシュ通知を作成することが出来ます。

プッシュ通知配信APIを利用してプッシュ通知を送信する際に、Who/When/Whatの値を指定します。

Whatの項目には画像、タイトル、本文、リンク先のURLがあります。これらをAPIで動的に指定するためには、各項目にkeyとなる値を入力します。以下のキャプチャでは、例として{{icon}}、{{title}}、{{body}}、{{url}}を入力しています。

「{{body}}のお知らせ」のように固定文字と組み合わせることも可能です。

APIエンドポイントの取得

作成したプッシュ通知をプッシュ通知リストから選択すると、APIエンドポイントを確認できます。プッシュ通知配信APIでこちらのエンドポイントを利用します。

3. プッシュ通知配信API

[POST] /push/{api_token}

プッシュ通知を送信するAPIです。

APIの詳細は下記リンクのドキュメントをご参照ください。

https://www.pushcode.jp/documentation/#operation/pushSend

API指定で作成したプッシュ通知を配信するためには、API指定プッシュ通知毎のユニークエンドポイントが必要になります。PUSHCODE管理画面の「プッシュ通知」ページから取得した「{api_token}」を含むユニークエンドポイントを利用します。

プッシュ通知配信API実装時に、下記のようにWho/When/Whatの値を指定します。

REQUEST BODY SCHEMAの例

即時配信で複数ユーザーにプッシュ通知を送信する場合の例です。

{
"when": {
  "immediate": true
},
"who": {
  "userid_list": [
    "user001",
    "user002",
    "user003"
    ]
  },
"what": {
  "vars": {
    "{{icon}}": "https://www.pushcode.jp/static/img/top/logo.svg",
    "{{title}}": "プッシュ通知API",
    "{{body}}": "APIを利用したプッシュ通知のサンプルです。",
    "{{url}}": "https://www.pushcode.jp/"
    }
  }
}

以上、APIの基本的な利用ケースを紹介いたしました。これらを活用し、より効果的な運用を実現していただけることを願っております。

ご不明な点や疑問点がございましたら、いつでもお問い合わせください。我々スタッフ一同、全力でサポートさせていただきます。