Managing Data Connectors for an App Module

Within an App Module, you can define objects that define where to get the data to support the functionality you’re adding to your portal, and the API calls that will access/retrieve/update the data.

You can have multiple Data Connectors in a module, but they are optional.

You can daisychain connectors together, so that the results of one connector’s API call provides the data (context) for the next connector.

For example, this App Module is referencing WorkSpan, a co-selling platform, to give a partner user information on their activity in the Marketing Development Fund they have access to, from within the Unifyr portal. There are three Data Connectors, linked together:

• Check Workspan User - uses the logged in user’s email address to get their WorkSpan username
• Get MDF Funds - references Check Workspan User and sends the response from that call in an API request to WorkSpan to get that user’s MDF fund 
• Get MDF Activity Summary - references Get MDF Funds and sends the response from that call in an API request to WorkSpan to get the activity on the user’s MDF fund

To add a Data Connector:

1. Navigate to   > Settings > App Modules.
2. Find the required App Module in the list, and click on it to open it.
3. Navigate to the Data Connectors tab.

4. Click Add New Data Connector.

   

5. Add a Component Name for the connector. For example, name it so it indicates the information it will retrieve.

6. Complete this information as applicable, to confirm which objects this data connector should reference:

   Parameter	Type	Description
   Load Data From	Dropdown	[Optional] Select the Data Connector object whose response this object will use as part of its request. Leave this field blank if this data connector represents a standalone request. The dropdown lists all objects you already have configured in the Data Connectors tab for the App Module.
   Data Connector Authorization	Dropdown	[Optional] Select the Service Authentication object that holds the connection credentials and authentication/authorization data for the target application. The dropdown lists all objects you already have configured in the Service Authentication tab for the App Module.

7. Build the request to be made to the target application.
   1. Select the method for the API call - GET, POST, PUT, or PATCH
   2. Complete these fields as required:
      • Target Endpoint (required)
      • Additional Headers - enter in JSON format
      • Post/Put Body - enter in JSON format
      • Export Fields - the data fields to be extracted from the response and returned. Enter in JSON format.

8. Click Save & Test. This tests the configuration you’ve made for the data connector, and output a response in the Sample Test Response field.

   The field includes a tick if the configuration/request is valid.

   

   The field includes a cross if the configuration/request is invalid.

   

9. Click Save to complete the configuration.