App Setup

Example - Woocommerce

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 table execute the below query.

INSERT INTO integration_types (integrationTypeId, integrationName, description)
VALUES (18, 'WOOCOMMERCE', 'Woocommerce Integration');

Step 2: Inserting Data into the Portal Table

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

INSERT INTO portals(externalPortalID, portal_name, isBrandStore,portalLogoUrl)
VALUES('WOO','Woocommerce',0,'https://storage.cloud.google.com/invoicefiles-staging/image/woocommercelogo.png
')

Step 3: Inserting Data into `integration_models` Table

To store information related to integrations, we need to make an entry in the iintegration_models table execute the below query.

INSERT INTO integration_models(portal_id, integration_model_name,integration_model_code,subText,channelProductCode,otherChannelDetails, refChannelLabel,uniware_sync,markUnavailbleTemplateUrl)
VALUES (X,'Woocommerce store','WOO','Fulfilled by Merchant model','productid','varationId')

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	Woocommerce
description	Fulfil Woocommerce orders seamlessly
homePageUrl	WooCommerce - Open Source ecommerce Platform
logoUrl	https://storage.cloud.google.com/invoicefiles-staging/image/woocommercelogo.png
intendedAudience	public
appCategory	Ecommerce
status	active
whitelistedRedirectionUrl	https.google.com
appType	sales_channel_app
externalPortalID	WOO
integrationModelCode	WOO

Request Body:

{
    "title": "Woocommerce",
    "description": "Fulfil Woocommerce orders seamlessly",
    "logoUrl": "https://storage.cloud.google.com/invoicefiles-staging/image/woocommercelogo.png",
    "homepageUrl": "https://woo.com/",
    "appCategory": "Ecommerce",
    "intendedAudience": "public",
    "whitelistedRedirectionUrls": [
        "https://google.com"
    ],
    "status": "active",
    "appType": "sales_channel_app",
    "externalPortalId": "WOO",
    "integrationModelCode": "WOO",
    "appUrl": "https://woo.com/"
}

Response Body:

{
    "id": 658,
    "appUrl": "https://woo.com/",
    "title": "Woocommerce",
    "description": "Fulfil Woocommerce orders seamlessly",
    "logoUrl": "https://storage.cloud.google.com/invoicefiles-staging/image/woocommercelogo.png",
    "homepageUrl": "https://woo.com/",
    "appCategory": "Ecommerce",
    "intendedAudience": "public",
    "status": "draft",
    "slug": "app658",
    "externalPortalId": "WOO",
    "integrationModelCode": "WOO",
    "credentials": {
        "clientId": "b2c16aa68d6f1ac5ca27f696ba64d6cc",
        "clientSecrets": [
            {
                "clientSecret": "1eeef55354ff072a92fce71a78c522f4",
                "createDate": "2024-01-09T07:08:16.271Z"
            }
        ]
    },
    "whitelistedRedirectionUrls": [
        "https://google.com",
        "https://auth.auperator.co/public/app-url/b2c16aa68d6f1ac5ca27f696ba64d6cc"
    ],
    "versions": {
        "latestVersion": "1.0.0",
        "allVersions": [
            "1.0.0"
        ]
    },
    "createdAt": "2024-01-09T07:08:16.271Z",
    "updatedAt": "2024-01-09T07:08:16.271Z",
    "partnerCode": "708602"
}

Woocommerce AppId-658

Step 4: Version

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": "658",
    "version": "1.0.0",
    "authentication": {
        "test": {
            "url": "http://{{bundle.inputData.store_name}}/wp-json/wc/v3/settings/general/woocommerce_currency",
            "method": "GET",
            "headers": {
                "consumer_key": " {{bundle.inputData.consumer_key}}",
                "consumer_secret": " {{bundle.inputData.consumer_secret}}"
            },
            "body": {},
            "removeMissingValuesFrom": {}
        },
        "oauth2Config": {
            "authorizeUrl": {
                "method": "GET",
                "url": "https://{{bundle.inputData.store_name}}/wc-auth/v1/authorize",
                "params": {
                    "app_name": "eshopbox",
                    "scope": "read_write",
                    "user_id": " {{bundle.inputData.appInstalltionId}}",
                    "return_url": "https://{{bundle.inputData.account_slug}}.auperator.co/dashboard/overview",
                    "callback_url": "https://shopify-integration-staging.el.r.appspot.com/_ah/api/esb/v1/test/tq/listen"
                }
            },
            "redirectUrl": "https://auth.auperator.co/app/connection/redirecturl/app658",
            "autoRefresh": true,
            "scope": "read_write"
        },
        "fields": [],
        "basicConfig": null,
        "type": "oauth2",
        "connectionLabel": "{{bundle.inputData.account_slug}}",
        "handleBar": "oauth2_658"
    },
    "isDeprecated": false
}

Response Body:

{
    "id": 679,
    "appId": 658,
    "version": "1.0.0",
    "authentication": {
        "test": {
            "url": "http://{{bundle.inputData.store_name}}/wp-json/wc/v3/settings/general/woocommerce_currency",
            "method": "GET",
            "headers": {
                "consumer_key": " {{bundle.inputData.consumer_key}}",
                "consumer_secret": " {{bundle.inputData.consumer_secret}}"
            },
            "body": {},
            "removeMissingValuesFrom": {}
        },
        "fields": [],
        "oauth2Config": {
            "authorizeUrl": {
                "method": "GET",
                "url": "https://{{bundle.inputData.store_name}}/wc-auth/v1/authorize",
                "params": {
                    "app_name": "eshopbox",
                    "scope": "read_write",
                    "user_id": " {{bundle.inputData.appInstalltionId}}",
                    "return_url": "https://{{bundle.inputData.account_slug}}.auperator.co/dashboard/overview",
                    "callback_url": "https://shopify-integration-staging.el.r.appspot.com/_ah/api/esb/v1/test/tq/listen"
                }
            },
            "redirectUrl": "https://auth.auperator.co/app/connection/redirecturl/app658",
            "autoRefresh": true,
            "scope": "read_write"
        },
        "basicConfig": null,
        "type": "oauth2",
        "connectionLabel": "{{bundle.inputData.account_slug}}",
        "handleBar": "oauth2_658",
        "createdAt": "2024-01-09T11:58:38.110+0000",
        "updatedAt": "2024-01-09T11:58:38.110+0000"
    },
    "isDeprecated": false,
    "createdAt": "2024-01-09T07:08:07.000Z",
    "updatedAt": "2024-01-09T07:08:07.000Z"
}

Step 5.- Create a field

https://building-blocks-dot-esb-platform-staging.appspot.com/_ah/api/esb/v1/oauth2_533/field

Request Body:

{
    "name": "Enter your Woocommerce store URL",
    "handleBar": "store_name",
    "description": "Authorize Eshopbox to access your Woocommerce store",
    "placeHolderText": "https://mystore.com",
    "fieldType": "SHORT_TEXT",
    "hasMultipleValues": false,
    "isRequired": true,
    "isEditable": true,
    "unEditableActions": [
        "oauth2_658"
    ],
    "isHidden": true,
    "sortKey": 1,
    "validations": {
        "isUnique": true,
        "acceptSpecificPattern": true,
        "patternType": "CUSTOM_PATTERN",
        "format": "^(\\w+)",
        "hasCustomLength": true,
        "maxLength": "123",
        "minLength": "12"
    }
}

Response body:

{
    "id": "659d3e49b8b5616b2f0937d4",
    "isCore": false,
    "buildingBlock": "oauth2_658",
    "action": "oauth2_658",
    "name": "Enter your Woocommerce store URL",
    "handleBar": "store_name",
    "description": "Authorize Eshopbox to access your Woocommerce store",
    "placeHolderText": "https://mystore.com",
    "fieldType": "SHORT_TEXT",
    "hasMultipleValues": false,
    "isRequired": true,
    "isEditable": true,
    "isHidden": true,
    "sortKey": 1,
    "validations": {
        "isUnique": true,
        "acceptSpecificPattern": true,
        "patternType": "CUSTOM_PATTERN",
        "format": "^(\\w+)",
        "hasCustomLength": true,
        "maxLength": "123",
        "minLength": "12"
    },
    "isVisible": true,
    "createdAt": "2024-01-09T18:08:33.702+05:30",
    "updatedAt": "2024-01-09T18:08:33.702+05:30"
}

Apps and Automations

App Setup

Step 1: Inserting Data into the Integration Model Table

Step 2: Inserting Data into the Portal Table

Step 3: Inserting Data into `integration_models` Table

Step 3: Create app

Step 4: Version

Step 5.- Create a field

Related content

App Setup

Step 1: Inserting Data into the Integration Model Table

Step 2: Inserting Data into the Portal Table

Step 3: Inserting Data into integration_models Table

Step 3: Create app

Step 4: Version

Step 5.- Create a field

Related content

Step 3: Inserting Data into `integration_models` Table