This page provides Business administrators a user guide for the App Marketplace microservice for the Infosys Equinox platform.

Page Contents

Getting Started

Developer Apps

Overview

Apps are plugins or pluggable components that add features or extend functionalities in the Infosys Equinox Commerce platform. These can be developed and hosted outside the platform and registered as an app in the Infosys Equinox App Marketplace microservice.

The functionalities are:

Developer Apps: Developer Apps is a shared space in the Foundation Admin Console where users can register, own, and manage apps for their business. You can maintain its configuration details and workflow as a business admin or marketplace admin. The app owners (business and marketplace place admins) can register, configure, manage, and publish apps to the App Marketplace. On the Developer Apps page, you can:
Apps Marketplace: The Apps Marketplace enables business admins or merchants to install published apps from the App Marketplace onto any of their stores, thereby adding new functionalities and experiences. On the App Marketplace apps page, you can:

Service Glossary

Business – the parent of a store or set of stores. The basic use of a business is to manage common sets of users, catalogs, and other services for the stores associated with the business.
Business Admin – a role that manages business settings, creates and manages stores, and enables microservice(s) for a business.
Developers – developers are the app owners who are invited by the super admin to the business to register their apps in Developer Apps.
Merchant – user who installs the app via the App Marketplace in their stores to enhance the features of their store.
Marketplace Admin – the user who can approve or reject apps.

Getting Started | App Marketplace

Developer Apps

The developer apps page allows,

Business Admin to:
- create new apps.
- update the app configuration.
- navigate to any newly created app and submit it for approval.
Marketplace Admin to:
- create new apps.
- update the app configuration.
- navigate to any created app and submit it for approval.
- approve and/or reject the apps.
- Publish and/or unpublish the apps.

Prerequisite

Before you begin, ensure the following:

The business where you need to register the apps is available in the Foundation Admin Console.
Note: Only super admins can manage the business. For more information, refer to Managing Business and Managing Teams.
You possess a valid role, such as business admin or marketplace admin, and the necessary credentials to access the required business in the Foundation Admin Console of the Infosys Equinox Commerce platform.
Note: For more information, refer to Managing Teams.
You have enabled the App Marketplace microservice. After enabling, the Developer Apps option will appear in the Foundation Admin Console. See Enabling or Disabling Microservices.

End-to-End Flow for Registering an App

This section explains the following:

App Developer Workflow diagram
Steps for Registering an App in the developer apps.

App Developer Workflow

Here is the illustration of the app developer workflow:

Steps for Registering an App

To register an app in the developer apps and publish it in the App Marketplace, follow these steps:

Log in to the Infosys Equinox Admin Console
Enable the App Marketplace
Create or register an app. As a business admin or marketplace admin, you can create an app by uploading the app details and its metadata (configuration details).
Update the metadata (configuration details) if required.
As part of App Approval Workflow:
1. Submit the app for approval.
2. As a marketplace admin, approve or reject an app, and then publish or unpublish an app.

The sequence of various workflow statuses for an app is as follows:

Created: the app is created and ready for approval processing.
Submitted: the app is submitted for approval.
Approved: the app is approved and can be published in the App Marketplace.
Rejected: the app is rejected and cannot be published in the App Marketplace.
Published: the app is published in the App Marketplace and ready for installation.
Unpublished: the app is unpublished and not ready for installation in the App Marketplace.

Managing the Developer Apps Landing Page

Viewing the Developer Apps Landing Page

As a business admin or marketplace admin, you can access the Developer Apps from the Foundation Admin Console.

To access the Developer Apps,

Log in to the Foundation service for your business (URL provided by Infosys Equinox).
In the All Business page, select a business for which the Developer Apps option is enabled.

Note: For enabling Developer Apps for a business, see Enabling the App Marketplace.
Click Developer Apps in the left navigation panel.

The Developer Apps landing page appears:

Note:
- The landing page displays the list of apps that are created for the logged-in (business ID) account.
- The apps are ordered based on the latest (latest to oldest) created/updated timestamp.
- You can view the app details such as App Image, App Name, App ID, App Version, Status, Visibility, and Category for each app in sortable columns.

Viewing the Details of an App

You can view the list of all apps created for a business.

To view the app details

Log in to the Foundation service for your business (URL provided by Infosys Equinox).
Click Developer Apps in the left navigation panel:
The Developer Apps landing page displays the list of apps that are created for a business.
Note: To create a new app, refer to Creating an App.
In the Developer Apps landing page, click on the required app. For example, BRAINTREE.

The selected app’s page appears.
Note: The selected app’s page displays,
- app basic details such as image/log, name, app description, and status of the app.
- app metadata (configuration details) such as app credentials, app configuration, webhooks, and app installs. For more information, refer to the table in the Update the Metadata Details of an App.

Configuring Search Parameters

Searching for App(s)

You can search for apps based on the App Name, App Status, and Visibility in the Developer Apps page.

To search for an app based on app category, app name, app status, and visibility.

Click the App Name, App Status, and/or Visibility option in the header to open an entry field to provide search criteria.
Note: For displaying a predefined number of apps per screen, see Selecting Predefined Rows.
Enter the desired search criteria in the search field, and then click the Go button:

The apps that match the search criteria appear.

Modifying Searchable Fields

To modify the searchable fields,

Click the vertical ellipse available at the beginning of the search field.
Select or deselect the items to add or remove the searchable fields in the header:

The selected searchable fields appear in the header:

Managing Apps in Developer Apps

The Developer Apps page enables a business admin or marketplace admin to manage both public and private apps.

Creating an App

As a business admin or marketplace admin, you can register (create) an app by uploading its details via a JSON file.

You can upload the following:

Basic app details such as image, logo, app name, app description, etc.
App metadata details such as app information, app credentials, add configuration, webhooks, app installs, and comments.

Prerequisite: Before you upload a document, you need to download the sample template (.json). You can fill in the required details in the downloaded file and then upload the updated app data in the predefined format to avoid errors.

The sequence of creating an app is as follows:

Navigate to the Developer Apps.
Download the Sample Template.
Uploading the data to the Developer Apps

To create an app,

Navigate to the Developer Apps page: Log in to the Foundation service for your business (URL provided by Infosys Equinox).
Click Developer Apps in the left navigation panel.
In the Developer Apps landing page, click Create App.

Download Sample Template: In the Create New App page, click the Download Template button.

Note:

The sample (.json) file is downloaded to your local computer. To view the complete sample app configuration data, click Sample App Configuration.

{
    "createAppRequest": {
        "appName": "ProvideYourAppNameHere",
        "appVersion": "1.0.0",
        "appKey": "appkey",
        "appShortDescription": "Provide your app short description here",
        "appSummary": "Provide your app Summary here",
        "appCategory": "Catalog",
        "pricingType": "FREE",
        "appDisplayType": "DESKTOP",
        "visibilityType": "PUBLIC",
        "developerOrg": "string",
        "appGoal": "string",
        "tags": [
            "string"
        ],
        "appSupport": {
            "email": "test@gmail.com",
            "phoneNumber": "0123456789"
        },
        "appImages": [
            {
                "type": "Image",
                "url": "https://sample/image.png",
                "remarks": "AppImage"
            }
        ],
        "properties": [
            {
                "locale": "",
                "name": "",
                "value": ""
            }
        ]
    },
    "appConfigurationRequest": {
        "createAppDescription": {
            "appDescriptionList": {
                "en_US": {
                    "ataGlance": "string",
                    "readMoreDescription": {
                        "section1": "string",
                        "section2": "string",
                        "section3": "string",
                        "section4": "string"
                    },
                    "characteristics": {
                        "category": "Tax",
                        "goal": "string",
                        "helpCenterUrl": "https://infosys.equinox.com",
                        "developedBy": "string"
                    }
                }
            }
        },
        "createAppConfig": {
            "apiConfig": [
                {
                    "action": "baseUrl",
                    "apiUrl": "https://sampleurl.com"
                }
            ],
            "appScopes": [
                {
                    "role": "ROLE_TAX_ADMIN",
                    "services": [
                        "tax"
                    ]
                }
            ],
            "properties": [
                {
                    "name": "String",
                    "value": "String"
                }
            ],
            "webhooksConfig": [
                {
                    "url": "https://sampleurl.com/callback",
                    "webhookType": "ASYNC",
                    "priority": "Normal",
                    "events": [
                        "catalogservice/product/create"
                    ]
                },
                {
                    "url": "https://sampleurl.com/payment/authorize",
                    "webhookType": "SYNC",
                    "events": [
                        "paymentservice/payment/authorize"
                    ]
                }
            ]
        },
        "appActivationInputData": {
            "uiSchema": {
                "title": "App Installation config page Title",
                "elements": [
                    {
                        "uiElement": "textbox",
                        "label": "Company Code",
                        "required": "true",
                        "default": "DEFAULT",
                        "minLength": 1,
                        "pattern": "^[^ ]{1,}$",
                        "key": "companyCode"
                    },
                    {
                        "uiElement": "dropdown",
                        "label": "Region",
                        "required": "true",
                        "default": "defaultValue",
                        "enum": [
                            "North America",
                            "Europe",
                            "Oceania"
                        ],
                        "key": "region"
                    },
                    {
                        "uiElement": "checkbox",
                        "label": "Checkbox",
                        "required": "false",
                        "default": "false",
                        "key": "checkbox"
                    }
                ]
            }
        }
    }
}

In the downloaded sample template, add the required app details and save it locally.
The app details and its metadata vary based on the apps. You can update the predefined fields based on the app. Ensure that you update the app details in the same format as in the template to avoid errors.

Configure App Meta Data: Refer to the table, which describes the app meta data configurations:

Attribute	Is Mandatory	Details and Conditions
appName	Yes	Indicates the name of an app. Ensure that you follow the given rules for naming an app: Minimum length: 3; Maximum length: 30 Only alphanumeric and spaces are allowed. Name should contain at least 3 alphanumeric characters.
appVersion*	Yes	Indicates the value of an app version number. Using this parameter, you can access different versions of the app. The version format is major.minor.patch. For example, 1.0.0
appKey*	Yes	Indicates the api key generated for the app.
appShortDescription	Yes	Indicates the “short description” of the app. This field accepts “string”.
appSummary	Yes	Indicates a short summary of the app. This field accepts “string”.
appCategory	Yes	Indicates the name of the category to which an app is associated. If an app’s functionality is related to a particular service, you can use the below app category names. This field accepts “string”. address auth cartcheckout catalog customer inventory list location loyalty merchandising notification order payment pricing promotion ratingsreviews search shipping subscription tax
pricingType	Yes	Indicates the pricing type of the app. You can provide any of the given values: FREE PAYING Note: For the 8.15 release, you can provide the value as “FREE”, since paid apps are not supported.
appDisplayType	Yes	Indicates the display type of the app. You can provide any of the given values: DESKTOP MOBILE BOTH
visibilityType	Yes	Indicates whether the app is Public or Private. Public: is available in the app marketplace after being published and is accessible across any business and stores. Private: is available only for a few businesses, and it is not available across the app marketplace store. The value should be either Public or Private. Note: In the 8.15 release, only public apps are supported.
developerOrg	Yes	Indicates the app developer or development team details, like name. This field accepts “string”.
appGoal	Yes	Displays the goal of the app, or you can provide the reason why the app has been developed. This field accepts “string”.
tags	optional	If required, you can provide the tag for the app.
appSupport: email	optional	Indicates the “email” for the merchants to contact for app support.
appSupport: phoneNumber	optional	Indicates the “phone number” for the merchants to contact for app support.
appImages	Yes	Holds the list of image details (URL, type, and remarks) for an app. Note: Each element in an array contains an element with a property such as: type: holds the type of image to display. URL: holds a valid URL address for the image. remarks: holds any remark for the image.
properties	Optional	Holds a list of properties for an app. Note: Each element in an array contains an element with a property such as: locale: holds the locale of the property. name: holds the name of the property. value: holds the value of property.

* The “appKey” and “appVersion” are unique parameters that identify the app and determine its version.

Configure the App Description: Refer to the table, which describes the details for app description:

Attribute	Is Mandatory	Details and Conditions
appDescriptionList: ataGlance	No	Indicates a very short description of the app. This field accepts “string”.
appDescriptionList: readMoreDescription	No	Indicates the app description or additional details in the “section” node. This field accepts “string”.
characteristics: category	No	Indicates the app category. This field accepts “string”.
characteristics: goal	No	Indicates the app goal. This field accepts “string”.
characteristics: helpCenterUrl	No	Indicates the URL for the merchants to access the app support. This field accepts “string”.
characteristics: developedBy	No	Indicates the developer organization name. This field accepts “string”.

Configure the Webhooks: Before you configure the webhooks, ensure that you configure the base URL. Refer to the tables, which describes the configuration details for webhook:

Base URL configuration

Attribute	Is Mandatory	Details and Conditions
apiConfig : action	No	Indicates the “baseUrl” to which the app is configured.
apiConfig : apiUrl	No	Indicates the “apiUrl” to which the app is configured

Webhook Configuration

Attribute	Is Mandatory	Details and Conditions
webhooksConfig : url	No	Indicates the “url” to which the webhook is name associated. It is the destination URL to which the webhook subscription sends the POST request when an event occurs.
webhooksConfig : webhookType	No	Indicates if it is an asynchronous or synchronous webhook. See Asynchronous Webhooks
webhooksConfig : priority	No	Indicates the webhooks priority.
webhooksConfig : events	No	Displays the events of multiple webhooks of different services that are configured to the app. See Events.

Configure the App Scopes and Roles: Refer to the table, which describes the configuration details for app scopes and roles:

Attribute

Is Mandatory

Details and Conditions

appScopes : roles

Indicates the roles based on scope.

Note: It is mandatory to provide roles based on the scope of an app. Based on the roles provided, the privileges for the apps to access the microservices are defined.

appScopes : Services

Indicates the scope of an app.

Note: It is mandatory to provide the scopes for an app (services to which the app can make a callback to update data).

Note: Apps can use various scopes and roles to call the Infosys Equinox microservices. The following table lists the app scopes and roles for app configuration:

SCOPE	ROLES
`Catalog`	`CATALOG_ADMIN`
	`ROLE_CATALOG_ADMIN`
	`ROLE_ACCOUNT_ADMIN`
	`ROLE_ACCOUNT_REP`
	`ROLE_MERCHANDISE_ADMIN`
	`ROLE_MERCHANDISE_EDITOR`
	`ROLE_PROMOTION_ADMIN`
	`ROLE_PROMOTION_EDITOR`
	`ROLE_CUSTOMER_ADMIN`
	`ROLE_CATALOG_EDITOR`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_GUEST`
	`ROLE_REG_USER`
	`ROLE_SELLER_USER`
`Accounts`	`ROLE_ACCOUNT_ADMIN`
	`ROLE_ACCOUNT_REP`
	`ROLE_STORE_OPERATOR`
	`ROLE_ACCOUNT_BUYER_ADMIN`
	`ROLE_ACCOUNT_BUYER`
	`ROLE_GUEST`
`Address`	`ROLE_ADDRESS_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_REG_USER`
	`ROLE_GUEST`
`Cart and checkout`	`ROLE_CART_ADMIN`
	`ROLE_CUSTOMER_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_REG_USER`
	`ROLE_GUEST`
`Customers (user)`	`ROLE_CUSTOMER_ADMIN`
	`ROLE_ACCOUNT_BUYER_ADMIN`
	`ROLE_ACCOUNT_ADMIN`
	`ROLE_ACCOUNT_REP`
	`ROLE_MERCHANDISE_ADMIN`
	`ROLE_MERCHANDISE_EDITOR`
	`ROLE_CATALOG_ADMIN`
	`ROLE_PROMOTION_ADMIN`
	`ROLE_PROMOTION_EDITOR`
	`ROLE_ORDER_ADMIN`
	`ROLE_PRICE_ADMIN`
	`ROLE_PRICE_EDITOR`
	`ROLE_CATALOG_EDITOR`
	`ROLE_LOYALTY_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_GUEST`
	`ROLE_REG_USER`
	`ROLE_CSR_ADMIN`
`Merchandising`	`ROLE_MERCHANDISE_ADMIN`
	`ROLE_MERCHANDISE_EDITOR`
	`ROLE_ACCOUNT_ADMIN`
	`ROLE_ACCOUNT_REP`
	`ROLE_STORE_OPERATOR`
`Lists`	`ROLE_LIST_ADMIN`
	`ROLE_REG_USER`
	`ROLE_GUEST`
`Location`	`LOCATION_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_STORE_OPERATOR`
	`ROLE_LOCATION_ADMIN`
	`ROLE_GUEST`
	`ROLE_REG_USER`
`Loyalty`	`ROLE_LOYALTY_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_SUPER_ADMIN`
	`ROLE_BUSINESS_ADMIN`
	`ROLE_REG_USER`
	`ROLE_GUEST`
`Notification`	`ROLE_MARKETING_MANAGER`
`Notification`	`ROLE_STORE_OPERATOR`
`Promotions`	`ROLE_PROMOTION_ADMIN`
	`ROLE_CUSTOMER_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_GUEST`
	`ROLE_REG_USER`
	`ROLE_PROMOTION_EDITOR`
`Payment`	`ROLE_PAYMENT_ADMIN`
	`ROLE_ACCOUNT_ADMIN`
	`ROLE_ACCOUNT_BUYER_ADMIN`
	`ROLE_ACCOUNT_REP`
	`ROLE_CUSTOMER_ADMIN`
	`ROLE_ORDER_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_ACCOUNT_BUYER`
	`ROLE_GUEST`
	`ROLE_REG_USER`
`Search`	`ROLE_SEARCH_ADMIN`
	`ROLE_ACCOUNT_ADMIN`
	`ROLE_ACCOUNT_REP`
	`ROLE_MERCHANDISE_ADMIN`
	`ROLE_MERCHANDISE_EDITOR`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_REG_USER`
	`ROLE_GUEST`
	`ROLE_ACCOUNT_BUYER_ADMIN`
	`ROLE_ACCOUNT_BUYER`
`Shipping`	`ROLE_SHIPPING_ADMIN`
	`ROLE_CUSTOMER_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_REG_USER`
	`ROLE_GUEST`
`Subscription`	`ROLE_SUBSCRIPTION_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_REG_USER`
	`ROLE_SUPER_ADMIN`
	`ROLE_BUSINESS_ADMIN`
`Tax`	`ROLE_TAX_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_REG_USER`
	`ROLE_GUEST`
`Pricing`	`PRICE_ADMIN`
	`ROLE_PRICE_ADMIN`
	`ROLE_ACCOUNT_ADMIN`
	`ROLE_ACCOUNT_BUYER_ADMIN`
	`ROLE_ACCOUNT_REP`
	`ROLE_CUSTOMER_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_PRICE_EDITOR`
	`ROLE_GUEST`
	`ROLE_REG_USER`
`App Marketplace`	`ROLE_BUSINESS_ADMIN`
	`ROLE_MARKETPLACE_ADMIN`
	`ROLE_PAYMENT_ADMIN`
	`ROLE_CATALOG_ADMIN`
	`ROLE_SHIPPING_ADMIN`
	`ROLE_MARKETPLACE_USER`
	`ROLE_GUEST`
	`ROLE_REG_USER`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_SUPER_ADMIN`
	`ROLE_BUSINESS_ADMIN`
	`ROLE_REG_USER`
	`ROLE_GUEST`
`Ratings and Reviews`	`ROLE_RATINGSREVIEWS_ADMIN`
	`ROLE_REG_USER`
	`ROLE_RATINGSANDREVIEWS_ADMIN`
	`ROLE_RATINGSANDREVIEWS_MODERATOR`
	`ROLE_RATINGSANDREVIEWS_VIEWER`
	`ROLE_GUEST`
	`ROLE_STORE_OPERATOR`
`Inventory`	`ROLE_CUSTOMER_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_SELLER_USER`
	`ROLE_ACCOUNT_BUYER_ADMIN`
`Order`	`ROLE_ORDER_ADMIN`
	`ROLE_ACCOUNT_ADMIN`
	`ROLE_ACCOUNT_REP`
	`ROLE_CUSTOMER_ADMIN`
	`ROLE_CSR_ADMIN`
	`ROLE_CSR_ASSOCIATE`
	`ROLE_STORE_OPERATOR`
	`ROLE_REG_USER`
	`ROLE_GUEST`
	`ROLEFRAUDAPPROVAL`
	`ROLECANCELAPPROVAL`
	`UPDATESHIPMENT`
	`ROLE_FRAUDAPPROVAL`
	`ROLE_CANCWL_APPROVAL`
	`ROLE_UPDATESHIPMENT`
	`ROLE_ACCOUNT_BUYER_ADMN`
	`ROLE_ACCOUNT_BUYER`

Configure the Input Data for App Installation: To activate an app, you must input specific data. The merchant or the user installing the app provides these configuration details. Include these details in the app activation input data section of the template. Refer to the table below, which describes the input data for app installation:

Attribute	Is Mandatory	Details and Conditions
title	No	Indicates the title of an app. This is displayed on the app installation configuration page in the admin screen. This field accepts “string”.
uiElement	No	Indicates the value for the UI (User Interface) element. You can provide any one of the given values. textbox dropdown checkbox multiselectlist
label	No	Indicates the name of the attribute that needs to be displayed in the installation configuration page in the admin screen. This field accepts “string”.
required	No	Indicates whether the value is mandatory or not. Values should be “true” or “false”.
default	No	Indicates the default value that needs to be populated for the attribute. This field accepts “string”.
minLength	No	Indicates the textbox Ui element for the minimum length condition.
pattern	No	Indicates the pattern for validation.
key	No	Indicates the attribute name that needs to be stored in database.

Uploading the data to the Developer Apps: In the Create New App page, to import the file, perform one of the following:
- Drag and drop the updated sample file (.json) from your local computer into the Import Document section.
  (or)
- Click the Add File button to upload the file from your local computer.
  
  Note: Once the file is uploaded, the imported history details appear. In the case of an error file, you need to re-upload the correct file.
Click Submit.

The app is created with an autogenerated unique app ID.

Note: On successful creation of app via app upload, the user is directed to the app detail page and APP INFORMATION tab in the app detail page. For information on viewing the metadata details of an app, see Updating the Metadata Details of an App.

Updating the Metadata of an App

As a business admin or a marketplace admin, you can update the existing metadata configuration details of an app.

Note: You can update the configuration details only until the app is in the Submit state.

To update the configuration details of an app,

Log in to the Foundation service for your business (URL provided by Infosys Equinox).
Click Developer Apps in the left navigation panel.
The Developer Apps landing page displays the list of apps that are created for a business:

Note: To create a new app, refer to Creating an App.
In the Developer Apps landing page, click on the required app.

The app details screen displays the app details, such as the image, name, app details, the status of the selected app, and the metadata details.
Click Update Configuration.

Note: The Update Configuration button appears only until the app is in Submit status.
In the Configure app with metadata page, click the Download Template.

Note: This template has predefined fields only for the metadata (configuration details). You cannot modify the app’s basic details, such as its name, image, etc.
To import the updated file, perform one of the following:
- Drag and drop the updated sample file (.json) from your local computer into the Import Document section.
  (or)
- Click the Add File button to upload the file from your local computer.
After a successful upload, click Submit.
Note: On successful creation of app via app upload, the user is directed to the app detail page and APP INFORMATION tab in the app detail page.
Click on each tab to view the updated configuration details:
- APP INFORMATION: The following app details are created:
  - App ID: Represents a unique ID that the system auto-generates during app creation.
  - App Version: Specifies the app’s version.
  - App Status: Shows the app’s status.
  - Visibility Type: Specifies the app’s type.
    - Public: Indicates the app is visible for all businesses.
    - Private: Indicates the app appears only to the business in which the app was created.
  - At a Glance: Provides a brief overview of the app.
  - Read More: Provides additional information about the app.
  - Category: Refers to the category with which an app is associated. For example, payment apps such as PayPal, Paytm, etc., belong to the “Payment” category.
  - Goal: Specifies the app’s objective.
  - Help Centre URL: Provides details about the app’s help center.
  - Developed By: Shows the details of the user who developed the app.
  - Activity: Provides information about the app’s activity.
- APP CREDENTIALS: API KEY AND SECERET KEY are generated for the app.

- - Generate Key: This key appears if the API KEY AND SECRET KEY are not available for the app. Click this key to generate the API KEY AND SECRET KEY for the app.
  - Regenerate Key: This key appears if the API KEY AND SECRET KEY are already available for the app. Click this key to regenerate the API KEY AND SECRET KEY for the app.

- APP CONFIGURATION: The following app details are configured:
  - Base URL: Displays the base URL to which the app is configured.
  - App Scopes: Displays the app’s scopes.
  - App Roles: Displays all the app roles associated with the app.
- WEBHOOKS: Displays the webhook details if the app is subscribed to the webhooks. You can view the list of webhook details configured by the app during its installation. The webhook details include:
  - Webhook Type: Indicates whether the webhook is asynchronous or synchronous.
  - Entity: Displays the entity associated with the webhook.
  - Events: Displays the events of multiple webhooks from different services configured to the app. Refer to the ‘Events’ section for more details.
  - Webhook URL: Displays the URL associated with the webhook.
- APP INSTALLS: Displays app installation details, including store ID, status, and installation timestamp, in sortable columns.
  
  App installation details are shown only after applying the required filters. To view all or specific installed app details:
  1. Select the required filters:
    - Store ID: Enter the store ID to view the details of all installed apps for a specific store. You can provide multiple store IDs as comma-separated values, for example, 186, 668.
    - Business ID: Enter the business ID to view the details of all installed apps for a specific business.
    - Status: Select a status such as:
      - Installed: Indicates that the app is installed and ready for activation. When an app is installed the required webhooks for it is created at the backend.
      - Activated: Indicates the app is activated and available for use. Only active apps are enabled in the storefront. When an app is activated, its webhooks in the backend are set in active state.
      - Deactivated: Indicates the app is deactivated and cannot be used unless it is activated again. When an app is deactivated, its webhooks in the backend becomes inactive; however, they can be made active upon reactivation.
      - Uninstalled: Indicates the app is uninstalled and cannot be used again. When an app is uninstalled, its webhooks in the backend are archived and cannot be used; however, when the app is reinstalled, a new set of webhooks is created in the backend.
  2. Click the GO button to view the details based on the search criteria.
- APP HISTORY: Shows the workflow history of the app.
- WEBHOOK LOGS: Shows the error logs for all the ASYNC and SYNC webhooks registered by the app for diagnostics.
  
  Webhook logs are shown only after applying the required filters. By default, the date range is set to the past 14 days, however, you can choose a different date range. To view the webhook log details,
  1. Select the required filters:
    - Webhook Type: Select a webhook type (such as ASYNC or SYNC) to search the webhook logs.
    - Store ID: Enter the store ID to view all webhook logs for a specific store.
    - Date Range: Specify a date range to view webhook logs for that period. By default, the date range is set to the past 14 days.
  2. Click the GO button to view the details based on the search criteria.
- PRIVATE APPS: The Private Apps tab is visible on the app’s detail page only if the app is registered as a private app during app configuration. It displays the list of businesses associated with the private app.
  - Associated Business ID: Displays the business ID associated with the private app.
  - Status: Indicates the association status of the private app with the business.
    - Active: Indicates that the private app is associated with the business.
    - Inactive: Indicates that the private app is not associated with the business.
  - Action: The toggle allows the association of the private app with the business to be enabled or disabled.
Click the Submit button once the configuration details are updated.
Note: The updated configuration details appear in the App Marketplace for the published apps.

App Approval Workflow

The sequence of various workflow statuses for an app is:

Submitting an App for Approval

As a business admin or a marketplace admin, you can submit the app for approval.

To submit an app for approval,

Log in to the Foundation service for your business (URL provided by Infosys Equinox).
Click Developer Apps in the left navigation panel.
The Developer Apps landing page displays the list of apps that are created for a business:

Note: To create a new app, refer to Creating an App.
In the Developer Apps landing page, click on the required app.
In the selected app’s page, click the Submit button for approval.

The app is submitted successfully.

Recalling an App

A business admin, marketplace admin, and super admin can recall a submitted app to update the configurations or submit the app later if required.

Note: You can recall only until an app is approved.

To recall an app,

Log in to the Foundation service for your business (URL provided by Infosys Equinox)
Click Developer Apps in the left navigation panel:

The Developer Apps landing page displays the list of apps,

Note: To create a new app, refer to Creating an App.
In the Developer Apps landing page, click on the required app.
In the <app name> page, click the Recall button to recall the app.

After a successful recall, the pop-up stating “App moved to created date” appears.
Note: An App that is recalled is changed to Created status for the user to update the configuration details and submit the app again. See Creating an App.

Approving an App

Only a Marketplace Admin can approve an app.

To approve an app,

Log in to the Foundation service for your business (URL provided by Infosys Equinox).
Click Developer Apps in the left navigation panel.
The Developer Apps landing page displays the list of apps that are created for a business.

Note: To create a new app, refer to Creating an App.
In the Developer Apps landing page, select the app that is in SUBMITTED state.
In the selected app’s page, click the Approve button to approve an app.

Note: The approved app status is changed to Publish. Refer to Publishing an App.

Rejecting an App

Only a Marketplace Admin can reject an app.

To reject an app,

Log in to the Foundation service for your business (URL provided by Infosys Equinox).
Click Developer Apps in the left navigation panel.
The Developer Apps landing page displays the list of apps that are created for a business:

Note: To create a new app, refer to Creating an App.
In the Developer Apps landing page, select the app that is in SUBMITTED state.
In the selected app’s page, click the Reject button to reject the app.
In the Reason to Reject page, provide valid comments for rejecting the app.
Click Submit.
The app status changes to Rejected.

Note: An app that is rejected is changed as Created for the user to update the configuration details. See Creating an App.

Publishing an App

As a business admin or a marketplace admin, you can publish an app to the App Marketplace.

The apps are categorized as:

Public: When you publish an app for a business, it becomes associated with all businesses and stores. Public apps are visible in all the stores and available for installation.
Private: When you publish an app for a business, it is associated only with that business and its stores.

To publish an app,

Log in to the Foundation service for your business (URL provided by Infosys Equinox).
Click Developer Apps in the left navigation panel.
The Developer Apps landing page displays the list of apps that are created for a business.

Note: To create a new app, refer to Creating an App.
In the Developer Apps landing page, select the app that is in APPROVED status.

Note: You can publish only the approved apps that are in publish status. To approve an app, refer to Approving an App.
In the selected app’s page, click the Publish button to publish the app.

The app is published.

Note: The published apps are moved to the App Marketplace for installation. Refer to Installing an App.

Unpublishing an App

The business admin or a marketplace admin can unpublish an app in the Developer Apps page, which removes the app from the Apps Manager page of the App Marketplace.

To unpublish an app,

Log in to the Foundation service for your business (URL provided by Infosys Equinox).
Click Developer Apps in the left navigation panel.
The Developer Apps landing page displays the list of apps that are created for a business:

Note: To create a new app, refer to Create an App.
In the Developer Apps landing page, select the app that is in PUBLISHED status.

Note: You can publish only the approved apps that are in publish status. To approve an app, refer to Approving an App.
In the selected app’s page, click Unpublish to unpublish the app.

Note: The unpublished app’s status changes to Publish to verify the configuration details.

App Marketplace

Developer Apps | Asynchronous Webhooks

This section explains the following:

End-to-End Flow for Installing an App
Enabling the App Marketplace
Managing App Marketplace

Prerequisite

Before you begin, ensure that you have:

a valid role, such as business admin or merchant, and the relevant credentials to access the required business in the Foundation Admin Console of the Infosys Equinox Commerce platform.
the required business within which you need to access the App Marketplace microservice is available in the Foundation Admin Console.

Note: Only super admins have the ability to manage the business. For information, refer to the sections Managing Business and Managing Teams.

End-to-End Flow for Installing an App

This section explains the following:

Merchant Workflow for the App Marketplace
Steps for Installing an App in the App Marketplace

Merchant Workflow for the App Marketplace

The merchant workflow in the App Marketplace is mentioned below:

Steps for Installing an App in the App Marketplace

To successfully install an app, you need to follow the steps given below:

Enable App Marketplace
Access the App Marketplace service via the Store Ops page.
View the list of published apps, or view the list of unpublished apps.
View the list of Installed apps.

Enabling the App Marketplace

Before you begin, ensure that you have associated the App Marketplace microservice with the required business in the Foundation Admin Console. Refer to the section Enabling or Disabling Microservices in the Foundation Admin User Guide.

Note: If necessary, you have the option to create a new business and associate the respective roles with it. For more information, refer to the section Managing Teams in the Foundation Admin User Guide.

Managing App Marketplace

In the App Marketplace, you can,

Access the App Marketplace console.
View the Details of an App
Configure the Search Parameters
Manage Apps via Apps Manager
- Viewing the Published Apps
- Installing an App
Manage Installed Apps
Manage Unpublished Apps
Manage Private Apps

Accessing the App Marketplace Console

The Infosys Equinox Commerce platform enables either a merchant or a business administrator to access the App Marketplace’s admin console for installing necessary apps.

To access the App Marketplace console,

Log in to the Foundation service for your business (URL provided by Infosys Equinox).
Click App Marketplace on the StoreOps page.

The Apps Manager landing page appears: