API

エンドポイント

Service API のエンドポイントのドメインは以下の通りです。 モック環境と本番環境とでサブドメインが異なります。 環境についての説明は環境も参照してください。

環境名	エンドポイントのドメイン
モック環境	https://api.core.mock.p8n.app
本番環境	https://api.core.p8n.app

API ドキュメント

Service API で利用できる機能は、API ドキュメント に記載されています。

例えば、モック環境で指定したユーザーに通知を送信する場合は、以下のようになります。 ユーザーを指定するには、 target_subscription_ids にサブスクリプション ID を指定します。

curl https://api.core.mock.p8n.app/pocketsign.link.v1.ServiceService/CreateNotification \
    -H "Content-Type: application/json;charset=utf-8" \
    -H "Authorization: Bearer <SECRET_KEY>" \
    -d  '{
          "target_subscription_ids": [<SUBSCRIPTION_ID_0>, <SUBSCRIPTION_ID_1>, ...],
          "title_template": "TITLE",
          "message_template": "MESSAGE",
          "button_template": "{
            "version": "1.0",
            "variant": "primary",
            "text": "BUTTON_TEXT"
          }"
         }'

Authorization ヘッダーについては、認証を参照してください。

注意

プッシュ通知を送信する場合は、「プッシュ通知を送るための権限」がサービスに付与されている必要があります。 操作方法はリソース要求を参照してください。