7.1. アプリケーション作成

POST /1/_sysadm/(tenantId)/apps

アプリケーションを作成する

Request Headers:
 
  • X-Developer-Token -- 管理者用セッショントークン（必須）
  • Content-Type -- application/json, application/yaml のいずれか
Parameters:
  • tenantId (string) -- テナントID
Status Codes:
Response JSON Object:
 
  • app._id (string) -- アプリケーションID
  • app.name (string) -- アプリケーション名
  • app.appKey (string) -- アプリケーションキー
  • app.masterKey (string) -- マスターキー
  • app.description (string) -- 説明文
  • app.enabled (boolean) -- アプリケーションの有効フラグ
  • app.gcmKey (string) -- GCM/FCM キー
  • app.allowClientPush (boolean) -- クライアント Push 許可フラグ

リクエストボディ

JSONもしくはYAML形式で記述されたアプリケーション設定を指定する。

YAML形式によるリクエストの例を以下に示す。

app:
  name: app01
  description: app01
  appKey: kkXPlgXdKMbI549ebFapDc37pzhXtj5qRsaqikLF
  masterKey: 9YGU3JgrCBYH8FAzmot3zMgJM1lJAAqf7voqXwQI
  enabled: true
  gcmKey: ''
  allowClientPush: false

以下に設定可能なプロパティを示す。

プロパティ 名称 デフォルト値 レスポンス
_id アプリケーションID サーバ側で採番される 表示
name アプリケーション名 必須 表示
appKey アプリケーションキー サーバ側で採番される 表示
masterKey マスターキー サーバ側で採番される 表示
description 説明文 空 表示
enabled アプリケーションの有効フラグ true 表示
gcmKey GCM/FCMキー 空 表示
allowClientPush クライアントPush許可フラグ false 表示

レスポンスボディ

作成したアプリケーション情報を含む JSON データが返却される。

以下に例を示す。

{
  "app": {
    "_id": "52116f01ac521e1742000003",
    "name": " app01",
    "description": "app01",
    "appKey": "kkXPlgXdKMbI549ebFapDc37pzhXtj5qRsaqikLF",
    "masterKey": "9YGU3JgrCBYH8FAzmot3zMgJM1lJAAqf7voqXwQI",
    "enabled": true,
    "gcmKey": "",
    "allowClientPush": false
  }
}

注意事項

  • システム管理者権限が必要。
  • アプリケーション名は必須フィールドである。
  • 必須フィールド以外のフィールド省略時は、デフォルト値を設定する。