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

 

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: 

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,

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

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:

  1. Log in to the Infosys Equinox Admin Console
  2. Enable the App Marketplace
  3. 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).
  4. Update the metadata (configuration details) if required.
  5. 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:

  1. Created: the app is created and ready for approval processing.
  2. Submitted: the app is submitted for approval.
  3. Approved: the app is approved and can be published in the App Marketplace.
  4. Rejected: the app is rejected and cannot be published in the App Marketplace.
  5. Published: the app is published in the App Marketplace and ready for installation.
  6. 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,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. 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.
  3. 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

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. Click Developer Apps in the left navigation panel:
  3. 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.
  4. 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.

  1. 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.
  2. 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,

  1. Click the vertical ellipse available at the beginning of the search field.
  2. 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:

  1. Navigate to the Developer Apps.
  2. Download the Sample Template.
  3. Uploading the data to the Developer Apps

To create an app,

  1. Navigate to the Developer Apps page: Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. Click Developer Apps in the left navigation panel.
  3. In the Developer Apps landing page, click Create App.
  4. 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.
  5. 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.
  6. 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”.
  7. 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. 

  8. 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

    No

    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

    No

    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:

    SCOPEROLES
    CatalogCATALOG_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
    AccountsROLE_ACCOUNT_ADMIN
    ROLE_ACCOUNT_REP
    ROLE_STORE_OPERATOR
    ROLE_ACCOUNT_BUYER_ADMIN
    ROLE_ACCOUNT_BUYER
    ROLE_GUEST
    AddressROLE_ADDRESS_ADMIN
    ROLE_CSR_ADMIN
    ROLE_CSR_ASSOCIATE
    ROLE_STORE_OPERATOR
    ROLE_REG_USER
    ROLE_GUEST
    Cart and checkoutROLE_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
    MerchandisingROLE_MERCHANDISE_ADMIN
    ROLE_MERCHANDISE_EDITOR
    ROLE_ACCOUNT_ADMIN
    ROLE_ACCOUNT_REP
    ROLE_STORE_OPERATOR
    ListsROLE_LIST_ADMIN
    ROLE_REG_USER
    ROLE_GUEST
    LocationLOCATION_ADMIN
    ROLE_CSR_ADMIN
    ROLE_STORE_OPERATOR
    ROLE_LOCATION_ADMIN
    ROLE_GUEST
    ROLE_REG_USER
    LoyaltyROLE_LOYALTY_ADMIN
    ROLE_CSR_ADMIN
    ROLE_CSR_ASSOCIATE
    ROLE_STORE_OPERATOR
    ROLE_SUPER_ADMIN
    ROLE_BUSINESS_ADMIN
    ROLE_REG_USER
    ROLE_GUEST
    NotificationROLE_MARKETING_MANAGER
    ROLE_STORE_OPERATOR
    PromotionsROLE_PROMOTION_ADMIN
    ROLE_CUSTOMER_ADMIN
    ROLE_CSR_ADMIN
    ROLE_CSR_ASSOCIATE
    ROLE_STORE_OPERATOR
    ROLE_GUEST
    ROLE_REG_USER
    ROLE_PROMOTION_EDITOR
    PaymentROLE_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
    SearchROLE_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
    ShippingROLE_SHIPPING_ADMIN
    ROLE_CUSTOMER_ADMIN
    ROLE_CSR_ADMIN
    ROLE_CSR_ASSOCIATE
    ROLE_STORE_OPERATOR
    ROLE_REG_USER
    ROLE_GUEST
    SubscriptionROLE_SUBSCRIPTION_ADMIN
    ROLE_CSR_ADMIN
    ROLE_CSR_ASSOCIATE
    ROLE_STORE_OPERATOR
    ROLE_REG_USER
    ROLE_SUPER_ADMIN
    ROLE_BUSINESS_ADMIN
    TaxROLE_TAX_ADMIN
    ROLE_CSR_ADMIN
    ROLE_CSR_ASSOCIATE
    ROLE_STORE_OPERATOR
    ROLE_REG_USER
    ROLE_GUEST
    PricingPRICE_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 MarketplaceROLE_BUSINESS_ADMIN
    ROLE_MARKETPLACE_ADMIN
    ROLE_PAYMENT_ADMIN
    ROLE_CATALOG_ADMIN
    ROLE_SHIPPING_ADMIN
    ROLE_MARKETPLACE_USER
    ROLE_GUEST
    ROLE_REG_USER
    ROLE_RULESMANAGER_ADMIN
    Rules ManagerROLE_RULESMANAGER_ADMIN
    ROLE_CSR_ADMIN
    ROLE_CSR_ASSOCIATE
    ROLE_STORE_OPERATOR
    ROLE_SUPER_ADMIN
    ROLE_BUSINESS_ADMIN
    ROLE_REG_USER
    ROLE_GUEST
    Ratings and ReviewsROLE_RATINGSREVIEWS_ADMIN
    ROLE_REG_USER
    ROLE_RATINGSANDREVIEWS_ADMIN
    ROLE_RATINGSANDREVIEWS_MODERATOR
    ROLE_RATINGSANDREVIEWS_VIEWER
    ROLE_GUEST
    ROLE_STORE_OPERATOR
    InventoryROLE_CUSTOMER_ADMIN
    ROLE_CSR_ADMIN
    ROLE_CSR_ASSOCIATE
    ROLE_STORE_OPERATOR
    ROLE_SELLER_USER
    ROLE_ACCOUNT_BUYER_ADMIN
    OrderROLE_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

  9. 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.
  10. 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.
  11. Click Submit.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/developerappslandingpage.png
    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,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. 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.
  3. 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.
     
  4. Click Update Configuration.

    Note: The Update Configuration button appears only until the app is in Submit status.
  5. 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.
  6. 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.
  7. 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.
  8. 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 details of the app installation, such as store ID, status, and the timestamp of the app installation, in sortable columns. 
      • View Various App Statuses: Based on the app’s progress, you can view the following statuses: 
        • Installed: Indicates that the app is installed and ready for activation.
        • Activated: Indicates the app is activated and available for use. Only active apps are enabled in the storefront.
        • Deactivated: Indicates the app is deactivated, and it cannot be used unless it is activated again.
      • Filter by Store ID: Allows you to filter the app install data for an app by store ID.
        Note:
        • You can provide multiple store IDs as comma-separated values. For example, Store ID: 186, 668.
        • You can enter the store ID and click Go to display the filtered results based on the store ID.
      • Filter by Status: Allows you to filter the app install data for an app by status.
        Note: You can choose one of the values such as Installed, Activated, and Deactivated and click Go to display the filtered results based on the status.
    • COMMENTS: Displays the comments of the apps with respect to the status and version. 
    • 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.
  9. 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,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. 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.
  3. In the Developer Apps landing page, click on the required app.
  4. 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,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox)
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/webhookstab.png
  2. 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.
  3. In the Developer Apps landing page, click on the required app.
  4. 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,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. 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.
  3. In the Developer Apps landing page, click on the required app.
  4. In the selected app’s page, click the Approve button to approve an app.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/developerappslandingpage.png
    The app is approved successfully.

    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,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. 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.
  3. In the Developer Apps landing page, click on the required app.
  4. In the selected app’s page, click the Reject button to reject the app.
  5. In the Reason to Reject page, provide valid comments for rejecting the app.
  6. 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,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. Click Developer Apps in the left navigation panel.
    The Developer Apps landing page displays the list of apps that are created for a business.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/developerappslandingpage.png
    Note: To create a new app, refer to Creating an App.
  3. In the Developer Apps landing page, click on the required app.

    Note: You can publish only the approved apps that are in publish status. To approve an app, refer to Approving an App.
  4. 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,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. Click Developer Apps in the left navigation panel.
    The Developer Apps landing page displays the list of apps that are created for a business:
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/developerappslandingpage.png
    Note: To create a new app, refer to Create an App.
  3. In the Developer Apps landing page, click on the required app.

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

    The app is unpublished successfully.

    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:

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

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:

  1. Enable App Marketplace
  2. Access the App Marketplace service via the Store Ops page.
  3. View the list of published apps, or view the list of unpublished apps.
  4. 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,

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,

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

    The Apps Manager landing page appears:

Viewing the Details of an App 

Infosys Equinox Commerce platform allows a merchant or a business admin to view the details of the existing apps.

To access the App Marketplace console,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. Click App Marketplace on the StoreOps.
  3. In the Apps Manager landing page appears, click on the required app. For example, “ReviewsApp”.
  4. The app’s detail page enables a merchant or business user to view comprehensive information about the app, such as its name, category, and additional details including descriptions, developer, goal, and more. For more information:

    App Detail

    Description

    AT A GLANCE

    Displays the information of the app.

    READ MORE

    Displays more information about the app.

    CHARACTERISTICS

    The app’s characteristics are displayed in detail. These characteristics include: Displays the app’s characteristics in detail. These characteristics include:

    • Category: This refers to the category with which an app is associated. For example, payment apps such as PayPal and Paytm are associated with the ‘Payment’ category.
    • Goal: This displays the objective of the app.
    • Developed By: This displays the details of the user who developed the app.
    • Activity: This displays the app’s activity information.

    APP PERMISSIONS

    Apps are granted permissions to perform required tasks in the store where they are installed. The ‘Permissions’ tab lists the services, roles, and the privileges associated with each role for the relevant services.

    Note:

    • The list of services, roles, and privileges is displayed only if an app requests ‘app scopes’ and ‘app roles’. These requests are made during the upload of the app’s configuration details.
    • During the app’s installation, you can view the privileges that the app has access to. See Installing an App for more information.

    WEGHOOKS

    Displays the list of webhooks that the app configures during its installation. You can view details of each webhook, such as the event, entity, and type (asynchronous or synchronous).

     

    Note: You can view the webhook details only if the app is subscribed for the webhooks during configuration. See Adding Configuration Details for an App for more information.

Configuring Search Parameters

Searching for App(s)

You can search for apps based on the App Category, App Name, and Business Type in the Apps Manager page.

To search for an app based on app category, app name, and business type,

  1. Click the App Category, App Name, and/or Business Type 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.
  2. Enter the desired search criteria in the search field, and then click the Go button.
     
    The apps that match the search criteria appear.
    Note: In the Installed Apps page and Unpublished Apps page you can search for apps based on App Status and App Category.
    • Searching for Apps in the Installed Apps page:
    • Searching for Apps in the Unpublished Apps page:

Modifying Searchable Fields

To modify the searchable fields,

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

    The selected searchable fields appear in the header:

Selecting Predefined Rows

By default, 10 apps per screen will appear, but the number of apps per screen can be modified as follows:

  1. Click the vertical ellipse available at the beginning of the search field.
  2. Select Row Select. The Row Select appears as part of the search criteria.
  3. Select 10 Rows, 25 Rows, or 50 Rows from the drop-down option.
  4. Click the Go button. The selected rows of apps appear on the screen.
    Note: To reset the search field in the header, click the Reset button.

Apps Manager

The Apps Manager serves as an app store, enabling merchant/business users to browse through a list of published apps and install them.

Viewing the Published Apps

The list of published apps can be viewed on the Apps Manager page, which is the default landing page.

To view the published apps,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. Click App Marketplace on the StoreOps page.
  3. Navigate to the Apps Manager page.

    The Apps Manager page displays the list of published apps.

Installing an App

An app can be installed from the Apps Manager page. Upon successful installation, the app is available at the store level.

To install an app,

  1. Navigate to the Apps Manager page.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
    The list of published apps appears.
  2. Click on an app that you want to install.
  3. In the selected app’s page, click Install.
  4. In the confirmation pop-up screen, click Proceed.

    Upon successful installation, the selected app’s configuration details page appears.
    Note:
    • If the app is configured with app scopes, the app’s access privileges are displayed during the installation.
    • The installed apps are relocated to the Installed Apps page. For information on configuring an app, refer to the Adding Configuration Details for an App section.

Installed Apps

The Installed Apps page enables the merchant/business user to view the list of apps installed for a store. Additionally, this page lists the apps that have been either activated or deactivated post-installation.

Viewing the Installed Apps

The list of installed apps can be viewed in the Installed Apps page.

To view the installed apps,

  1. Navigate to the Apps Manager page.
  2. Click the Installed Apps tab in the left navigation panel.

    The Installed Apps page appears.

Adding Configuration Details of an App

You can enter the configuration details for an app once it has been successfully installed.

Note: The configuration details will vary depending on the app.

To add configuration details for an app,

  1. Navigate to the Apps Manager page.

  2. Click the Installed Apps tab in the left navigation panel.

    The Installed Apps page appears.
  3. Click on an app that is INSTALLED.
  4. In the selected app’s page, click Configuration Details.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
    The selected app’s Configurations page appears:
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
  5. In the selected app’s Configurations page, under Activation, select Activate and configure the following:
    • In the Merchant ID field, enter the valid merchant ID.
    • In the Environment field, click the drop-down and select the required environment.
    • Check the Enable 3D Secure Payments
      Note: The above configuration details vary based on the app. The configuration details for an app are uploaded in JSON format while creating an app. Refer to Creating an App and Updating the Configuration Details of an App.
  6. Click Save.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
    The app is activated successfully

Activating an Installed App

You can activate an app once it is in the installed state.

To activate an installed app,

  1. Navigate to the Apps Manager page.
  2. Click Installed Apps tab in the left navigation panel.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
    The Installed Apps page displays the list of installed apps.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
  3. In the Installed Apps page, click the INSTALLED app.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/login.png
  4. In the selected app’s page, click Configuration Details.

    The selected app’s Configurations page appears:
  5. In the selected app’s Configurations page, under Activation, select Activate.
  6. Click Save.
    Note: The Save button is enabled only after the user provide the values for all the mandatory fields in the installation configuration page

    The app is activated successfully.

Deactivating an Activated App

You can deactivate an app that is currently active.

To deactivate an installed app,

  1. Navigate to the Apps Manager page.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
  2. Click the Installed Apps tab in the left navigation panel.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
    The Installed Apps page appears.
  3. Click on an app that is ACTIVATED.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
  4. In the selected app’s page, click Configuration Details.
  5. In the selected app’s Configurations page, select Deactivate and click Save.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
    The app is deactivated.

Uninstalling an App

You can uninstall an app from the store.

To uninstall an app,

  1. Navigate to the Apps Manager page.
  2. Click on the Installed Apps tab in the left navigation panel.

    The Installed Apps page appears.
  3. Click on an app that you want to uninstall.
  4. In the selected app’s page, click Configuration Details.  
  5. In the selected app’s Configurations page, select Uninstall.
  6. In the confirmation page, click Uninstall.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
    The app is uninstalled and removed from the Installed Apps.

Unpublished Apps

Unpublished apps are those created exclusively for the business you are currently logged into. This page displays the apps that a business admin or a marketplace admin has not published on the Developer Apps page.

The Unpublished Apps page enables users to test the registered apps by installing them.

Prerequisite:

Before you begin, ensure that the app is successfully registered on the Developer Apps page. For more information, refer to the “Creating an App” section in the Foundation Admin User Guide.

Viewing the Unpublished Apps

You can view the list of unpublished apps on the Unpublished Apps page.

To view the unpublished apps,

  1. Navigate to the Apps Manager page.
  2. Click on the Unpublished Apps tab in the left navigation panel.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
    The Unpublished Apps page appears: 
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png

Validating an Unpublished App

To validate an unpublished app,

  1. Navigate to the Apps Manager page.
    The list of published apps appears.
  2. Click the Unpublished Apps tab in the left navigation panel.
    The list of Unpublished Apps page appears:
  3. In the Unpublished Apps page, click on the app that you want to validate.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
  4. In the selected app’s page, click Install.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
  5. In the confirmation screen, click Proceed.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8150/enableappmarketplace.png
    The status of the app is displayed.

Installing an Unpublished App

You can install an unpublished app from the Unpublished Apps page. Once the installation is successful the app is installed at the store level.

To install an unpublished app,

  1. Navigate to the Unpublished Apps.
    https://duseqpxtuo98y.cloudfront.net/guide-appmarketplace8160/enableappmarketplace1.png
  2. In the Unpublished Apps page, click on an unpublished app that you want to install.
  3. In the selected app’s page, click Install.
  4. In the confirmation screen, click Proceed.
     
    Note: The app’s access privileges are displayed during the installation if the app is configured with the app scopes.
    The app is successfully installed, and the selected app’s configuration detail page appears.

    Note: The installed apps are moved to the Installed Apps. For information on configuring an app, refer to the Adding Configuration Details for an App section.

Private Apps

Merchants can access the list of private apps enabled for their businesses via the Private Apps page. The Private Apps page displays the list of private apps that are accessible for the logged-in business. Only the published private apps accessible by the logged-in business are displayed.

This page is accessible only by the roles ROLE_BUSINESS_ADMIN, ROLE_MARKETPLACE_ADMIN, and SUPER ADMIN.

Merchants can access the list of private apps enabled for their businesses via the Private Apps page. The Private Apps page displays the list of private apps that are accessible for the logged in business. Only the published private apps accessible by the logged in business are displayed.

This page is accessible only by the roles ROLE_BUSINESS_ADMIN, ROLE_MARKETPLACE_ADMIN, and SUPER ADMIN.

Prerequisite:

Before you begin,

  • Verify if the logged-in business has an association entry in the private app’s entity.
  • Ensure that the app is successfully registered on the Developer Apps page. For information, refer to the “Creating an App” section in the Foundation Admin User Guide.

Viewing the Private Apps

You can view the list of published private apps that are accessible for the business that you have logged in.

To view the private apps,

  1. Click the Private Apps tab in the left navigation panel.

    The Private Apps page appears:
       
    Note:
    • Private apps are listed in order, from the most recently created or updated to the oldest.
    • Each app display includes the app’s name, associated category, and image.

Installing a Private App

You can install a private app from the Private Apps page. Once the installation is successful the app is installed at the store level.

To install a private app,

  1. Navigate to the Private Apps.

    A list of private apps appears.
  2. Click on a private app that you want to install.

Viewing and updating the Configuration Details of a Private App

You can view and update the configuration details of a private app from the Private Apps page.

To view and update the configuration details of a private app,

  1. Navigate to the Private Apps.

    A list of private apps appears.
  2. Click on a private app.
  3. In the selected app’s page, click Configuration Details.

    Note: First you need to install the app if the Install button appears.
    The configuration details of the selected app appear.

    Note:
    • If required, you can update the configuration details.
    • To uninstall the app, click on the Uninstall button. For more information, see Uninstalling an App.

Associating a Private App to Other Businesses

Private apps are only associated with the businesses that publish them and the stores that are associated with that business. The developer owning a private app can associate it with other businesses from the app’s detail page in the Developer Apps page.

To associate a private app to other businesses,

  1. Log in to the Foundation service for your business (URL provided by Infosys Equinox).
  2. 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.
  3. In the Developer Apps landing page, click on the required private app.
  4. In the text field against the Associate button, enter the business ID and click Associate.

    Note:
    • The text field and the associate button appear only if the app is a private app.
    • You can enter multiple business IDs by separating them with commas.
      The message “App associated successfully” appears.

 

Revision History | top
 

 

Revision History
2024-08-04 | JP – Improved the content using AI.
2024-05-18 | SW – Created the document for the release 8.17.0
2024-01-02 | SW – Created the document for the release 8.16.0
2023-10-10 | SW – Created the document for the release 8.15.0