サーバ側のAPIの概要を以下に示します。サーバ側のAPIはWeb APIで、送受信のデータ形式はJSONです。詳細は「付録B プッシュWeb API」を参照してください。
API名 | メソッド | 機能パス (Web API名) | 意味 |
|---|---|---|---|
登録IDの一覧取得 | POST | regIDs | 登録IDの一覧を取得します。 |
登録ID情報の取得 | POST | regID | 登録ID情報を取得します。 |
登録IDの削除 | POST | delRegIDs | 指定した登録IDを削除します。 |
メッセージ送信 | POST | notify | 指定した宛先に対して、メッセージを送信します。 |
蓄積メッセージ参照 | GET | refSvrMsg | サーバに蓄積しているメッセージを参照します。 |
プッシュWeb APIは、アプリケーション管理者によるアクセス制御を使用します。
そのため、プッシュWeb APIを使用するアプリケーションは、HTTPヘッダにIMAPS-Authorizationキーを設定する必要があります。IMAPSとして認証する/しないの動作に連動して、プッシュの認証も動作します。
IMAPS-Authorizationキーには、以下の内容を設定してください。IMAPS-Authorizationキーに指定するユーザーID、パスワードは、adminuser createコマンドで作成したユーザーを指定してください。
IMAPS-Authorization: Basic ユーザー ID:パスワード |
下線部はBase64でエンコードしてください。
HTTPリクエストのURLの形式は以下のとおりです。
http(s)://<IMAPSサーバ>:<ポート番号>/pushidmng/機能パス |
<IMAPSサーバ>:
IMAPSサーバのFQDNまたはIPアドレス
<ポート番号>：
プッシュアプリで使用するApacheのリスナーポート
「IMAPSサーバ用パラメタ(imsetup_srv.properties)」のIM_PUSH_AHS_PORTの値
＜機能パス＞：
Web API名
アプリケーション管理者によるアクセス制御については、「運用ガイド」の「アプリケーション管理者によるアクセス制御」を参照してください。
