REST API リファレンス

共通ドキュメント

配信端末登録

配信端末登録APIについて

端末の情報をMobileSUITE mBaaS機能に登録します。
登録された端末は、プッシュ通知の配信対象に加えることが可能になります。

基本仕様

  • APIパス：/installations
  • メソッド：POST

リクエストヘッダー

シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。

フィールド名 内容
Content-Type application/json

リクエストコンテント

パラメータ名 説明 データ型 必須 バリデーション
applicationName アプリケーション名 文字列
appVersion アプリケーションバージョン 文字列
badge バッジ 数値
channels チャネル 配列
deviceToken デバイストークン 文字列 ○
deviceType デバイスの種類 文字列 ○
sdkVersion SDKバージョン 文字列
timeZone タイムゾーン 文字列
acl ACL オブジェクト
- 追加フィールド - フィールド名のフォーマットチェック
（半角英数＋「_」のみ）

deviceTokenは、iOSのdevice tokenか、Androidのregistration idを設定してください。
ACL未指定時の初期値はシステム側であらかじめ設定されているデフォルト値になります。
詳細はACLフォーマットをご覧ください。

上記以外の任意のデータを登録したい場合は、JSON形式で指定してください。
ただし、_idをフィールド名に指定することはできません。

HTTPステータス

ステータスコード 説明
201 登録完了

レスポンスヘッダー

フィールド名 値
Content-Type application/json

レスポンスコンテント

パラメータ名 説明 データ型 備考
createDate 登録日時 日時
objectId オブジェクトID 文字列

リクエストサンプル

curl -v -X POST \
 -H "X-NCMB-Application-Key:b8cfe143fb5e9fb54af2456af6427f05d9a7615f976a7fc1f140db251290941c" \
 -H "X-NCMB-Timestamp:2013-12-08T02:44:35.452Z" \
 -H "X-NCMB-Signature: EZI5/HK0zxoe20t5ctbik4cjg6+Docsas6bqEf/qlcU=" \
 -H "Content-Type: application/json" \
 -d '{"deviceType":"android", "deviceToken":"0bcf3900bd859b6322795b61c0afdd6cc6aa0b2cf97ebcbc5cc37fb521416446"}'\
 https://mbaas.api.nifcloud.com/2013-09-01/installations

レスポンスサンプル

HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8

{"createDate":"2013-08-28T03:03:48.265Z","objectId":"IMa7rxMT1c4AECC"}