第2章 モバイルアプリ管理 API

2.1. アプリストアの読み込み

2.1.1. 説明

アプリストアの詳細を読み込みます。

2.1.2. エンドポイント

  • URI: /box/srv/1.1/admin/appstore/read
  • メソッド: POST

2.1.3. リクエストボディー

該当なし

2.1.4. レスポンスボディー

2.1.4.1. 成功

{
  "status": "ok",
  "guid": "<app_store_global_unique_id>",
  "name": "<app_store_name>",
  "description": "<app_store_description>",
  "icon":"<base64_String>"
  "storeitems": ["store_item_global_unique_id_1", "store_item_global_unique_id_2", ... "store_item_global_unique_id_N"],
  "authpolicies":["active_policy_ids"]
}

2.1.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.2. App Store の更新

2.2.1. 説明

アプリストアの詳細を読み込みます。

2.2.2. エンドポイント

  • URI: /box/srv/1.1/admin/appstore/update
  • メソッド: POST

2.2.3. リクエストボディー

{
  "name": "<app_store_name>", /*optional*/
  "description": "<app_store_description>" /*optional*/
  "storeitems":["store_item_global_unique_id_1"] /*optional*/
  "authpolicies":[policy_ids]
}

2.2.4. レスポンスボディー

2.2.4.1. 成功

{
  "status": "ok",
  "guid": "<app_store_global_unique_id>",
  "name": "<app_store_name>",
  "description": "<app_store_description>"
  "icon":"<base64_string>"
  "storeitems": ["store_item_global_unique_id_1", "store_item_global_unique_id_2", ... "store_item_global_unique_id_N"],
  "authpolicies":[active_policy_ids]
}

2.2.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.3. ストアアイテムのアプリストアへの追加

2.3.1. 説明

既存のストアアイテムをストアに追加し、ストア内で表示できるようにします。

2.3.2. エンドポイント

  • URI: /box/srv/1.1/admin/appstore/additem
  • メソッド: POST

2.3.3. リクエストボディー

{"guid":"<unique_store_item_id>"}

2.3.4. レスポンスボディー

2.3.4.1. 成功

{
  "status":"ok"
}

2.3.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.4. ストアアイテムのアプリストアからの削除

2.4.1. 説明

既存のストアアイテムをストアから削除し、ストア内で非表示にします。

2.4.2. エンドポイント

  • URI: /box/srv/1.1/admin/appstore/removeitem
  • メソッド: POST

2.4.3. リクエストボディー

{"guid":"<unique_store_item_id>"}

2.4.4. レスポンスボディー

2.4.4.1. 成功

{
  "status":"ok"
}

2.4.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.5. アプリストアアイコンのアップロード

2.5.1. 説明

ストアのアイコンを追加します。

2.5.2. エンドポイント

  • URI: /box/srv/1.1/admin/appstore/uploadbinary
  • メソッド: POST

2.5.3. リクエストボディー

イメージの multipart リクエスト

2.5.4. レスポンスボディー

2.5.4.1. 成功

{
  "status": "ok",
  "guid": "<app_store_global_unique_id>",
  "name": "<app_store_name>",
  "description": "<app_store_description>"
  "icon":"<base64_string>"
  "storeitems": ["store_item_global_unique_id_1", "store_item_global_unique_id_2", ... "store_item_global_unique_id_N"],
  "authpolicies":[active_policy_ids]
}

2.5.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.6. ストアアイテムのアプリストアへの一覧表示

2.6.1. 説明

現在のアイテムをアプリストアに一覧表示します。「バイナリー」フィールドは、バイナリーオプションに定義されます。

2.6.2. エンドポイント

  • URI: /box/srv/1.1/admin/appstore/liststoreitems
  • メソッド: POST

2.6.3. リクエストボディー

{}

2.6.4. レスポンスボディー

2.6.4.1. 成功

{
  "list": [
    {
      "authToken": "<unique id for auth>",
      "authpolicies": [unique_policy_ids],
      "binaries": [
        {
          "config": {
                      "bundle_id": "<ios_bundle_id>"
          },
          "storeItemBinaryVersion": 2,
          "sysModified": "Fri Nov 02 10:06:48 GMT 2012",
          "type": "iphone | android | ios | ipad",
          "url": "http://<domain>/box/srv/1.1/mas/storeitem/install?guid=dweFfHihI616y67aQB4sNGQt",
          "versions": [{
                      "config": {},
                      "destinationCode": "iphone | android | ios | ipad",
                      "storeItemBinaryGuid": "Y8a8lFjFufZyqd1tAdjonufw",
                      "storeItemBinaryModified": "Fri Nov 02 10:44:45 GMT 2012",
                      "storeItemBinaryVersion": 1,
                      "url": "http://<domain>/box/srv/1.1/mas/storeitem/downloadvers?guid=o1Z1S_t-hyGMXymqTzIWS4xd"
          }]
        }
      ],
      "description": "description",
      "guid": "<unique_id>",
      "icon": "<base64_string>",
      "name": "<string_item_name>"
    }
  ],
  "status": "ok"
}

2.6.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.6.5. オプション

2.6.5.1. バイナリーフィールド

バイナリーフィールドは、現在アップロードされているストアアイテムバイナリーについての情報の配列です。以下で構成されています。

  • config: 追加の OS 関連の設定についてのフィールドです (例: ios バンドル id)。
  • storeItemBinaryVersion: 現在のストアアイテムバイナリーのバージョン番号です。
  • sysModified: このストアアイテムバイナリーの最終修正日です。
  • type: ストアアイテムバイナリーのタイプです。
  • url: この URL を使用して、このストアアイテムバイナリーの最新バージョンをダウンロードできます。
  • versions: 古いストアアイテムバイナリーを含む配列です (最大 4 エントリーが保持されます)。

2.7. 認証ポリシーの追加

2.7.1. 説明

アプリストアで使用される認証ポリシーを追加します。

2.7.2. エンドポイント

  • URI: /box/srv/1.1/admin/appstore/addpolicy
  • メソッド: POST

2.7.3. リクエストボディー

{
  "guid":"<policy_id>"
}

2.7.4. レスポンスボディー

2.7.4.1. 成功

{
  "status": "ok"
}

2.7.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.8. ストア認証ポリシーの削除

2.8.1. 説明

アプリストアで使用される認証ポリシーを削除します。

2.8.2. エンドポイント

  • URI: /box/srv/1.1/admin/appstore/removepolicy
  • メソッド: POST

2.8.3. リクエストボディー

{
  "guid":"<policy_id>"
}

2.8.4. レスポンスボディー

2.8.4.1. 成功

{
  "status": "ok"
}

2.8.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.9. 認証ポリシーの一覧表示

2.9.1. 説明

アプリストアに割り当てられたポリシーを一覧表示します。

2.9.2. エンドポイント

  • URI: /box/srv/1.1/admin/appstore/listpolicies
  • メソッド: POST

2.9.3. リクエストボディー

{}

2.9.4. レスポンスボディー

2.9.4.1. 成功

{
  "list": [
    "ORF5SiIH623yYmBD1ftlFOA4"
  ],
  "status": "ok"
}

2.9.4.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.10. アプリストアアイテムの作成

2.10.1. 説明

アプリストアアイテムを作成します。

2.10.2. エンドポイント

  • URI: /box/srv/1.1/admin/storeitem/create
  • メソッド: POST
注記

アイコンはアイテムの作成後にアップロードされます。アイテムはアイコンがない状態で作成されます。

2.10.3. リクエストボディー

  {
    "name" : String,
    "description": String <optional>,
    "authToken":String <optional>
  }

2.10.4. レスポンスボディー

{
  "status": "ok",
    "guid": "<app_store_global_unique_id>",
    "name": "<app_store_name>",
    "description": "<app_store_description>",
    "authToken": "<unique_token_used_by_client_to_autheticate>",
    "icon": "<base_64_encoded_icon_data>",
    "binaries": [
      {
        "config": {
          "bundle_id": "<ios_bundle_id>"
        },
        "storeItemBinaryVersion": 2,
        "sysModified": "Fri Nov 02 10:06:48 GMT 2012",
        "type": "iphone | android | ios | ipad",
        "url": "http://<domain>/box/srv/1.1/mas/storeitem/install?guid=dweFfHihI616y67aQB4sNGQt",
        "versions": [{
            "config": {},
            "destinationCode": "iphone | android | ios | ipad",
            "storeItemBinaryGuid": "Y8a8lFjFufZyqd1tAdjonufw",
            "storeItemBinaryModified": "Fri Nov 02 10:44:45 GMT 2012",
            "storeItemBinaryVersion": 1,
            "url": "http://<domain>/box/srv/1.1/mas/storeitem/downloadvers?guid=o1Z1S_t-hyGMXymqTzIWS4xd"
          }]
      }
  ],
  "authpolicies": [<unique_policy_id>],
  "restrictToGroups": true|false,
  "groups": ["<store_item_group_id>",...]
}

2.10.4.1. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.11. アプリストアアイテムの読み込み

2.11.1. 説明

ストアアイテムの詳細を読み込みます。

2.11.2. エンドポイント

  • URI: /box/srv/1.1/admin/storeitem/read
  • メソッド: POST

2.11.3. リクエストボディー

{
  "guid":String
}

2.11.3.1. レスポンスボディー

{
  "status": "ok",
  "guid": "<app_store_global_unique_id>",
  "name": "<app_store_name>",
  "description": "<app_store_description>",
  "authToken": "<unique_token_used_by_client_to_autheticate>",
  "icon": "<base_64_encoded_icon_data">,
  "binaries": [
    {
      "config": {
        "bundle_id": "<ios_bundle_id>"
      },
        "storeItemBinaryVersion": 2,
        "sysModified": "Fri Nov 02 10:06:48 GMT 2012",
        "type": "iphone | android | ios | ipad",
        "url": "http://<domain>/box/srv/1.1/mas/storeitem/install?guid=dweFfHihI616y67aQB4sNGQt",
        "versions": [{
          "config": {},
          "destinationCode": "iphone | android | ios | ipad",
          "storeItemBinaryGuid": "Y8a8lFjFufZyqd1tAdjonufw",
          "storeItemBinaryModified": "Fri Nov 02 10:44:45 GMT 2012",
          "storeItemBinaryVersion": 1,
          "url": "http://<domain>/box/srv/1.1/mas/storeitem/downloadvers?guid=o1Z1S_t-hyGMXymqTzIWS4xd"
        }]
    }],
  "authpolicies": [<unique_policy_id>],
  "restrictToGroups": true|false,
  "groups": [<store_item_group_id>]
}

2.11.3.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.12. アイテムの更新

2.12.1. エンドポイント

  • /box/srv/1.1/admin/storeitem/update
  • メソッド: POST

2.12.2. リクエストボディー

{
  "name": String,
  "description": String,
  "authToken": String,
  "restrictToGroups": true|false // optional - will not change if not set
}

2.12.3. レスポンスボディー

{
  "status": "ok",
  "guid": "<app_store_global_unique_id>",
  "name": "<app_store_name>",
  "description": "<app_store_description>",
  "authToken": "<unique_token_used_by_client_to_autheticate>",
  "icon": "<base_64_encoded_icon_data>",
  "binaries": [
    {
      "config": {
        "bundle_id": "<ios_bundle_id>"
      },
        "storeItemBinaryVersion": 2,
        "sysModified": "Fri Nov 02 10:06:48 GMT 2012",
        "type": "iphone | android | ios | ipad",
        "url": "http://<domain>/box/srv/1.1/mas/storeitem/install?guid=dweFfHihI616y67aQB4sNGQt",
        "versions": [{
          "config": {},
          "destinationCode": "iphone | android | ios | ipad",
          "storeItemBinaryGuid": "Y8a8lFjFufZyqd1tAdjonufw",
          "storeItemBinaryModified": "Fri Nov 02 10:44:45 GMT 2012",
          "storeItemBinaryVersion": 1,
          "url": "http://<domain>/box/srv/1.1/mas/storeitem/downloadvers?guid=o1Z1S_t-hyGMXymqTzIWS4xd"
        }]
    }],
  "authpolicies": [<unique_policy_id>],
  "restrictToGroups": true|false,
  "groups": ["<store_item_group_id>",...]
}

2.12.3.1. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.13. アプリストアアイテムの削除

2.13.1. エンドポイント

  • /box/srv/1.1/admin/storeitem/delete
  • メソッド: POST

2.13.2. リクエストボディー

{
  "guid" : "unique store item id"
}

2.13.3. レスポンスボディー

{
  "status":"ok"
}

2.13.3.1. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.14. アプリストアアイテムの一覧表示

2.14.1. 説明

アプリストアのアイテムを一覧表示します。

2.14.2. エンドポイント

  • URI: /box/srv/1.1/admin/storeitem/list
  • メソッド: POST

2.14.3. リクエストボディー

  {}

2.14.4. レスポンスボディー

{
  "status": "ok",
  "list":[
    {
      "guid": "<app_store_global_unique_id>",
      "name": "<app_store_name>",
      "description": "<app_store_description>",
      "authToken": "<unique_token_used_by_client_to_autheticate>",
      "icon": "<base_64_encoded_icon_data>",
      "binaries": [
      {
        "config": {
          "bundle_id": "<ios_bundle_id>"
        },
        "storeItemBinaryVersion": 2,
        "sysModified": "Fri Nov 02 10:06:48 GMT 2012",
        "type": "iphone | android | ios | ipad",
        "url": "http://<domain>/box/srv/1.1/mas/storeitem/install?guid=dweFfHihI616y67aQB4sNGQt",
          "versions": [{
            "config": {},
            "destinationCode": "iphone | android | ios | ipad",
            "storeItemBinaryGuid": "Y8a8lFjFufZyqd1tAdjonufw",
            "storeItemBinaryModified": "Fri Nov 02 10:44:45 GMT 2012",
            "storeItemBinaryVersion": 1,
            "url": "http://<domain>/box/srv/1.1/mas/storeitem/downloadvers?guid=o1Z1S_t-hyGMXymqTzIWS4xd"
          }]
      }],
      "authpolicies": [<unique_policy_id>],
      "restrictToGroups": true|false,
      "groups": ["<store_item_group_id>",...]
    }
  ]
}

2.14.4.1. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.15. バイナリーのアップロード

2.15.1. エンドポイント

  • /box/srv/1.1/admin/storeitem/uploadbinary
  • メソッド: POST
  • multipart リクエストとして送信されるファイル

2.15.2. リクエストボディー

{
  "guid":"String",
  "type":"<icon|ios|ipad|iphone|android>"
}

2.15.3. レスポンス

{
  "status": "ok"
  "list":[
    {
      "guid": "<app_store_global_unique_id>",
      "name": "<app_store_name>",
      "description": "<app_store_description>",
      "authToken": "<unique_token_used_by_client_to_autheticate>",
      "icon": "<base_64_encoded_icon_data>",
      "binaries": [
      {
        "config": {
          "bundle_id": "<ios_bundle_id>"
        },
        "storeItemBinaryVersion": 2,
        "sysModified": "Fri Nov 02 10:06:48 GMT 2012",
        "type": "iphone | android | ios | ipad",
        "url": "http://<domain>/box/srv/1.1/mas/storeitem/install?guid=dweFfHihI616y67aQB4sNGQt",
          "versions": [{
            "config": {},
            "destinationCode": "iphone | android | ios | ipad",
            "storeItemBinaryGuid": "Y8a8lFjFufZyqd1tAdjonufw",
            "storeItemBinaryModified": "Fri Nov 02 10:44:45 GMT 2012",
            "storeItemBinaryVersion": 1,
            "url": "http://<domain>/box/srv/1.1/mas/storeitem/downloadvers?guid=o1Z1S_t-hyGMXymqTzIWS4xd"
          }]
      }],
      "authpolicies": [<unique_policy_id>],
      "restrictToGroups": true|false,
      "groups": ["<store_item_group_id>",...]
    }
  ]
}

2.15.3.1. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.16. 認証ポリシーの追加

2.16.1. エンドポイント

  • /box/srv/1.1/admin/storeitem/addpolicy
  • メソッド: POST

2.16.2. リクエストボディー

{
  "guid":"<store_item_id>",
  "authguid":"<policy_id>"
}

2.16.3. レスポンスボディー

{
  "status": "ok",
  "list":[
    {
      "guid": "<app_store_global_unique_id>",
      "name": "<app_store_name>",
      "description": "<app_store_description>",
      "authToken": "<unique_token_used_by_client_to_autheticate>",
      "icon": "<base_64_encoded_icon_data>",
      "binaries": [
      {
        "config": {
          "bundle_id": "<ios_bundle_id>"
        },
        "storeItemBinaryVersion": 2,
        "sysModified": "Fri Nov 02 10:06:48 GMT 2012",
        "type": "iphone | android | ios | ipad",
        "url": "http://<domain>/box/srv/1.1/mas/storeitem/install?guid=dweFfHihI616y67aQB4sNGQt",
          "versions": [{
            "config": {},
            "destinationCode": "iphone | android | ios | ipad",
            "storeItemBinaryGuid": "Y8a8lFjFufZyqd1tAdjonufw",
            "storeItemBinaryModified": "Fri Nov 02 10:44:45 GMT 2012",
            "storeItemBinaryVersion": 1,
            "url": "http://<domain>/box/srv/1.1/mas/storeitem/downloadvers?guid=o1Z1S_t-hyGMXymqTzIWS4xd"
          }]
      }],
      "authpolicies": [<unique_policy_id>],
      "restrictToGroups": true|false,
      "groups": ["<store_item_group_id>",...]
    }
  ]
}

2.16.3.1. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.17. ストアアイテム認証ポリシーの削除

2.17.1. エンドポイント

  • /box/srv/1.1/admin/storeitem/removepolicy
  • メソッド: POST

2.17.2. リクエストボディー

{
  "guid":"<store_item_id>",
  "authguid":"<policy_id>"
}

2.17.3. レスポンスボディー

{
  "status": "ok"
  "list":[
    {
      "guid": "<app_store_global_unique_id>",
      "name": "<app_store_name>",
      "description": "<app_store_description>",
      "authToken": "<unique_token_used_by_client_to_autheticate>",
      "icon": "<base_64_encoded_icon_data>",
      "binaries": [
      {
        "config": {
          "bundle_id": "<ios_bundle_id>"
        },
        "storeItemBinaryVersion": 2,
        "sysModified": "Fri Nov 02 10:06:48 GMT 2012",
        "type": "iphone | android | ios | ipad",
        "url": "http://<domain>/box/srv/1.1/mas/storeitem/install?guid=dweFfHihI616y67aQB4sNGQt",
          "versions": [{
            "config": {},
            "destinationCode": "iphone | android | ios | ipad",
            "storeItemBinaryGuid": "Y8a8lFjFufZyqd1tAdjonufw",
            "storeItemBinaryModified": "Fri Nov 02 10:44:45 GMT 2012",
            "storeItemBinaryVersion": 1,
            "url": "http://<domain>/box/srv/1.1/mas/storeitem/downloadvers?guid=o1Z1S_t-hyGMXymqTzIWS4xd"
          }]
      }],
      "authpolicies": [<unique_policy_id>],
      "restrictToGroups": true|false,
      "groups": ["<store_item_group_id>",...]
    }
  ]
}

2.17.3.1. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.18. バイナリー設定の取得

2.18.1. エンドポイント

  • /box/srv/1.1/admin/storeitem/getbinaryconfig
  • メソッド POST | GET

2.18.2. リクエストボディー

{
  "guid":"<store_item_guid>",
  "type":"<ios|ipad|iphone|android>"
}

2.18.3. レスポンス

{
  "status":"ok"
  "guid":"<store_item_guid>",
  "type": "<ios|iphone|ipad|android>",
  "config": {
    "<config_key>": "<config_value>"
  }
}

2.18.3.1. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.19. バイナリー設定の実行

2.19.1. エンドポイント

  • /box/srv/1.1/admin/storeitem/setbinaryconfig
  • メソッド: POST

2.19.2. リクエストボディー

{
  "guid":"<store_item_guid>",
  "type":"<ios|ipad|iphone|android>",
  "config": {
    "<config_key>": "<config_value>"
   }
 }

2.19.3. レスポンス

{
  "status":"ok"
  "guid":"<store_item_guid>",
  "type": "<ios|iphone|ipad|android>",
  "config": {
    "<config_key>": "<config_value>"
  }
}

2.19.4. エラー

2.19.4.1. 発生する可能性のあるエラーメッセージ:

  • invalid_type
  • invalid_guid

2.20. ストアアイテムグループの追加

2.20.1. エンドポイント

  • /box/srv/1.1/admin/storeitem/addgroups
  • メソッド: POST

2.20.2. リクエストボディー

{
  "guid":"<store_item_id>",
  "groups": ["<store_item_group_id>",...]
}

2.20.3. レスポンスボディー

{
  "status": "ok",
  "list":[
    {
      "guid": "<app_store_global_unique_id>",
      "name": "<app_store_name>",
      "description": "<app_store_description>",
      "authToken": "<unique_token_used_by_client_to_autheticate>",
      "icon": "<base_64_encoded_icon_data>",
      "binaries": [
      {
        "config": {
          "bundle_id": "<ios_bundle_id>"
        },
        "storeItemBinaryVersion": 2,
        "sysModified": "Fri Nov 02 10:06:48 GMT 2012",
        "type": "iphone | android | ios | ipad",
        "url": "http://<domain>/box/srv/1.1/mas/storeitem/install?guid=dweFfHihI616y67aQB4sNGQt",
          "versions": [{
            "config": {},
            "destinationCode": "iphone | android | ios | ipad",
            "storeItemBinaryGuid": "Y8a8lFjFufZyqd1tAdjonufw",
            "storeItemBinaryModified": "Fri Nov 02 10:44:45 GMT 2012",
            "storeItemBinaryVersion": 1,
            "url": "http://<domain>/box/srv/1.1/mas/storeitem/downloadvers?guid=o1Z1S_t-hyGMXymqTzIWS4xd"
          }]
      }],
      "authpolicies": [<unique_policy_id>],
      "restrictToGroups": true|false,
      "groups": ["<store_item_group_id>",...]
    }
  ]
}

2.20.3.1. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.21. ストアアイテムグループの削除

2.21.1. エンドポイント

  • /box/srv/1.1/admin/storeitem/removegroups
  • メソッド: POST

2.21.2. リクエストボディー

{
  "guid":"<store_item_id>",
  "groups": ["<store_item_group_id>",...]
}

2.21.3. レスポンスボディー

{
  "guid": "<app_store_global_unique_id>",
  "name": "<app_store_name>",
  "description": "<app_store_description>",
  "authToken": "<unique_token_used_by_client_to_autheticate>",
  "icon": "<base_64_encoded_icon_data">,
  "binaries": [
    {
      "type": "<ios|iphone|ipad|android>",
      "url": "<url_to_app_binary">
    }
  ],
  "authpolicies": [<unique_policy_id>],
  "restrictToGroups": true|false,
  "groups": ["<store_item_group_id>",...]
}

2.21.3.1. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.22. 監査ログエントリーの一覧表示

2.22.1. 説明

監査ログエントリーの一覧表示を取得します。

2.22.2. エンドポイント

  • URI: /box/srv/1.1/admin/auditlog/listlogs
  • メソッド: POST | GET

2.22.3. 認証

制限: ヘッダーとしてセッション ID (sessionId) が必要です。 

X-FH-AUTH-SESSION: "<sessionId_returned_from_fh.auth_call>"

2.22.4. リクエストボディー

{
  "userId":"<unique user guid>",
  "storeItemGuid":"<store_item_global_unique_id>",
  "storeItemBinaryType":"ios | iphone | ipad | android",
  "limit":"10 | 100 | 1000"
}

2.22.5. レスポンスボディー

2.22.5.1. 成功

{
  "status": "ok",
  "list": [{
    "deviceId":"<device_global_unique_id>",
    "domain":"<domain name>",
    "guid":"<audit_log_entry_global_unique_id>_RA2E11wCdS>",
    "ipAddress":"<downloading host ip address>",
    "storeItemBinaryGuid":"<store item binary guid>",
    "storeItemBinaryType":"<store item binary type>",
    "storeItemBinaryVersion":"<store item binary version>",
    "storeItemGuid":"<store_item_global_unique_id>",
    "storeItemTitle":"<store item title>",
    "sysCreated":"<audit log creation time>",
    "sysVersion":"<version>",
    "userGuid":"<user guid>",
    "userId":"<user_friendly_id>"
  },
  /* ... */
  ]
}

2.22.5.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}
2.22.5.2.1. 発生する可能性のあるエラーメッセージ:
  • invalid_type

2.23. アプリストアの読み込み

2.23.1. 説明

名前、説明、アイコンおよびサポートされる認証ポリシーなど、アプリストアの詳細を読み込みます。

2.23.2. エンドポイント

  • URI: /box/srv/1.1/mas/appstore/read
  • メソッド: POST | GET

2.23.3. 認証

オープン: 認証なしで呼び出すことができるパブリックエンドポイントです。

2.23.4. リクエストボディー

該当なし

2.23.5. レスポンスボディー

2.23.5.1. 成功

{
  "status": "ok",
  "guid": "<app_store_global_unique_id>",
  "name": "<app_store_name>",
  "description": "<app_store_description>",
  "icon" : "<base64_encoded_representation_of_app_store_icon>"
  "authpolicies": [
    {
      "name": "<auth_policy_name_1>",
      "type": "<auth_policy_type_1>"
    },
    {
      "name": "<auth_policy_name_2>",
      "type": "<auth_policy_type_2>"
    },
    ...
    {
      "name": "<auth_policy_name_N>",
      "type": "<auth_policy_type_N>"
    }
  ]
}

2.23.5.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.24. アプリストアアイテムの取得

2.24.1. 説明

アプリストアで利用可能なストアアイテムの一覧を読み込みます。利用可能なバイナリーおよびそれらのタイプの一覧が含まれます。

2.24.2. エンドポイント

  • URI: /box/srv/1.1/mam/appstore/getstoreitems
  • メソッド: POST

2.24.3. 認証

制限: ヘッダーとしてセッション ID (sessionId) が必要です。 

X-FH-AUTH-SESSION: "<sessionId_returned_from_fh.auth_call>"

2.24.4. リクエストボディー

{
  "appstore": "<app_store_global_unique_id>"
}

2.24.5. レスポンスボディー

2.24.5.1. 成功

{
  "status": "ok",
  "storeitems": [{
    "guid": "<store_item_global_unique_id_1>",
    "name": "<store_item_name_1>",
    "description": "<store_item_description_2>",
    "icon": "<base64_encoded_representation_of_store_item_icon_2>",
    "targets" : [
      {
        "type": "ios | iphone | ipad | android",
        "url": "url_of_installable_artifact_1"
      },
      {
        "type": "ios | iphone | ipad | android",
        "url": "url_of_installable_artifact_2"
      },
      ...
      {
        "type": "ios | iphone | ipad | android",
        "url": "url_of_installable_artifact_N"
      }
    ]
  },
  {
    "guid": "<store_item_global_unique_id_2>",
    "name": "<store_item_name_2>",
    "description": "<store_item_description_2>",
    "icon": "<base64_encoded_representation_of_store_item_icon_2>",
    "targets" : [
      {
        "type": "ios | iphone | ipad | android",
        "url": "url_of_installable_artifact_1"
      },
      {
        "type": "ios | iphone | ipad | android",
        "url": "url_of_installable_artifact_2"
      },
      ...
      {
        "type": "ios | iphone | ipad | android",
        "url": "url_of_installable_artifact_N"
      }
    ]
  }
  ...
  {
    "guid": "<store_item_global_unique_id_N>",
    "name": "<store_item_name_N>",
    "description": "<store_item_description_N>",
    "icon": "<base64_encoded_representation_of_store_item_icon_N>",
    "targets" : [
      {
        "type": "ios | iphone | ipad | android",
        "url": "url_of_installable_artifact_1"
      },
      {
        "type": "ios | iphone | ipad | android",
        "url": "url_of_installable_artifact_2"
      },
      ...
      {
        "type": "ios | iphone | ipad | android",
        "url": "url_of_installable_artifact_N"
      }
    ]
  }
}

2.24.5.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}

2.25. ストアアイテムのインストール

2.25.1. 説明

アプリストアアイテムをインストールします。要求されるタイプに応じて、この API はバイナリーストリームまたは URL リダイレクトを返すことがあります。

2.25.2. エンドポイント

  • URI: /box/srv/1.1/mas/storeitem/install
  • メソッド: POST | GET

2.25.3. 認証

制限: ヘッダーとしてセッション ID (sessionId) が必要です。 

X-FH-AUTH-SESSION: "<sessionId_returned_from_fh.auth_call>"

2.25.4. リクエストボディー

{
  "guid": "<store_item_global_unique_id>",
  "type": "ios | iphone | ipad | android"
}

2.25.5. レスポンス

2.25.5.1. 成功

レスポンスは、要求内の「タイプ」パラメーターによって異なります。

2.25.5.1.1. ios | iphone | ipad

iOS Over The Air (OTA) インストーラーページ

2.25.5.1.2. android

android デバイスのインストール可能なバイナリーアーティファクト: .apk ファイル。

2.25.5.2. エラー

{
  "status": "error",
  "message": "<error_message>"
}
2.25.5.2.1. 発生する可能性のあるエラーメッセージ:
  • invalid_type
  • invalid_guid