Create a custom app
- Shubham Gupta (Unlicensed)
The Below Table explains the description of each Block present in the Sequence Diagram
Component | Infra Description |
FrontEnd(UI) | UI Component |
Default Service | App Engine Service Name: Default Service esb-integration-engine-prod |
Create Partner | App Engine Service Name: Default Service esb-integration-engine-prod Method Name: createPartnerAccount |
Create Workspace | App Engine Service Name: Default Service esb-integration-engine-prod Method Name: createAccountByCallClientpotral |
Create App | App Engine Service Name: Default Service esb-integration-engine-prod Method name: createApp |
Step1. We will receive a request from Frontend to create a custom app either on the existing workspace or on a new Development Workspace.
Only for “customapp” API replace “partners” by “accountSlug” in API.
Endpoint: “https://{{accountSlug}}.myeshopbox.com/api/v1/customapp“
Request Body:
{
"appName": "testShubham",
"description": "testShubham",
"workspace": "testShubham",
"isDevelopmentWorkspace": true
}Step2. Extract Attributes UserID, EmailID, Account Slug, role, and Authorization.
Step3. First for creating an app we need to first create a Partner account. Prepare request body for creating a partner and pass it to the createPartnerAccount method in Default Service.
Request Body:
{
"businessName": "ABC Tech Ltd.",
"goal": "process",
"address": {
"pincode": "121001",
"city": "New Delhi",
"countryCode": "IN",
"addressLine1": "H-123, Lawrence Road",
"addressLine2": "New Delhi",
"stateCode": "DL"
},
"contact": {
"phone": "989898988",
"email": "contact@test.com"
},
"emergencyContact": {
"phone": "99999999888",
"email": "support@test.com"
}
}Response Body:
{
"businessName": "ABC Tech Ltd.",
"goal": "process",
"partnerCode": "826831",
"address": {
"pincode": "121001",
"city": "New Delhi",
"countryCode": "IN",
"addressLine1": "H-123, Lawrence Road",
"addressLine2": "New Delhi",
"stateCode": "DL"
},
"contact": {
"phone": "989898988",
"email": "contact@test.com"
},
"emergencyContact": {
"phone": "99999999888",
"email": "support@test.com"
},
"createdAt": "2021-11-25 13:52:42",
"updatedAt": "2021-11-25 13:52:42"
}Step4. On receiving a successful response from create partner method move to the next step else throw the error.
Step5. Extract key "isDevelopmentWorkspace" from the request received from the frontend. If the value of “isDevelopmentWorkspace” is true then only create a new Development workspace else the app will be created on the existing workspace.
Step6. Extract “partnerCode” from the response of create partner method and prepare request body for creating the development workspace.
Request Body:
{
"accountName": "testShubham",
"partnerCode": "358764",
"isDevelopmentWorkspace":true
}Step7. If the workspace is created successfully then we will receive a successful response else we will get an error response.
Success Response:
{
"id": "1",
"accountName": "Test Account Name",
"accountSlug": "testaccount",
"status": "0",
"clientCode": "TS001",
"stepsCompleted": "1",
"workspaceStatus": "1",
"addressLine1": "Address Line 1",
"addressLine2": "Address Line 2",
"city": "City",
"state": "State",
"country": "Country",
"pincode": "12345678",
"email": "test@gmail.com",
"phone": "1231234",
"panNumber": "23123",
"pancardScannedCopy": "URL",
"accountNumber": "35464212154",
"bankName": "SBI",
"ifscCode": "IFSCCODE15",
"branch": "sec14",
"cancelledChequeScannedCopy": "URL",
"contactPerson": "test user",
"contractUrl": "URL",
"createdAt": "2019-04-08T12:41:05.000+05:30",
"updatedAt": "2019-04-08T12:41:05.000+05:30"
}Error Response:
{error:{
code=412.0
message=Something went wrong, please try again after some time.,
errors=[{
reason=conditionNotMet,
domain=global,
message=Something went wrong, please try again after some time.
}]
}
}Step8. Extract appName and description from the request received from frontend and prepare \n request body for creating an app. Pass the request body to create app method.
Request Body:
{
"title": {{appName}},
"description": {{description}},
"logoUrl": "https://storage.googleapis.com/logo_url/app_logo/custom_app.png",
"intendedAudience": "private",
"homepageUrl": "https://www.google.com",
"appCategory": "ecommerce",
"status": "pending",
"appUrl": "https://www.mynta.com/",
"whitelistedRedirectionUrls": [
"https://partners.myeshopbox.com/installation/redirecturl",
"https://www.google.com"
]
}Response Body:
{
"id": 77470,
"status": "pending",
"title": "Eshopbox",
"description": "Eshopbox offers simple, fast, and tech-enabled fulfillment for ambitious e-commerce businesses with its network of fulfillment centers across India.",
"logoUrl": "https://cdn.zapier.com/storage/developer_cli/4ff940ea5c71895003537746c971b1eb.png",
"slug": "app77470",
"intendedAudience": "public",
"homepageUrl": "https://eshopbox.com",
"appCategory": "ecommerce",
"versions": {
"latestVersion": "1.0.0",
"allVersions": [
"1.0.0"
]
},
"portalId": 21,
"integrationModelId": 31,
"credentials": {
"clientId": "ca72fc2eff2cd990c46863b4852f058b",
"clientSecrets": [
{
"clientSecret1": "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",
"createDate": "2019-12-23T15:27:13+00:00"
},
{
"clientSecret2": "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",
"createDate": "2019-12-23T15:27:13+00:00"
}
]
},
"whitelistedRedirectionUrls": [
"https://test1.com",
"https://test2.com"
],
"meta": {
"tagLine": "",
"twitterUsername": "",
"expectedResponseTime": "",
"documentationUrl": "",
"appFeatureDetails": "",
"screenshotUrls": [],
"notes": "",
"marketingDetails": {
"email": "",
"number": ""
},
"technicalDetails": {
"email": "",
"number": ""
},
"testAccountDetails": {
"username": "",
"password": ""
}
},
"externalPortalId": "",
"integrationModelCode": "",
"createdAt": "2019-12-23 00:00:00",
"updatedAt": "2019-12-23 00:00:00"
}Step9. If the app is created successfully then prepare the response to be send to Frontend from the endpoint else in case of any error throw the error.
Response from the Endpoint:
{
"partnerCode": "",
"workspace": "",
"id": 77470,
"status": "pending",
"title": "Eshopbox",
"description": "Eshopbox offers simple, fast, and tech-enabled fulfillment for ambitious e-commerce businesses with its network of fulfillment centers across India.",
"logoUrl": "https://cdn.zapier.com/storage/developer_cli/4ff940ea5c71895003537746c971b1eb.png",
"slug": "app77470",
"intendedAudience": "public",
"homepageUrl": "https://eshopbox.com",
"appCategory": "ecommerce",
"versions": {
"latestVersion": "1.0.0",
"allVersions": [
"1.0.0"
]
},
"portalId": 21,
"integrationModelId": 31,
"credentials": {
"clientId": "ca72fc2eff2cd990c46863b4852f058b",
"clientSecrets": [
{
"clientSecret1": "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",
"createDate": "2019-12-23T15:27:13+00:00"
},
{
"clientSecret2": "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",
"createDate": "2019-12-23T15:27:13+00:00"
}
]
},
"whitelistedRedirectionUrls": [
"https://test1.com",
"https://test2.com"
],
"meta": {
"tagLine": "",
"twitterUsername": "",
"expectedResponseTime": "",
"documentationUrl": "",
"appFeatureDetails": "",
"screenshotUrls": [],
"notes": "",
"marketingDetails": {
"email": "",
"number": ""
},
"technicalDetails": {
"email": "",
"number": ""
},
"testAccountDetails": {
"username": "",
"password": ""
}
},
"externalPortalId": "",
"integrationModelCode": "",
"createdAt": "2019-12-23 00:00:00",
"updatedAt": "2019-12-23 00:00:00"
}
//================================================================
if “isDevelopmentWorkspace“==true then flow will remain unchanged.
Create a new partner code and update partner code against new development workspace in DB.
use workspace from requestBody received from frontend.
if “isDevelopmentWorkspace“ ==false, then use accountslug(workspace from session) from sessions
check if partnerCode is present in DB or not.
if present(not null) then directly create app using partnerCode fetched from DB
else create partner , update the partnerCode in DB against accountSlug(workspace from session) and then create app.
3. App Installation:
return appInstallationUrl against workspace.
4. Frontend:
in case of “isDevelopmentWorkspace“==true FE has to set accountSlug in cookies.