/
Build a custom app

Build a custom app

Owned by Anushi Dhaketa
Last updated: Dec 16, 2021
3 min read

We will receive a request from Frontend to create a custom app either on the existing workspace or on a new Development Workspace.

  1. Build a custom app on the same workspace

    1. API URL :- “https://partners.myeshopbox.com/api/v1/customapp“

    2. Sample request body:

{ "appName": "testShubham", "description": "testShubham", "workspace": "testShubham", "isDevelopmentWorkspace": false }

c. Sample Response body:

{ "appUrl": "https://www.google.com", "title": "tt", "description": "tt", "logoUrl": "https://storage.googleapis.com/logo_url/app_logo/custom_app.png", "homepageUrl": "https://www.google.com", "appCategory": "ecommerce", "intendedAudience": "private", "status": "pending", "whitelistedRedirectionUrls": [ "https://partners.myeshopbox.com/installation/redirecturl", "https://www.google.com" ], "appType": "general", "partnerCode": "507883", "workspace": "xyzcompany" }

d. The custom app will be visible on the app listing page with the other apps.

e. Store partnerCode and accountSlug from the account API response.

API URL: https://auth.auperator.co/api/v1/account?page=1&perPage=1000

Sample response:

{ "total": 2, "perPage": 1000, "data": [ { "country": "India", "workspace": "Eshopbox Ecommerce Private Limted", "partnerCode": null, "accountName": "Eshopbox Ecommerce Private Limted", "city": "Gurgaon", "contactPerson": null, "bankName": "Indusind Bank", "type": "0", "gstin": null, "branch": "UDYOG VIHAR PHASE-V", "workspaceStatus": "1", "cancelledChequeScannedCopy": "https://cdn.filestackcontent.com/KuXg0i8eR1uXrnlKYw0c", "stepsCompleted": 5, "createdAt": "2018-08-21T15:44:34.000Z", "contractUrl": null, "accountSlug": "eshop", "addressLine1": "270, Garage Society, AIHP Executive", "addressLine2": "Near Subhash Chowk, Sohna Road ", "id": 5, "state": "HARYANA", "ifscCode": "INDB0000540", "email": null, "updatedAt": "2021-08-12T11:38:57.000Z", "pincode": "122015", "updatedBy": "", "userAccountMappingId": 3776, "userAccountMappingRole": "admin", "panNumber": "AAFCB0498R", "accountNumber": "200999804102", "userAccountMappingStatus": "1", "workspaceType": "client", "phone": null, "createdBy": "", "warehouseId": null, "clientCode": "EEPL5", "pancardScannedCopy": "https://cdn.filestackcontent.com/L9ySpGSASTqJwEm2vnJ1", "status": "1" }, { "country": "India", "workspace": "Mohan Clothing Pvt Ltd", "partnerCode": null, "accountName": "Mohan Clothing Pvt Ltd", "city": "Gurgaon", "contactPerson": null, "bankName": "CITI BANK", "type": "0", "gstin": "06AAACM1374L1ZG", "branch": "CITI BANK", "workspaceStatus": "1", "cancelledChequeScannedCopy": "https://cdn.filestackcontent.com/FCzNR0XeStKUDeDVIrlf", "stepsCompleted": 5, "createdAt": "2018-08-21T15:44:41.000Z", "contractUrl": null, "accountSlug": "blackberrys", "addressLine1": "Khasra No. 31/18,19,20/1/1", "addressLine2": "Village -Tajnagar", "id": 6, "state": "HARYANA", "ifscCode": "CITI0000002", "email": "manish.srivastava@blackberrys.com", "updatedAt": "2020-12-18T11:47:31.000Z", "pincode": "122056", "updatedBy": "", "userAccountMappingId": 3515, "userAccountMappingRole": "admin", "panNumber": "AAACM1374L", "accountNumber": "710096023", "userAccountMappingStatus": "1", "workspaceType": "client", "phone": null, "createdBy": "", "warehouseId": null, "clientCode": "MCPL74L", "pancardScannedCopy": "https://cdn.filestackcontent.com/G6MMG1NJRdC9PxetjliL", "status": "1" }, "page": 1 }

f. Extract partnerCode from appListing API.

API url: https://esh148.myeshopbox.com/api/v1/appinstall

Sample response :

{ "per_page": "25", "total": "14", "data": [ { "appInstallationId": 67, "appVersionId": 8, "accountSlug": "esh148", "appId": 8, "title": "Zapier", "status": "installed", "intendedAudience": "public", "appStatus": "draft", "logoUrl": "https://storage.googleapis.com/esb-integration-engine-staging.appspot.com/App%20logos/zapier-logo.svg", "description": "The easiest way to automate your work. Zapier moves info between your web apps automatically, so you can focus on your most important work.", "clientId": "74bf26e479578fb8188e7954b8d5b36e", "appInstallationLink": "https://auth.myeshopbox.com/public/app-url/74bf26e479578fb8188e7954b8d5b36e", "businessName": "Zapier", "homePageUrl": "https://zapier.com", "contactEmail": "contact@zapier.com", "contactPhone": "", "createdAt": "2021-04-19 17:53:10.0", "updatedAt": "2021-04-19 17:53:10.0", "appType": "general", "partnerCode": "" }, { "appInstallationId": 143, "appVersionId": 11, "accountSlug": "esh148", "appId": 14, "title": "Myntra", "status": "installed", "intendedAudience": "public", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/esb-integration-engine-staging.appspot.com/App%20logos/myntra-logo.svg", "description": "Reach India's Most Fashionable Consumers", "clientId": "249d1b2c62c98fa3c47feee979f0554e", "appInstallationLink": "https://auth.myeshopbox.com/public/app-url/249d1b2c62c98fa3c47feee979f0554e", "businessName": "Eshopbox", "homePageUrl": "https://www.mynta.com/", "contactEmail": "", "contactPhone": "", "createdAt": "2021-07-23 16:58:14.0", "updatedAt": "2021-09-03 14:13:59.0", "appType": "sales_channel_app", "partnerCode": "" "connections": [ { "createdAt": "2021-07-23T17:00:08.000Z", "connectionId": 290, "connectionName": "Myntra PPMP", "isActive": "inactive", "updatedAt": "2021-07-23T17:00:08.000Z" }, { "createdAt": "2021-08-11T14:11:52.000Z", "connectionId": 357, "connectionName": "Myntra PPMP Design Review", "isActive": "inactive", "updatedAt": "2021-08-11T14:11:52.000Z" }, { "createdAt": "2021-09-16T09:44:56.000Z", "connectionId": 432, "connectionName": "Myntra PPMP", "isActive": "active", "updatedAt": "2021-09-16T09:44:56.000Z" }, { "createdAt": "2021-10-25T19:04:42.000Z", "connectionId": 528, "connectionName": "Myntra Angular 9", "isActive": "active", "updatedAt": "2021-10-25T19:04:42.000Z" }, { "createdAt": "2021-12-07T11:37:49.000Z", "connectionId": 644, "connectionName": "Test Myntra", "isActive": "active", "updatedAt": "2021-12-07T11:37:49.000Z" }, { "createdAt": "2021-12-07T11:38:52.000Z", "connectionId": 645, "connectionName": "Test Myntra", "isActive": "active", "updatedAt": "2021-12-07T11:38:52.000Z" } ] }, { "appInstallationId": 61, "appVersionId": 15, "accountSlug": "esh148", "appId": 18, "title": "Flipkart", "status": "installed", "intendedAudience": "public", "appStatus": "active", "logoUrl": "https://storage.googleapis.com/esb-integration-engine-staging.appspot.com/App%20logos/flipart-logo.svg", "description": "India’s leading platform for selling online", "clientId": "9e7f4cf27fca40fdc5ee8f3723f9be67", "appInstallationLink": "https://auth.myeshopbox.com/public/app-url/9e7f4cf27fca40fdc5ee8f3723f9be67", "businessName": "Eshopbox", "homePageUrl": "https://www.flipkart.com/", "contactEmail": "", "contactPhone": "", "createdAt": "2021-04-05 11:42:12.0", "updatedAt": "2021-04-05 11:42:12.0", "appType": "sales_channel_app", "partnerCode": "" "connections": [ { "createdAt": "2021-04-05T11:42:32.000Z", "connectionId": 16, "connectionName": null, "isActive": "inactive", "updatedAt": "2021-04-05T11:42:32.000Z" } ]

g. We will check for the partnerCode of the created app. If the partnerCode from both the APIs match then show the new custom app detail page UI.

On app detail page: to be discussed.

Related content