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