This document explains MarketPlace, LINGA’s latest integration.
Requirement
· The screen option Integration Partners should be available when logged in as Super Admin.
· When new integration comes, the integration should be registered in the admin page.
· Based on the information, the details will be shown to the customers on their stores
Implementation in Admin Page
Page Navigation: Log in as Admin > Integration Partners
Integration Partners
The Integrations subscribed by the Admin that will be shown on this page. To subscribe a new Integration Partner, click + New Integration Partner.
· Category: The category that Integration is under, defined by the admin when adding the new Partner.
· Name: Name of the Integration, defined by the admin when adding the new Partner.
· Code: Code defined by the admin, unique to the particular Integration Partner.
· Link: A Link to the integration Partner’s page.
· Subscription Required: If the Integration Partner requires a Subscription.
· Available Service Types: The Service Type (Full service, Quick Service) determined by the Admin.
· Actions: There is an option to Update (Pencil icon) or Delete (Trash Can icon) a Partner.
· Active: All Integration Partners shown are Active status.
· Rows per page: Dropdown to select how many Integration Partners will show per page.
· Sorting option: To sort any category, click the up (Ascending) or Down (Descending) arrow.
· Pagination: Based on the rows per page, click a page number to navigate to that page.
· Scrollbar: Move the scrollbar left or right to view the entire Integration Partners screen.
· Search: Seach by Category or Name.
· Columns: Filter Integration Partners by Column values.
· + New Integration Partner: Button at the top-right of the screen to add a new Integration Partner. An Admin will enter basic details about the Integration Partner.
Pre-Requisite
Page Navigation: Admin > Integration Partners > New Integration Partner
The page that appears when + New Integration Partner is clicked. An Admin will be able to add the new Partner’s details.
· Logo: The Partner’s logo - upload an image (up to 2MB, 400 x 400 pixels)
v Name: (Mandatory) Name of the Partner (50 letters maximum).
v Code: (Mandatory) Unique code for the Partner (5 character minimum, numbers and letters accepted).
v Category: (Mandatory) Dropdown selection (including Search) based on the Integration type.
v Landing Page URL: (Mandatory) A link to navigate to the Partner’s page. Must be in https://abcd.com format.
v Available Countries: (Mandatory) Selections (one or more) based on the Partner’s global availability.
v Available business types: Categorized based on the Restaurant/Retail business type (one or more).
v Subscription Required: Disabled (NO) by default. When Enabled (YES), the Partner is available for adding as a Subscription. When Disabled, it can’t be subscribed to.
v Description: A more detailed Description of the Partner is entered here (minimum 240 characters).
v Integration Details: Based on the provided API the data will be Sent/Received (Coming Soon).
v Validate Credentials: Disabled (NO) by default. If Enabled (YES), while Configuring or implementing the Integration, the sender or receiver may provide their Credentials. (Coming Soon).
v Form Elements:
v Form Element: How the data is to be transferred (Input or Output) by selecting from the dropdown.
v Data Type: The type of Input we are going to give (Text, Number, or Password).
v Label: The label for the integration partner will be provided, based on the label name it will be displayed while integrating.
v Required: Toggle to determine whether a field is Mandatory or Optional.
v Key Value: For the element, the value for assigning the Table to place the values.
v Default Value: For the element, the value that is automatically taken while configuring the integration.
v Is Account Level: Whether the element is for store level or enterprise level, based on that the user can enable or disable this functionality.
v Delete: Button to Delete an element.
v + Form Element: Button to Add an element.
v Instructions: Additional details to convey to the user about integrating the Partner.
v Delete: Button to delete an Integration’s Instructions.
v + Instruction: Button to Add Instructions for an Integration.
Implementation in Backoffice
Page Navigation: Log into My Store > Upgrade > Manage Plan
v Enterprise Level - At the Enterprise level, the user can choose which store(s) will implement Marketplace. The new Addon (Marketplace) will be added to Addons per Site, based on the Stores that will use Marketplace, the license count (Site Qty) can be added.
v License: After subscribing, the User (Enterprise level) can give permission (Store level) to use Marketplace by sliding the toggle to the Right (On). After confirming the stores that will use Marketplace, click Save. The confirmation message ‘License settings saved successfully’ appears.
v Note: If the customer buys Marketplace for 1 Subscription, it will be available for only 1 store. The customer can Enable a Marketplace toggle based on the store, but attempting to toggle any additional store the slider will automatically be Disabled. If the customer buys additional Integrations, it will show how many Stores can add Marketplace.
v Pro Level - At the Pro Level, the user can choose only 1 Marketplace Integration for a single Store.
v License: After subscribing, the User (Pro level) can give permission (Store level) to use Marketplace by sliding the toggle to the Right (On). After confirming the Store that will use Marketplace, click Save. The confirmation message ‘License settings saved successfully’ appears.
Page Navigation: Log into My Store > Home > Marketplace
Subscribe Integrations: When logged into the Store, click Marketplace. After Marketplace is clicked, the Integrations page appears. Click Upgrade button at the top right.
Browse and Subscribe Integrations: The page directs to Addon information for the Customer to Upgrade.
v Adding Integrations/Addons: Upon clicking Know More, the page navigates to the Integration page (which is already configured on the Admin page). Click Add on the option you with to add.
v Select the checkbox to accept the Terms & Conditions, then click Confirm. The integration is added to your set of current integrations.
v Configure/Manage integrations: Upon clicking this option, the page directs to the Current Integrations page. Clicking the + Add New Integration button at the top-right takes you to the Subscriptions and Integrations page, this option to add new subscriptions and integration and the user can see the list of integrations as show below image.
v Active: All the Integrations the user is currently subscribed to.
v Name: Name of the Integration.
v Subscribed by: Name of the User who selected the subscription to the Integration.
v Subscribed Date: The Date the subscription was started by the User.
v Last edited by: Name of the User who most recently edited the Integration.
v Last edited date: Date and Time of the most recent edits to the Integration.
v Actions: Options to Add Credentials to the Integration or Delete the Subscription.
Configuring an Integration: Once subscribed to the Integration and it is shown in the current Integrations page. To configure it, click Click To Configure. Upon clicking the option, the Configure Integration pane opens that displays the configuration for the Integration via the Admin page. After adding or changing any credentials, click Save.
v Note: Here, Credentials can be changed based on the Integration and any not reflected on the Admin page.
Audit Log: Track all the activities and actions done by the user with Date and Time. Upon clicking on the audit log. the page directs to user to apply the required fields.
v Partners: Select a Partner from the dropdown to see its integrations.
v Time Period: Select from the dropdown to see audits during that particular Time Period.
v Username: Name of the User who added the Integration.
v Partner name: Name of the Integration.
v Date and time: Edited or Subscribed Date and Time of the Integration by the User.
v Actions: Status of the Integration, with option Add or Delete subscription(s).
Search: Conduct a Search based on: Select All, User Name, Partner Name, Date Time, Action.