REST API 概要
基本事項
- APIはHTTPおよびREST仕様に準拠して設計されています。例えば、クエリリクエストにはGetメソッドを、送信リクエストにはPOSTメソッドを使用します。リクエストが対応するHTTPメソッドでない場合は、エラーが返されます。
- 特別な説明がない限り、呼び出しパラメータの値はUTF-8でエンコードする必要があります。URLエンコーディングを参照してください。
データセンターとBase URL
2025年3月19日以降、Engagelab Push APIに新しくアクセスする開発者は、以下のドメイン名を使用してください。従来の.cc接尾辞のBase URLは引き続き使用可能ですが、最新のドメイン名への切り替えを推奨します。
| データセンター | Base URL |
|---|---|
| シンガポール | https://webpushapi-sgp.engagelab.com |
| 香港 | https://webpushapi-hk.engagelab.com |
REST APIを使用する場合は、選択したbase URLと特定のAPIパスを組み合わせて、完全なエンドポイントを取得する必要があります。
{base URL}/{API path}
ここで、{base URL}は選択したデータセンターのbase URLを表し、{API path}は特定のAPIエンドポイントパス（例：v4/devices/{registration_id}）を表します。
例：
- シンガポールデータセンターを選択し、base URLが
https://webpushapi-sgp.engagelab.comであるとします。 - 特定のデバイスの登録情報を削除する場合、APIパスが
v4/devices/{registration_id}であれば、完全なAPIエンドポイントは以下のようになります：
https://webpushapi-sgp.engagelab.com/v4/devices/{registration_id}
ここで、{registration_id}は特定のデバイスの登録IDを表します。
この方法を使用して、異なるデータセンターにアクセスするための完全なAPIエンドポイントURLを構築できます。
認証方法
Engagelab REST APIはHTTP基本認証を使用しています。 基本的な方法は、HTTPヘッダー（Header）にAuthorizationフィールドを追加することです：
Authorization: Basic base64_auth_string
base64_auth_stringの生成アルゴリズムはbase64(appKey:masterSecret)です。
すなわち、appKeyにコロンを付け、masterSecretを追加して文字列を組み立てた後、base64変換を実行します。
appKeyとmasterSecretのパラメータは、アプリケーション設定-アプリケーション情報ページで取得できます。
認証例
appKeyが「c96f42e0d2e662e45d035ab1」で、masterSecretが「df4d59e84eac2f9d53b36f12」の場合、Push API v4を呼び出すときのcurlコマンドは以下のようになります：
curl --insecure -X POST -v https://webpushapi-sgp.engagelab.com/v4/push
-H "Content-Type: application/json"
-u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12"
-d '{"from":"push","to":"all","body":{"platform":"web","notification":{"alert":"Hi,MTPush !","web":{"alert":"Hi,MTPush !", "title":"web_push", "url":"http://www.google.com","extras":{"web-key1":"web-value1"}}}},"request_id":"12345678", "custom_args":"business info"}'
HTTPリクエストは以下のようになります：
> POST /v4/push HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==
