Store Item Administration

Create App Store Item

Description

Create an app store item

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.

Request Body

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

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>", ...]
}

Error

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

Read App Store Item

Description

Read details of a store item

Endpoint

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

Request Body

{
  guid: String
}

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 > ]
}

Error

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

Update Item

Endpoint

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

Request Body

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

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>", ...]
}

Error

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

Delete App Store Item

Endpoint

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

Request Body

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

Respose Body

{
  "status": "ok"
}

Error

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

List App Store Items

Description

List items in an app store

Endpoint

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

Request Body

{}

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>", ...]
    }]
  }

Error

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

Upload Binary

Endpoint

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

Request Body

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

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>", ...]
      }]
    }

Error

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

Add Auth Policy

Endpoint

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

Request Body

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

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>", ...]
    }]
  }

Error

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

Remove Auth Policy

Endpoint

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

Request Body

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

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>", ...]
    }]
  }

Error

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

Get Binary Config

Endpoint

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

Request Body

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

Response

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

Error

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

Set Binary Config

Endpoint

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

Request Body

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

Response

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

Error

Possible error messages:

invalid_type
invalid_guid

Add StoreItem Groups

Endpoint

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

Request Body

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

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>", ...]
   }]
 }

Error

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

Remove StoreItem Groups

Endpoint

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

Request Body

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

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>", ...]
}

Error

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