​
• Setup Guide

This section will guide you through the typical steps involved in establishing a connection between a Universal Connector and the Target System. Whether it is to synchronize customer data, automate order fulfillment, or enable real-time inventory updates, understanding the steps/process is crucial for leveraging the Ekyam integration platform. An outline of the general workflow—-from initial setup and authentication to data mapping and testing is explained below: Blankdiagram(2) Jpe

​
Step 1: Initial Setup & Configuration (Ekyam & External System)

1

Ekyam Registers as an Application (if required):

Some systems (like those using OAuth 2.0) require Ekyam to register. This involves obtaining credentials like a Client ID and Client Secret.
2

Identify Authentication Type

Determine the authentication method used by the system.The common types include:
  • OAuth 2.0: Requires a redirect flow and the exchange of authorization codes for access and refresh tokens.
  • API Keys: Simple string tokens passed in headers or query parameters.
  • Basic Authentication: Username and password
  • Bearer Tokens (JWT): JSON Web Tokens, often used in API authorization. 
3

Obtain Necessary Credentials

Based on the authentication type, obtain the required credentials.
  • OAuth 2.0: Client ID, Client Secret, Redirect URIs (obtained during app registration).
  • API Keys: Retrieve the API key from the target system’s developer portal or settings.
  • Basic Authentication: Obtain the username and password 
  • Bearer Tokens (JWT): Obtain the token from the target system, potentially through a login API call.

​
Step 2: Connection Setup with Ekyam

1

Select Connector

On navigating to the Ekyam Integration options, there will be an ADD/SELECT CONNECTOR button to the list of available connectors. Select the SOURCE SYSTEM CONNECTOR for integration (NetSuite, SAPB1 etc).
2

Establish Authentication

Once the desired connector has been selected, the system will prompt for authentication details. This is a vital step as it establishes a secure and authorized connection between the Source System and the Ekyam Platform. On the screen that appears, there will be fields to input the Source System’s credentials. These might include API Keys, Client IDs, Client Secrets, Usernames, Passwords, or initiating an OAuth 2.0 redirect flow depending on the Source System’s security protocol. These unique credentials allow Ekyam to securely connect and access your data.

​
Step 3: Configuration and Testing

Map Your Data (Universal Reader) Once Ekyam has successfully authenticated with the Source System, it is important to define how the external data will be understood and standardized by Ekyam’s Proprietary schema. Hence, the role of “UNIVERSAL READER”.  Begin by clicking on the “Map Configurations” button or tab. After clicking on “Map Configurations,” the system prepares for data ingestion. A mapping screen will appear (Shown below), indicating the types of data that can be pulled from your Source System’s designated API endpoints (e.g., /products, /customers, /orders). To confirm the validity of these endpoints and the established connection, you will need to click on the “Verify” button.
“AI-Powered Mapping”: Ekyam’s Universal Reader leverages advanced AI-driven capabilities during this process. The AI intelligently validates the connection and begins to infer and suggest preliminary mappings based on common field patterns and industry best practices. This significantly streamlines the setup and reduces manual effort._
Successful Verification & Reader Mapping Screen
If the “Verify” check is successful, the Reader Mapping Screen will be displayed. This intuitive interface is where the transformation of the Source System data into Ekyam’s unified standards can be seen.
  • Ekyam’s Standardized Collections (Left Panel): On the left side of the screen, you’ll see Ekyam’s pre-defined, standardized data collections and their respective keys/fields. These represent the target schema for your data—Ekyam’s proprietary data standards—structured to store core business entities (e.g., Products, Pricing, Inventory, Customers, Orders) and maintain their relational integrity within Ekyam’s ecosystem. These are the standardized keys your data will conform to.
  • Source System Fields (Right Panel): Conversely, the right side of the screen dynamically displays the actual fields/keys retrieved directly from your connected Source System’s API endpoints. This clear juxtaposition allows you to visually connect the source data elements with Ekyam’s standardized fields.
As you select a specific Ekyam collection (e.g., “Products”) on the left, the main screen area will display the detailed field mapping. Ekyam’s standard keys for that collection (e.g., Product ID, Product SKU, Product Name) are shown. As data is received from the Source System, Ekyam’s AI intelligently maps the incoming data from the right panel to these defined Ekyam Data Standards on the left.
  • Custom Mappings (Optional): While AI suggests mappings, the dropdown options allow for manual adjustments. If certain fields from the Source System are not automatically mapped, or if you prefer a different mapping, you can define Custom Mappings manually. These custom rules are saved in Ekyam’s database for consistent application during subsequent syncs, providing unparalleled flexibility.
The specific dropdown mapping options may differ significantly for different Source Systems due to their unique data structures.

​
Step 4: Configure Data Flows (Workflows)

With your data mappings defined, the final step is to activate and control the flow of information through Ekyam’s powerful workflow engine.
  • Click on the Workflow to edit the data flow
  • After clicking, the screen will display your configured data flows.
  • You will observe an “On sign” (often a blue toggle or an active indicator) on a specific synchronization step within your workflow diagram, such as “Order Sync” or “Shipment Sync.” 
This “On sign” precisely implies several crucial operational statuses for a seamless data exchange:
  • Active Connectivity: It confirms that the connection between your Source System (e.g., for shipment data) and the Ekyam platform is live and operational. Data is actively flowing or ready to flow.
  • Successful Configuration & Setup: This indicator signals that all the necessary groundwork has been completed for this specific data flow. This includes:
    • Authentication: Ekyam has successfully authenticated with your Source System.
    • Field Mapping: The critical step of field mapping has been precisely done, meaning Ekyam understands exactly which data fields from your Source System’s records correspond to the fields required by Ekyam’s standards and, subsequently, any other destination system in the chain.
    • Workflow Logic: Any defined business rules, transformations, or AI-powered actions (as configured in Ekyam Workflows) are active and ready to be applied.
  • Data Synchronization is Live: Most importantly, the “On sign” signifies that the data (e.g., product updates, customer records, or shipment details) is actively being synced from your Source System to the Ekyam platform, processed according to your defined mappings and workflows, and then subsequently delivered to its intended destination (e.g., your WMS, CRM, or data warehouse).
Use Case To explain how Ekyam Universal Connector is using Diverse API standards, Below is a Use Case of NetSuite that will demonstrate how Ekyam’s Universal Connector leverages NetSuite’s diverse API standards (APIs, Token-Based Authentication (TBA), Webhooks) and authentication mechanisms (token-based, API key) to achieve seamless, real-time order-to-fulfillment synchronization.
Scenario: An e-commerce uses Order Management System (OMS), and Ekyam’s Universal Connector to integrate with NetSuite (ERP) for inventory and fulfillment management.
Ekyam’s Universal Connector needs to connect to NetSuite for several real-time operations, leveraging NetSuite’s various API standards and authentication methods.
  • Connecting to NetSuite (Authentication & Token Generation)
NetSuite offers several API methods, including:
→ Token-Based Authentication (TBA)- based on OAuth 1.0→ Oauth 2.0
  • Ekyam’s Configuration for Order Creation (OMS to NetSuite)
    • The user inputs Consumer Key, Consumer Secret, Access Token, Token Secret to connect Ekyam’s Universal connector to Netsuite. 
    • The Universal Connector then uses these credentials to generate an authenticated request with OAuth 1.0 (for TBA) or OAuth 2.0 token (Client credentials). 
    • This token is then passed as a header in every API call to Netsuite. 
    • The token acts as a proof of authentication and authorization. 
  • Using webhooks for Inventory updates 
    • NetSuite is configured to trigger an event whenever an inventory’s level changes. 
    • Ekyam’s Universal Connector provides a webhook endpoint URL to NetSuite. 
    • Ekyam generates a unique callback URL for NetSuite to include it in its webbook payload or header when sending inventory updates. 
    • When an inventory event occurs in NetSuite, it _pushes __a JSON payload _containing the updated inventory data to Ekyam’s webhook endpoint, with the API key included for authentication. 
  • Data flow
    • When a customer places an order in the OMS, an event is triggered. 
    • Ekyam’s Universal connector, authenticated with NetSuite’s TBA-generated token, immediately calls NetSuite’s API to create a new sales order record. 
    • Ekyam maps OMS order fields according to Ekyam Data Standards to NetSuite’s sales order fields. 
  • Inventory Synchronization
    • When an item is sold, received, or adjusted in NetSuite, the inventory record changes.
    • NetSuite triggers a webhook that pushes the updated inventory quantity for the item to Ekyam’s webhook endpoint.
    • Ekyam maps NetSuite’s quantity available and item_id to the OMS’s equivalent fields.
  • Fulfillment Updates
    • Once a sales order is fulfilled in NetSuite, an event is triggered.
    • NetSuite pushes a webhook to Ekyam’s endpoint, providing fulfillment details 
    • Ekyam’s connector receives this, maps the data, and updates the order status in the OMS.