/
App Listing Page API

App Listing Page API

Owned by Anushi Dhaketa
Aug 06, 2021
3 min read

Fetch all apps :

API type: GET

URL: https://{{workspaceSlug}}.{{domain}}/api/v1/appinstall?page=1&perPage=10

The API gives all apps(installed/uninstalled/public/private) for the specified workspace as a response.

Sample response:

{ "per_page": "10", "total": "4", "data": [ { "appInstallationId": 216, "appVersionId": 118, "accountSlug": "tab", "appId": 93, "title": "Myntra PPMP APP", "status": "installed", "intendedAudience": "public", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/eshopbox_wms_uploads/download.png", "description": "Myntra PPMP best Shopping platform", "clientId": "06fcc8d5998a585df4bb85a599fe8b24", "appInstallationLink": "https://auth.auperator.co/public/app-url/06fcc8d5998a585df4bb85a599fe8b24", "businessName": "Eshopbox", "homePageUrl": "https://www.mynta.com/", "contactEmail": "contact@test.com", "contactPhone": "989898988", "createdAt": "2021-06-28 21:20:30.0", "updatedAt": "2021-07-29 18:38:39.0", "appType": "sales_channel_app", "connections": [ { "createdAt": "2021-06-28T21:27:41.000Z", "connectionId": 1510, "connectionName": "Myntra PPMP APP", "isActive": "inactive", "updatedAt": "2021-06-28T21:27:41.000Z" } ] }, { "appInstallationId": 131, "appVersionId": 124, "accountSlug": "tab", "appId": 98, "title": "Shopify", "status": "installed", "intendedAudience": "private", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/label_invoice_file_upload/shopify-bag.png", "description": "Fulfill Shopify orders seamlessly", "clientId": "b7e30347c98610d020ea84ef494ca673", "appInstallationLink": "https://auth.auperator.co/public/app-url/b7e30347c98610d020ea84ef494ca673", "businessName": "Eshopbox", "homePageUrl": "https://www.shopify.in/", "contactEmail": "contact@test.com", "contactPhone": "989898988", "createdAt": "2021-05-01 15:37:48.0", "updatedAt": "2021-06-04 16:33:53.0", "appType": "sales_channel_app", "connections": [ { "createdAt": "2021-06-04T16:34:09.000Z", "connectionId": 1128, "connectionName": "Shopify test", "isActive": "inactive", "updatedAt": "2021-06-04T16:34:09.000Z" }, { "createdAt": "2021-06-28T22:36:22.000Z", "connectionId": 1512, "connectionName": "Shopify test final", "isActive": "inactive", "updatedAt": "2021-06-29T19:58:35.000Z" } ] }, { "appInstallationId": 132, "appVersionId": 138, "accountSlug": "tab", "appId": 112, "title": "Amazon Prime", "status": "uninstalled", "intendedAudience": "public", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/file_upload_consignement_zapier/download%201.png", "description": "Fulfill Amazon Prime orders seamlessly", "clientId": "c3b7de339434d5f1d64f1d59e2c4dc7b", "appInstallationLink": "https://auth.auperator.co/public/app-url/c3b7de339434d5f1d64f1d59e2c4dc7b", "businessName": "Eshopbox", "homePageUrl": "https://docs.smartconnect.amazon.com/index.html", "contactEmail": "contact@test.com", "contactPhone": "989898988", "createdAt": "2021-05-01 15:38:49.0", "updatedAt": "2021-07-23 12:34:21.0", "appType": "sales_channel_app" }, { "appInstallationId": 129, "appVersionId": 140, "accountSlug": "tab", "appId": 114, "title": "Ajio", "status": "installed", "intendedAudience": "public", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/file_upload_consignement_zapier/ajio.jpg", "description": "Fulfill Ajio orders seamlessly", "clientId": "7bc4e11a7e31fadc199d29cebe22c672", "appInstallationLink": "https://auth.auperator.co/public/app-url/7bc4e11a7e31fadc199d29cebe22c672", "businessName": "Eshopbox", "homePageUrl": "https://www.ajio.com", "contactEmail": "contact@test.com", "contactPhone": "989898988", "createdAt": "2021-05-01 15:36:23.0", "updatedAt": "2021-05-01 15:36:23.0", "appType": "sales_channel_app" } ], "page": "1" }

 

Fetch Installed Apps:

To get only installed apps, add appStatus as installed in query parameters.

URL: https://{{workspaceSlug}}.{{domain}}/api/v1/appinstall?page=1&perPage=10&appStatus=installed

Sample response:

{ "per_page": "10", "total": "2", "data": [ { "appInstallationId": 216, "appVersionId": 118, "accountSlug": "tab", "appId": 93, "title": "Myntra PPMP APP", "status": "installed", "intendedAudience": "public", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/eshopbox_wms_uploads/download.png", "description": "Myntra PPMP best Shopping platform", "clientId": "06fcc8d5998a585df4bb85a599fe8b24", "appInstallationLink": "https://auth.auperator.co/public/app-url/06fcc8d5998a585df4bb85a599fe8b24", "businessName": "Eshopbox", "homePageUrl": "https://www.mynta.com/", "contactEmail": "contact@test.com", "contactPhone": "989898988", "createdAt": "2021-06-28 21:20:30.0", "updatedAt": "2021-07-29 18:38:39.0", "appType": "sales_channel_app", "connections": [ { "createdAt": "2021-06-28T21:27:41.000Z", "connectionId": 1510, "connectionName": "Myntra PPMP APP", "isActive": "inactive", "updatedAt": "2021-06-28T21:27:41.000Z" } ] }, { "appInstallationId": 130, "appVersionId": 122, "accountSlug": "tab", "appId": 96, "title": "Flipkart", "status": "installed", "intendedAudience": "public", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/eshopbox_wms_uploads/flipkart-logo-3F33927DAA-seeklogo.com.png", "description": "Fulfill Flipkart orders seamlessly", "clientId": "96160e0f5fdebe08d1834c5fd5d4fa14", "appInstallationLink": "https://auth.auperator.co/public/app-url/96160e0f5fdebe08d1834c5fd5d4fa14", "businessName": "Eshopbox", "homePageUrl": "https://eshopbox.com", "contactEmail": "contact@test.com", "contactPhone": "989898988", "createdAt": "2021-05-01 15:37:12.0", "updatedAt": "2021-05-01 15:37:12.0", "appType": "sales_channel_app", "connections": [ { "createdAt": "2021-05-03T17:34:18.000Z", "connectionId": 729, "connectionName": null, "isActive": "pending", "updatedAt": "2021-05-03T17:34:18.000Z" }, { "createdAt": "2021-05-24T19:06:39.000Z", "connectionId": 1023, "connectionName": "Flipkart test ", "isActive": "active", "updatedAt": "2021-05-24T19:06:39.000Z" }, { "createdAt": "2021-06-28T20:20:25.000Z", "connectionId": 1507, "connectionName": "", "isActive": "active", "updatedAt": "2021-06-28T20:20:25.000Z" }, { "createdAt": "2021-07-07T09:29:04.000Z", "connectionId": 1584, "connectionName": "Flipkarttest1", "isActive": "inactive", "updatedAt": "2021-07-07T09:29:04.000Z" } ] } ], "page": "1" }

 

Various state of connections and how to define them.

State of connection

How to define it

State of connection

How to define it

Success ( Connection has been successfully made)

When isActive = active in the response

eg:

{ "appInstallationId": 216, "appVersionId": 118, "accountSlug": "tab", "appId": 93, "title": "Myntra PPMP APP", "status": "installed", "intendedAudience": "public", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/eshopbox_wms_uploads/download.png", "description": "Myntra PPMP best Shopping platform", "clientId": "06fcc8d5998a585df4bb85a599fe8b24", "appInstallationLink": "https://auth.auperator.co/public/app-url/06fcc8d5998a585df4bb85a599fe8b24", "businessName": "Eshopbox", "homePageUrl": "https://www.mynta.com/", "contactEmail": "contact@test.com", "contactPhone": "989898988", "createdAt": "2021-06-28 21:20:30.0", "updatedAt": "2021-07-29 18:38:39.0", "appType": "sales_channel_app", "connections": [ { "createdAt": "2021-06-28T21:27:41.000Z", "connectionId": 1510, "connectionName": "Myntra PPMP APP", "isActive": "active", "updatedAt": "2021-06-28T21:27:41.000Z" } ] }

Disconnected (Connection is diconnected)

When isActive = inactive in the response

eg:

{ "per_page": "10", "total": "2", "data": [ { "appInstallationId": 216, "appVersionId": 118, "accountSlug": "tab", "appId": 93, "title": "Myntra PPMP APP", "status": "installed", "intendedAudience": "public", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/eshopbox_wms_uploads/download.png", "description": "Myntra PPMP best Shopping platform", "clientId": "06fcc8d5998a585df4bb85a599fe8b24", "appInstallationLink": "https://auth.auperator.co/public/app-url/06fcc8d5998a585df4bb85a599fe8b24", "businessName": "Eshopbox", "homePageUrl": "https://www.mynta.com/", "contactEmail": "contact@test.com", "contactPhone": "989898988", "createdAt": "2021-06-28 21:20:30.0", "updatedAt": "2021-07-29 18:38:39.0", "appType": "sales_channel_app", "connections": [ { "createdAt": "2021-06-28T21:27:41.000Z", "connectionId": 1510, "connectionName": "Myntra PPMP APP", "isActive": "inactive", "updatedAt": "2021-06-28T21:27:41.000Z" } ] }

Pending (App is installed but no connection is made)

When connection key is not present in the object

eg :

{ "appInstallationId": 129, "appVersionId": 140, "accountSlug": "tab", "appId": 114, "title": "Ajio", "status": "installed", "intendedAudience": "public", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/file_upload_consignement_zapier/ajio.jpg", "description": "Fulfill Ajio orders seamlessly", "clientId": "7bc4e11a7e31fadc199d29cebe22c672", "appInstallationLink": "https://auth.auperator.co/public/app-url/7bc4e11a7e31fadc199d29cebe22c672", "businessName": "Eshopbox", "homePageUrl": "https://www.ajio.com", "contactEmail": "contact@test.com", "contactPhone": "989898988", "createdAt": "2021-05-01 15:36:23.0", "updatedAt": "2021-05-01 15:36:23.0", "appType": "sales_channel_app" }

Related content