サーバ側のAPI

サーバ側のAPIの概要を以下に示します。サーバ側のAPIはWeb APIで、送受信のデータ形式はJSONです。詳細は付録A プッシュ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のデバイストークン、アプリケーション名、サンドボックスを登録、または更新。
WNSのチャネルURI登録、更新	POST	wnsRegID	WNSのチャネルURI、アプリケーション名の情報を登録、または更新。
GCMのregistrationID登録、更新	POST	gcmRegID	GCMのregistrationID、GCMのアプリケーション名の情報を登録、または更新。
メッセージ送信	POST	notify	指定した宛先に対して、メッセージを送信。
共通メッセージの送信	POST	notifyCommon	指定した宛先に対して、共通のメッセージを送信。
蓄積メッセージ参照	GET	refSvrMsg	サーバに蓄積しているメッセージを参照。
メッセージ情報の取得	POST	getMsgByMsgID	メッセージIDが示すメッセージ情報を取得します。
メッセージ情報の取得	POST	getMsgByRegID	登録IDが示すメッセージ情報を取得します。
既読件数の取得	POST	readCount	送信済のメッセージの総件数と既読件数を取得します。

プッシュ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_AHS_PUSH_PORTの値。
＜機能パス＞: Web API名。

アプリケーション管理者によるアクセス制御は、"運用ガイド"の"アプリケーション管理者によるアクセス制御"を参照してください。

6.4.1 サーバ側のAPI