Configure the integration 编辑

Now that you have added the HTTP integration, configure your integration. This endpoint data along with service action configuration forms the basis for creating actionable microapps.

Add Data Endpoints

Configure the data endpoints to read relevant data into the cache. Any data that we want to show to the user (or want to trigger events or actions with) must be cached.

To add a data endpoint, follow these steps:

1. Select Data Loading.

   

2. Under Data Endpoint configuration, enter Endpoint Name.

3. (Optional) Add Template variables if necessary. This field provides a dynamic value that is used inside HTTP request definitions. Template variables enable you to override or change all parameters of the original endpoint definition in any of the following:

   • Pre action or post action update
   • Action invocation
   • Incremental sync

   For example, you might want to use the dynamic value of the template variable during incremental synchronization.

   

   1. Select Add variable.
   2. Enter a name for the new variable.

   3. Select a Data Type and Source. The data type selected determines the options for source.

      1. Under DATETIME data type, for Static Value, enter a Value.
      2. Under DATETIME data type, for Relative date, choose a time period.
   4. Select the Configure menu, and enter Format Type details for Datetime if necessary.
   5. Select Save.

   The new variable that you created is now available to be used in HTTP requests. When you enter a variable between mustache tags and the variable does not exist, a pop-up lets you add this variable by selecting Create variable.

   Note:

   Template variable values are percent-encoded following the standard HTTP encoding rules. If you do not want this to occur or know that the values are already percent-encoded, you must use the triple-stash mustache tags instead of normal double mustaches to prevent double encoding. For example, change {{example}} to {{{example}}}.

   After configuring template variables, you must define the request method, pagination type, and test the service for both Full synchronization and Incremental synchronization sections as described below.

4. Configure Request method and URL.

5. (Optional) Select + ADD PARAMETERS, and configure QUERY, HEADER, or request body parameters if necessary.

   Note:

   The data type you select determines the formatting of the attributes. The formatting determines the fields in microapps. Use mustache tags to reference parameter names. For example, {{parameterName}}.

6. Select Pagination Type. The pagination type you must select depends on your target application integration’s API standard. Consult your target application integration’s API documentation to see what pagination method your application integration uses.

   Our HTTP Integration lets you select from the following standard pagination methods. Page, Offset, and Cursor methods contain a field Page size value that defines the number of records per page to pull.

   • None - No pagination defined.

   • Page - Set the limit of returns per page.

     Example: https://example.com?limit=100&page=3

   • Offset - Supply two parameters, offset and limit. Offset defines the number of records to skip, limit the number of records to display per page.

     Example: https://example.com?limit=100&offset=300

   • Link - Define the pagination method to define the next page link in the body.

     Example:

      {
      “data” […]
      “next”: https://example.com?lpage=3
      }