Chapter 2. Mobile App Management API

2.1. Read App Store

2.1.1. Description

Read details of the app store.

2.1.2. Endpoint

  • uri - /box/srv/1.1/admin/appstore/read
  • method - POST

2.1.3. Request Body

N/A

2.1.4. Response Body

2.1.4.1. Success

{
  "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. Error

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

2.2. Update App Store

2.2.1. Description

Update details of the app store

2.2.2. Endpoint

  • uri - /box/srv/1.1/admin/appstore/update
  • method - POST

2.2.3. Request Body

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

2.2.4. Response Body

2.2.4.1. Success

{
  "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. Error

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

2.3. Add StoreItem to App Store

2.3.1. Description

Add an existing Store Item to the store, making it visible in the store.

2.3.2. Endpoint

  • uri - /box/srv/1.1/admin/appstore/additem
  • method - POST

2.3.3. Request Body

{"guid":"<unique_store_item_id>"}

2.3.4. Response Body

2.3.4.1. Success

{
  "status":"ok"
}

2.3.4.2. Error

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

2.4. Remove StoreItem to App Store

2.4.1. Description

Remove existing Store Item from the store, making it invisible in the store.

2.4.2. Endpoint

  • uri - /box/srv/1.1/admin/appstore/removeitem
  • method - POST

2.4.3. Request Body

{"guid":"<unique_store_item_id>"}

2.4.4. Response Body

2.4.4.1. Success

{
  "status":"ok"
}

2.4.4.2. Error

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

2.5. Upload App Store Icon

2.5.1. Description

Add an icon for your store.

2.5.2. Endpoint

  • uri - /box/srv/1.1/admin/appstore/uploadbinary
  • method - POST

2.5.3. Request Body

Multipart request with the image.

2.5.4. Response Body

2.5.4.1. Success

{
  "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. Error

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

2.6. List Store Items In App Store

2.6.1. Description

List the current items in the App Store. The "binaries" fields are defined in the Binaries Options.

2.6.2. Endpoint

  • uri - /box/srv/1.1/admin/appstore/liststoreitems
  • method - POST

2.6.3. Request Body

{}

2.6.4. Response Body

2.6.4.1. Success

{
  "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. Error

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

2.6.5. Options

2.6.5.1. Binaries field

The binaries field is an array of information about the currently uploaded Store Item Binaries. It consists of :

  • config - a field for any extra OS related configuraton. For example, the ios bundle id.
  • storeItemBinaryVersion - The current store item binary version number.
  • sysModified - The last modified date of this store item binary.
  • type - The store item binary type.
  • url - You can use this url to download the latest version this store item binary.
  • versions - An array containing a history of older Store Item Binaries (a maximum of 4 entries is kept).

2.7. Add Auth Policy

2.7.1. Description

Add an Auth policy to be used with the appstore.

2.7.2. Endpoint

  • uri - /box/srv/1.1/admin/appstore/addpolicy
  • method POST

2.7.3. Request Body

{
  "guid":"<policy_id>"
}

2.7.4. Response Body

2.7.4.1. Success

{
  "status": "ok"
}

2.7.4.2. Error

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

2.8. Remove Store Auth Policy

2.8.1. Description

Remove an Auth policy from being used in with the appstore.

2.8.2. Endpoint

  • uri - /box/srv/1.1/admin/appstore/removepolicy
  • method POST

2.8.3. Request Body

{
  "guid":"<policy_id>"
}

2.8.4. Response Body

2.8.4.1. Success

{
  "status": "ok"
}

2.8.4.2. Error

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

2.9. List Auth Policies

2.9.1. Description

List the policies attached to the appstore.

2.9.2. Endpoint

  • uri - /box/srv/1.1/admin/appstore/listpolicies
  • method POST

2.9.3. Request Body

{}

2.9.4. Response Body

2.9.4.1. Success

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

2.9.4.2. Error

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

2.10. Create App Store Item

2.10.1. Description

Create an app store item.

2.10.2. Endpoint

  • uri - /box/srv/1.1/admin/storeitem/create
  • method - POST
Note

The icon is uploaded after the item is created. The item will be created with a no icon.

2.10.3. Request Body

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

2.10.4. Response Body

{
  "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. Error

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

2.11. Read App Store Item

2.11.1. Description

Read details of a store item.

2.11.2. Endpoint

  • uri - /box/srv/1.1/admin/storeitem/read
  • method - POST

2.11.3. Request Body

{
  "guid":String
}

2.11.3.1. Response Body

{
  "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. Error

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

2.12. Update Item

2.12.1. Endpoint

  • /box/srv/1.1/admin/storeitem/update
  • method POST

2.12.2. Request Body

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

2.12.3. Response Body

{
  "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. Error

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

2.13. Delete App Store Item

2.13.1. Endpoint

  • /box/srv/1.1/admin/storeitem/delete
  • method POST

2.13.2. Request Body

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

2.13.3. Respose Body

{
  "status":"ok"
}

2.13.3.1. Error

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

2.14. List App Store Items

2.14.1. Description

List items in an app store.

2.14.2. Endpoint

  • uri - /box/srv/1.1/admin/storeitem/list
  • method - POST

2.14.3. Request Body

  {}

2.14.4. Response Body

{
  "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. Error

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

2.15. Upload Binary

2.15.1. Endpoint

  • /box/srv/1.1/admin/storeitem/uploadbinary
  • method POST
  • file sent as multipart request

2.15.2. Request Body

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

2.15.3. Response

{
  "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. Error

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

2.16. Add Auth Policy

2.16.1. Endpoint

  • /box/srv/1.1/admin/storeitem/addpolicy
  • method POST

2.16.2. Request Body

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

2.16.3. Response Body

{
  "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. Error

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

2.17. Remove Store Item Auth Policy

2.17.1. Endpoint

  • /box/srv/1.1/admin/storeitem/removepolicy
  • method POST

2.17.2. Request Body

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

2.17.3. Response Body

{
  "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. Error

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

2.18. Get Binary Config

2.18.1. Endpoint

  • /box/srv/1.1/admin/storeitem/getbinaryconfig
  • method POST | GET

2.18.2. Request Body

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

2.18.3. Response

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

2.18.3.1. Error

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

2.19. Set Binary Config

2.19.1. Endpoint

  • /box/srv/1.1/admin/storeitem/setbinaryconfig
  • method POST

2.19.2. Request Body

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

2.19.3. Response

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

2.19.4. Error

2.19.4.1. Possible error messages:

  • invalid_type
  • invalid_guid

2.20. Add StoreItem Groups

2.20.1. Endpoint

  • /box/srv/1.1/admin/storeitem/addgroups
  • method POST

2.20.2. Request Body

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

2.20.3. Response Body

{
  "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. Error

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

2.21. Remove StoreItem Groups

2.21.1. Endpoint

  • /box/srv/1.1/admin/storeitem/removegroups
  • method POST

2.21.2. Request Body

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

2.21.3. Response Body

{
  "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. Error

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

2.22. List Audit Log entries

2.22.1. Description

Get a list of the Audit Log entries.

2.22.2. Endpoint

  • uri - /box/srv/1.1/admin/auditlog/listlogs
  • method - POST | GET

2.22.3. Auth

Restricted - requires sessionId as header. 

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

2.22.4. Request Body

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

2.22.5. Response Body

2.22.5.1. Success

{
  "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. Error

{
  "status": "error",
  "message": "<error_message>"
}
2.22.5.2.1. Possible error messages:
  • invalid_type

2.23. Read App Store

2.23.1. Description

Read details of the app store - name, description, icon & supported Auth policies.

2.23.2. Endpoint

  • uri - /box/srv/1.1/mas/appstore/read
  • method - POST | GET

2.23.3. Auth

Open - a public endpoint which can be called with no authentication.

2.23.4. Request Body

N/A

2.23.5. Response Body

2.23.5.1. Success

{
  "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. Error

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

2.24. Get App Store Items

2.24.1. Description

Read list of Store Items availabe from the app store. Includes a list of available binaries and their type.

2.24.2. Endpoint

  • uri - /box/srv/1.1/mam/appstore/getstoreitems
  • method - POST

2.24.3. Auth

Restricted - requires sessionId as header. 

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

2.24.4. Request Body

{
  "appstore": "<app_store_global_unique_id>"
}

2.24.5. Response Body

2.24.5.1. Success

{
  "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. Error

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

2.25. Install Store Item

2.25.1. Description

Install an App Store Item. Depending on the type requested, this API may return a binary stream or a URL redirect.

2.25.2. Endpoint

  • uri - /box/srv/1.1/mas/storeitem/install
  • method - POST | GET

2.25.3. Auth

Restricted - requires sessionId as header. 

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

2.25.4. Request Body

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

2.25.5. Response

2.25.5.1. Success

The response will vary depending on the "type" parameter in the request.

2.25.5.1.1. ios | iphone | ipad

iOS Over The Air (OTA) installer page.

2.25.5.1.2. android

Installable binary artifact for android device - .apk file.

2.25.5.2. Error

{
  "status": "error",
  "message": "<error_message>"
}
2.25.5.2.1. Possible error messages:
  • invalid_type
  • invalid_guid