Connector Integrations

Modified on Mon, 17 Jul 2023

This document is a draft version and subject to further review and revision. Please refrain from distributing or relying on its contents as final.

Add Integration in the Tenant Level

  1. In the Tenant Settings,  click on the New Integration button.
    An Add Integration pop-up window will appear.
  2. Select the desired provider from the drop-down list. For example, select Fiserv as the provider.  If the provider you're looking for is not listed, you can use the Add Provider option to include it. 
  3. Choose the Connector type, such as REST.
  4. Select the relevant category for the integration, such as wealth or CRM.
  5. From the drop-down list, choose the desired Authentication mode. This includes standard or custom authentication mechanisms based on the integration you are using.
  6. Click Next to proceed.
  7. Import the connector specification into the platform by following the provided instructions.

Now the OpenAPI specifications are added successfully to the tenant, allowing you to connect with various providers and utilize their operations.

View the Details of an Existing Connector

The newly added connector will get displayed in the Connectors section of the Tenant Settings with the other connectors. 

This screen provides a centralized location to manage all connectors within the platform. You can click the required connector to access its details, including the list of available operations, authentication mode, and Parameters.

  • Operations: Specific actions or functionalities that can be performed using the connector. For example, retrieving customer data.
  • Authentication mode: The method or mechanism used to verify identity and permissions. For example, OAuth authentication.
  • Parameters: Inputs or settings required to execute an operation successfully. For example, customer ID or transaction details.

To use the required connector to your app, you can add configurations in the App Settings.

Add Configuration in the App Level

To use the connector in your app:

  1. Go to your app's settings and navigate to the Connectors section.
  2. Select the required connectors from the listed connectors, for example, Fiserv.
  3. Click the Next button.
    Configuration pop up opens.
  4. Enter the following details:
    • Base URL (obtained from the API specification): The Base URL is the foundational web address provided in the API specification, which serves as the starting point for accessing the desired API endpoints.
    • Authenticator: The Authenticator refers to the method or mechanism used for authentication, such as API keys, OAuth, or other authentication protocols, which verify the identity and permissions of the user or application accessing the API.
    • Token provider: The Token provider is responsible for generating and providing the necessary security tokens, such as access tokens or bearer tokens, which are used in the authentication process to validate and authorize API requests.
    • Username: The Username refers to the unique identifier or login credential associated with the user account used to access the API.
    • Password: The Password is a confidential security code or passphrase associated with the provided username.
  5. Click the Save button.

The specifications are imported successfully to the app. You can now use the imported connector specifications across your app for various operations.