Store App APIs
POSTCreate Store App
- Description
- Creates a store app.
- Request Endpoint
- POST https://<Example api server address>/store
- Parameters
- None.
- cURL syntax
curl --include \ --request POST \ --header "Content-Type: application/json" \ --data-binary "{ \"privacyPolicy\":\"Standard\", \"name\":\"VjuvAkgqKG\", \"icon\":\"182312-19238128321-192381203.ico\", \"locationsSupported\":[ \"UK\", \"US\" ], \"description\":\"Store app\", \"bundleIdentifier\":\"DEqcYvbPhV\", \"current\": false }" \ 'https://core.dev.Example.net/api/store'
- POST body attributes (JSON)
Attribute Type Use Description name
String Required Name of the store app. icon
String Optional Icon for the store app. locationsSupported
Array Optional An array of the locations supported. bundleIdentifier
String Required Bundle identifier of the store app. description
String Optional Description for the store app. privacyPolicy
String Optional privacyPolicy
of the store app.current
String Optional Sets this store as the default. - POST body
Headers: Content-Type: application/json
{ "privacyPolicy": "Standard", "name": "VjuvAkgqKG", "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US" ], "description": "Store app", "bundleIdentifier": "DEqcYvbPhV", "current": false }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "3a254485-7c89-4814-aaa4-a8de367f081e", "deleted": false, "name": "VjuvAkgqKG", "downloadLink": null, "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US" ], "bundleIdentifier": "DEqcYvbPhV", "downloads": 0, "latestBuild": null, "latestVersion": null, "description": "Store app", "privacyPolicy": "Standard", "rating": null, "current": false, "silent": null, "normal": null, "mandatory": null, "downgrade": null }, "detail": null, "error": false, "message": "Creating Store successful" }
POSTCreate Store App Version
- Description
- Creates a store app version.
- Request Endpoint
- POST https://<Example api server address>/store/version
- Parameters
- None.
- cURL syntax
curl --include \ --request POST \ --header "Content-Type: application/json" \ --data-binary "{ \"permissionDetails\":\"Camera access\", \"build\":577658, \"downloadLink\":\"8a170c24-3109-453a-b6e9-d13a474a4899.apk\", \"languagesSupported\":[ \"en-US\", \"en-IN\" ], \"locationsSupported\":[ \"UK\", \"US\", \"IN\" ], \"storeId\":\"8fef9eb9-4e0c-4614-94e4-144e886ec53c\", \"sizeOnDisk\":\"50 MB\", \"version\":\"v2.0\", \"compatibility\":\"Android 5.0 and above\" }" \ 'https://core.dev.Example.net/api/store/version'
- POST body attributes (JSON)
Attribute Type Use Description build
Number Required Build number of the store app version. Must be unique for every version. version
String Optional Version number of the store app. downloadLink
String Required Location of the .apk file in the cloud store. storeId
String Required Store id of a version that is being created. locationsSupported
Array Optional An array of locations supported. languagesSupported
Array Optional An array of languages supported. compatibility
String Optional Compatibility of the version. sizeOnDisk
String Optional Storage details of the .apk. permissionDetails
String Optional Permission details of the .apk. - POST body
Headers: Content-Type: application/json
{ "permissionDetails": "Camera access", "build": 577658, "downloadLink": "8a170c24-3109-453a-b6e9-d13a474a4899.apk", "languagesSupported": [ "en-US", "en-IN" ], "locationsSupported": [ "UK", "US", "IN" ], "storeId": "8fef9eb9-4e0c-4614-94e4-144e886ec53c", "sizeOnDisk": "50 MB", "version": "v2.0", "compatibility": "Android 5.0 and above" }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "e1c63904-ac7a-4e71-a69e-3ad1cfb63415", "deleted": false, "store": { "id": "8fef9eb9-4e0c-4614-94e4-144e886ec53c", "deleted": false, "name": "BvrQQjyilN", "downloadLink": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.mkt/018ff74f-9e4d-4777-9476-0e117f3520c4.apk", "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US", "IN" ], "bundleIdentifier": "rEOQsRCkeL", "downloads": 0, "latestBuild": 577657, "latestVersion": "v1.0", "description": "Store app", "privacyPolicy": "Special", "rating": null, "current": false, "silent": null, "normal": null, "mandatory": null, "downgrade": null }, "storeId": "8fef9eb9-4e0c-4614-94e4-144e886ec53c", "build": 577658, "version": "v2.0", "latest": null, "releaseDate": null, "downloadLink": "8a170c24-3109-453a-b6e9-d13a474a4899.apk", "rating": null, "status": "DRAFTED", "locationsSupported": [ "UK", "US", "IN" ], "languagesSupported": [ "en-US", "en-IN" ], "compatibility": "Android 5.0 and above", "sizeOnDisk": "50 MB", "permissionDetails": "Camera access", "updateAvailable": null }, "detail": null, "error": false, "message": "Creating store version successful" }
GETFind All Stores
- Description
- Get all stores.
- Request Endpoint
- GET https://<Example api server address>/store
- Parameters
- None.
- cURL syntax
curl --include \ 'https://core.dev.Example.net/api/store'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "content": [ { "id": "caaedbc0-9869-4744-8126-3f5a2878cc25", "deleted": false, "name": "QOmdxANcgi", "downloadLink": null, "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US" ], "bundleIdentifier": "CLTbwEYUsE", "downloads": 0, "latestBuild": null, "latestVersion": null, "description": "Store app", "privacyPolicy": "Standard", "rating": null, "current": true, "silent": null, "normal": null, "mandatory": null, "downgrade": null } ], "totalElements": 1, "totalPages": 1, "last": true, "size": 70, "number": 0, "sort": null, "numberOfElements": 1, "first": true }, "detail": null, "error": false, "message": "Fetching all stores successful" }
GETFind One Store App
- Description
- Gets one store app.
- Request Endpoint
- GET https://<Example api server address>/store/{id}
- Parameters
Parameter Type Use Description id String Required Id of the store app version. - cURL syntax
curl --include \ 'https://core.dev.Example.net/api/store/id'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "3a254485-7c89-4814-aaa4-a8de367f081e", "deleted": false, "name": "NVFJejMrcH", "downloadLink": null, "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US", "IN" ], "bundleIdentifier": "kJnrOJwGgn", "downloads": 0, "latestBuild": null, "latestVersion": null, "description": "Store app", "privacyPolicy": "Special", "rating": null, "current": false, "silent": null, "normal": null, "mandatory": null, "downgrade": null }, "detail": null, "error": false, "message": "Updating Store successful" }
PUTUpdate Store App
- Description
- Updates a store app.
- Request Endpoint
- PUT https://<Example api server address>/store/{id}
- Parameters
Parameter Type Use Description id String Required Id of the store app version. - cURL syntax
curl --include \ --request PUT \ --header "Content-Type: application/json" \ --data-binary "{ \"name\":\"Example UK\", \"bundleIdentifier\":\"com.Example.store\", \"privacyPolicy\":\"Special\", \"locationsSupported\":[ \"UK\", \"US\", \"IN\" ], \"current\":true, \"silent\":{ \"min\":4, \"max\":10 }, \"normal\":{ \"min\":3, \"max\":7 }, \"mandatory\":{ \"min\":2, \"max\":5 }, \"downgrade\":{ \"min\":0, \"max\":0 } }" \ 'https://core.dev.Example.net/api/store/id'
- PUT body attributes (JSON)
Attribute Type Use Description name
String Required The name of the store app. icon
String Optional An icon for the store app. locationsSupported
Array Optional An array of the locations supported. bundleIdentifier
String Required Bundle identifier of the store app. description
String Optional Description for the store app. privacyPolicy
String Optional "privacyPolicy" of the store app. current
String Optional Sets this store as the default. silent
Object Optional Manages silent updates. min
Number Optional The minimum build number. max
Number Optional The maximum build number. normal
Object Optional Manages normal updates. min
Number Optional The minimum build number. max
Number Optional The maximum build number. mandatory
Object Optional Manages mandatory updates. min
Number Optional The minimum build number. max
Number Optional The maximum build number. downgrade
Object Optional Manages downgrades. min
Number Optional The minimum build number. max
Number Optional The maximum build number. - PUT body
Headers: Content-Type: application/json
{ "name": "Example UK", "bundleIdentifier": "com.Example.store", "privacyPolicy": "Special", "locationsSupported": [ "UK", "US", "IN" ], "current": true, "silent": { "min": 4, "max": 10 }, "normal": { "min": 3, "max": 7 }, "mandatory": { "min": 2, "max": 5 }, "downgrade": { "min": 0, "max": 0 } }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "92d47bf1-bfdb-40cd-a8bc-401b7fa05cd0", "deleted": false, "name": "yvutjkhKJB", "downloadLink": null, "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US", "IN" ], "bundleIdentifier": "ljMJjqOKno", "downloads": 0, "latestBuild": null, "latestVersion": null, "description": "Store app", "privacyPolicy": "Special", "rating": null, "current": true, "silent": { "min": 4, "max": 10 }, "normal": { "min": 3, "max": 7 }, "mandatory": { "min": 2, "max": 5 }, "downgrade": { "min": 0, "max": 0 } }, "detail": null, "error": false, "message": "Updating Store successful" }
PUTUpdate Store App Version
- Description
- Updates a store app version.
- Request Endpoint
- PUT https://<Example api server address>/store/version/{id}
- Parameters
Parameter Type Use Description id String Required Id of the store app version - cURL syntax
curl --include \ --request PUT \ --header "Content-Type: application/json" \ --data-binary "{ \"permissionDetails\":\"Camera access\", \"build\":577657, \"downloadLink\":\"018ff74f-9e4d-4777-9476-0e117f3520c4.apk\", \"languagesSupported\":[ \"en-US\", \"en-IN\" ], \"locationsSupported\":[ \"UK\", \"US\" ], \"storeId\":\"8fef9eb9-4e0c-4614-94e4-144e886ec53c\", \"sizeOnDisk\":\"50 MB\", \"version\":\"v1.0\", \"compatibility\":\"Android 5.0 and above\" }" \ 'https://core.dev.Example.net/api/store/version/id'
- PUT body attributes (JSON)
Attribute Type Use Description build
Number Required Build number of the store app version. Must be unique for every version. version
String Optional Version number of the store app. downloadLink
String Required Location of the .apk file in the cloud store. storeId
String Required Store id for a version that is being created. locationsSupported
Array Optional An array of supported locations. languagesSupported
Array Optional an array of supported languages. compatibility
String Optional Compatibility of the version. sizeOnDisk
String Optional Storage details of the apk. permissionDetails
String Optional Permission details of the apk. - PUT body
Headers: Content-Type: application/json
{ "permissionDetails": "Camera access", "build": 577657, "downloadLink": "018ff74f-9e4d-4777-9476-0e117f3520c4.apk", "languagesSupported": [ "en-US", "en-IN" ], "locationsSupported": [ "UK", "US" ], "storeId": "8fef9eb9-4e0c-4614-94e4-144e886ec53c", "sizeOnDisk": "50 MB", "version": "v1.0", "compatibility": "Android 5.0 and above" }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "192c6e51-6451-4626-b0df-a8e7285695f3", "deleted": false, "store": { "id": "8fef9eb9-4e0c-4614-94e4-144e886ec53c", "deleted": false, "name": "BvrQQjyilN", "downloadLink": null, "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US", "IN" ], "bundleIdentifier": "rEOQsRCkeL", "downloads": 0, "latestBuild": null, "latestVersion": null, "description": "Store app", "privacyPolicy": "Special", "rating": null, "current": false, "silent": null, "normal": null, "mandatory": null, "downgrade": null }, "storeId": "8fef9eb9-4e0c-4614-94e4-144e886ec53c", "build": 577657, "version": "v1.0", "latest": null, "releaseDate": null, "downloadLink": "018ff74f-9e4d-4777-9476-0e117f3520c4.apk", "rating": null, "status": "DRAFTED", "locationsSupported": [ "UK", "US" ], "languagesSupported": [ "en-US", "en-IN" ], "compatibility": "Android 5.0 and above", "sizeOnDisk": "50 MB", "permissionDetails": "Camera access", "updateAvailable": null }, "detail": null, "error": false, "message": "Creating store version successful" }
GETFind Store App Version
- Description
- Gets a store app version.
- Request Endpoint
- GET https://<Example api server address>/store/version/{id}
- Parameters
Parameter Type Use Description id String Required Id of the store app version - cURL syntax
curl --include \ 'https://core.dev.Example.net/api/store/version/id'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "192c6e51-6451-4626-b0df-a8e7285695f3", "deleted": false, "store": { "id": "8fef9eb9-4e0c-4614-94e4-144e886ec53c", "deleted": false, "name": "BvrQQjyilN", "downloadLink": null, "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US", "IN" ], "bundleIdentifier": "rEOQsRCkeL", "downloads": 0, "latestBuild": null, "latestVersion": null, "description": "Store app", "privacyPolicy": "Special", "rating": null, "current": false, "silent": null, "normal": null, "mandatory": null, "downgrade": null }, "storeId": null, "build": 577657, "version": "v1.0", "latest": null, "releaseDate": null, "downloadLink": "8a170c24-3109-453a-b6e9-d13a474a4899.apk", "rating": null, "status": "DRAFTED", "locationsSupported": [ "UK", "US" ], "languagesSupported": [ "en-US", "en-IN" ], "compatibility": "Android 5.0 and above", "sizeOnDisk": "50 MB", "permissionDetails": "Camera access", "updateAvailable": null }, "detail": null, "error": false, "message": "Fetching store version successful" }
PUTPublish Store App Version
- Description
- Publishes a store app version.
- Request Endpoint
- PUT https://<Example api server address>/store/version/{id}/publish
- Parameters
Parameter Type Use Description id String Required Id of the store app version. - cURL syntax
curl --include \ --request PUT \ 'https://core.dev.Example.net/api/store/version/id/publish'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "192c6e51-6451-4626-b0df-a8e7285695f3", "deleted": false, "store": { "id": "8fef9eb9-4e0c-4614-94e4-144e886ec53c", "deleted": false, "name": "BvrQQjyilN", "downloadLink": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.mkt/018ff74f-9e4d-4777-9476-0e117f3520c4.apk", "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US", "IN" ], "bundleIdentifier": "rEOQsRCkeL", "downloads": 0, "latestBuild": 577657, "latestVersion": "v1.0", "description": "Store app", "privacyPolicy": "Special", "rating": null, "current": false, "silent": null, "normal": null, "mandatory": null, "downgrade": null }, "storeId": null, "build": 577657, "version": "v1.0", "latest": null, "releaseDate": 1478510559402, "downloadLink": "018ff74f-9e4d-4777-9476-0e117f3520c4.apk", "rating": null, "status": "PUBLISHED", "locationsSupported": [ "UK", "US" ], "languagesSupported": [ "en-US", "en-IN" ], "compatibility": "Android 5.0 and above", "sizeOnDisk": "50 MB", "permissionDetails": "Camera access", "updateAvailable": null }, "detail": null, "error": false, "message": "Publishing store version successful" }
GETFind Store Versions
- Description
- Gets store versions.
- Request Endpoint
- GET https://<Example api server address>store/{id}/versions
- Parameters
Parameter Type Use Description id String Required Id of the store app. - cURL syntax
curl --include \ 'https://core.dev.Example.net/api/store/id/versions'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "content": [ { "id": "8e86ecf2-19e1-4cd3-8d5c-e710291241ef", "deleted": false, "store": { "id": "caaedbc0-9869-4744-8126-3f5a2878cc25", "deleted": false, "name": "rFopFUKuCR", "downloadLink": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.mkt/b8636e2c-2017-47a4-b8c9-ef90a246c7ea.apk", "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US", "IN" ], "bundleIdentifier": "mckkebrHDp", "downloads": 0, "latestBuild": 542084, "latestVersion": "v2.0", "description": "Store app", "privacyPolicy": "Special", "rating": null, "current": true, "silent": null, "normal": null, "mandatory": null, "downgrade": null }, "storeId": null, "build": 542083, "version": "v1.0", "latest": null, "releaseDate": 1478515297643, "downloadLink": "eb04156b-de61-4e50-8394-a27aaac75172.apk", "rating": null, "status": "PUBLISHED", "locationsSupported": [ "UK", "US" ], "languagesSupported": [ "en-US", "en-IN" ], "compatibility": "Android 5.0 and above", "sizeOnDisk": "50 MB", "permissionDetails": "Camera access", "updateAvailable": null }, { "id": "08c3339b-6288-4a5f-bd4e-ece65458b4e2", "deleted": false, "store": { "id": "caaedbc0-9869-4744-8126-3f5a2878cc25", "deleted": false, "name": "rFopFUKuCR", "downloadLink": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.mkt/b8636e2c-2017-47a4-b8c9-ef90a246c7ea.apk", "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US", "IN" ], "bundleIdentifier": "mckkebrHDp", "downloads": 0, "latestBuild": 542084, "latestVersion": "v2.0", "description": "Store app", "privacyPolicy": "Special", "rating": null, "current": true, "silent": null, "normal": null, "mandatory": null, "downgrade": null }, "storeId": null, "build": 542084, "version": "v2.0", "latest": null, "releaseDate": 1478515297762, "downloadLink": "b8636e2c-2017-47a4-b8c9-ef90a246c7ea.apk", "rating": null, "status": "PUBLISHED", "locationsSupported": [ "UK", "US", "IN" ], "languagesSupported": [ "en-US", "en-IN" ], "compatibility": "Android 5.0 and above", "sizeOnDisk": "50 MB", "permissionDetails": "Camera access", "updateAvailable": null } ], "totalElements": 2, "totalPages": 1, "last": true, "size": 70, "number": 0, "sort": null, "numberOfElements": 2, "first": true }, "detail": null, "error": false, "message": "Fetching all store versions successful" }
PUTCheck Store Updates
- Description
- Checks for store updates.
- Request Endpoint
- PUT https://<Example api server address>/store/update
- Parameters
- None.
- cURL syntax
curl --include \ --request PUT \ --header "Content-Type: application/json" \ --data-binary "{ \"build\":983647, \"storeId\":\"66d08392-1b36-473c-b929-f821c9214d70\" }" \ 'https://core.dev.Example.net/api/store/update'
- PUT body attributes (JSON)
Attribute Type Use Description build
Number Optional Build number of the store app. storeId
String Optional UUID of the store app. This is optional and need not be passed if not known. Client will pick the default store automatically. - PUT body
Headers: Content-Type: application/json
{ "build": 983647, "storeId": "66d08392-1b36-473c-b929-f821c9214d70" }
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "56fbb084-d8d4-43af-b519-ba8bde547487", "deleted": false, "store": { "id": "66d08392-1b36-473c-b929-f821c9214d70", "deleted": false, "name": "JToLhULWXG", "downloadLink": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.mkt/834fd4ef-266c-4ea5-846a-ca9d9941d391.apk", "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US", "IN" ], "bundleIdentifier": "nZZRySghsi", "downloads": 0, "latestBuild": 983648, "latestVersion": "v2.0", "description": "Store app", "privacyPolicy": "Special", "rating": null, "current": false, "silent": null, "normal": null, "mandatory": null, "downgrade": null }, "storeId": null, "build": 983648, "version": "v2.0", "latest": null, "releaseDate": 1478525131933, "downloadLink": "834fd4ef-266c-4ea5-846a-ca9d9941d391.apk", "rating": null, "status": "PUBLISHED", "locationsSupported": [ "UK", "US", "IN" ], "languagesSupported": [ "en-US", "en-IN" ], "compatibility": "Android 5.0 and above", "sizeOnDisk": "50 MB", "permissionDetails": "Camera access", "updateAvailable": null }, "detail": null, "error": false, "message": "Checking for store updates successful" }
GETFind Default Store
- Description
- Gets the default store.
- Request Endpoint
- GET https://<Example api server address>/store/default
- Parameters
- None.
- cURL syntax
curl --include \ 'https://core.dev.Example.net/api/store/default'
- Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{ "data": { "id": "92d47bf1-bfdb-40cd-a8bc-401b7fa05cd0", "deleted": false, "name": "yvutjkhKJB", "downloadLink": null, "icon": "182312-19238128321-192381203.ico", "locationsSupported": [ "UK", "US", "IN" ], "bundleIdentifier": "ljMJjqOKno", "downloads": 0, "latestBuild": null, "latestVersion": null, "description": "Store app", "privacyPolicy": "Special", "rating": null, "current": true, "silent": { "min": 4, "max": 10 }, "normal": { "min": 3, "max": 7 }, "mandatory": { "min": 2, "max": 5 }, "downgrade": { "min": 0, "max": 0 } }, "detail": null, "error": false, "message": "Finding the default store successful" }