Create App

Creating an app is an important step to automate a workflow that connects your app with the Eshopbox platform.

To create app in Eshopbox please follow the below steps.

Step 1: Inserting Data into the Integration Model Table

To store information related to integrations, we need to make an entry in the Integration Model about IntegrationtypeId, IntegrationName

Step 2: Inserting Data into the Portal Table

To store information related to integrations, we need to make an entry in the Portal table portalname.

Step 3: Inserting Data into Integration_type Table

To store information related to integrations, we need to make an entry in the integration type about integration_model_name, code etc.

Once we make entries in this table we can now call the APP API for creating app in eshopbox.

Step 3: Create app

Create an app on partner dashboard using API request and enter all the body parameters.
Set the intendedAudience parameter as Public and status as Active to make your app available at workspace.

https://partners.eshopbox.com/api/v1/app

Body Parameters Required:

Attributes	Description

Attributes	Description
title	title of App
description	description to be displayed in App
homePageUrl	siteurl
logoUrl	App-logo URL
intendedAudience	public/private
appCategory	Ecommerce platforms
status	active
whitelistedRedirectionUrl	https.google.com
appType	sales_channel_app
externalPortalID	saved in DB while executing above 3 queries
integrationModelCode	saved in DB while executing above 3 queries

Sample Response:

{
    "id": 218,
    "appUrl": "https://www.shopify.in",
    "title": "BrizeCooler Shopify Store",
    "description": "The all-in-one commerce platform to start, run, and grow a business",
    "logoUrl": "https://storage.googleapis.com/esb-integration-engine-staging.appspot.com/App%20logos/shopify-logo.svg",
    "homepageUrl": "https://www.shopify.in",
    "appCategory": "ecommerce",
    "intendedAudience": "private",
    "status": "draft",
    "slug": "app218",
    "externalPortalId": "SHP",
    "integrationModelCode": "BZCLRSHOP",
    "credentials": {
        "clientId": "bbf81b47ed3651ec300696f17aa41d6d",
        "clientSecrets": [
            {
                "clientSecret": "a3cb19f29d37673d43250ca0ac85331a",
                "createDate": "2023-02-03T05:54:14.786Z"
            }
        ]
    },
    "whitelistedRedirectionUrls": [
        "https://google.com",
        "https://auth.myeshopbox.com/public/app-redirecturl/bbf81b47ed3651ec300696f17aa41d6d"
    ],
    "versions": {
        "latestVersion": "1.0.0",
        "allVersions": [
            "1.0.0"
        ]
    },
    "createdAt": "2023-02-03T05:54:14.786Z",
    "updatedAt": "2023-02-03T05:54:14.786Z",
    "partnerCode": "431895"
}

Once we call the create app API, then we create the version but before that will need to decide the auth configuration of app. Please check the auth configuration which we followed according to eshopbox auth which is API Key Auth, Basic Auth, OAuth v2.
Please refer Configure Auth

Step 4: Version

Once the auth is decided we can call the version API and configure the selected auth.

We need to create a version of the app. Initially it is ‘1.0.0’ and later on it is upgraded correspondingly with the modifications of the app. The version can be updated using the put API:

PUT 'https://partners.myeshopbox.com/api/v1/app/{{appId}}/version/{{version}}'

Request Body

{
    "appId": "appId",
    "version": "1.0.0",
     "test": {
            "Authorization": {
               "Username":"{{clientId}}",
               "Password":"{{clientsecret}}"
            },
            "method": "GET",
            "body": {},
            "removeMissingValuesFrom": {},
            "url": "http://{{bundle.inputData.store_name}}/wp-json/wc/v3/settings/general/woocommerce_currency"
        },
    "authentication": {
        "oauth2Config": {
            "authorizeUrl": {
                "method": "GET",
                "url": "https://{{bundle.inputData.store_name}}/wc-auth/v1/authorize",
                "params": {
                   "app_name": "eshopbox",
                   "scope":"read_write",
                   "user_id":"appinstalltionId",
                   "return_url" : "https://electronicsell.auperator.co/dashboard/overview",
                    "callback_url":"https://electronicsell.auperator.co/dashboard/overview"
      }
            },
            "redirectUrl": "https://auth.myeshopbox.com/app/connection/redirecturl/appappId",
            "autoRefresh": true,
             "scope":"read_write"
            
        },
        "basicConfig": null,
        "type": "oauth2",
        "connectionLabel": "{{bundle.inputData.account_slug}}",
        "handleBar": "oauth2_appId"
    },
    "isDeprecated": false
}

Apps and Automations