Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The new External API Integrator tool contains an Endpoints tab which stores API endpoints, methods and an authentication token (either added in Request Header via Custom Parameters or via Request Body). Once the tool is configured, configure an External API Integrator pipeline step that will integrate with their tools to make a RESTful API call.

Tool Registry Setup

  1. In Tool Registry, click ‘+ New Tool’ button to create a new External API Integrator tool.

  2. Locate the External API Integrator tool and click ‘Select Tool’ button.

  3. Provide a Tool Name and any other values and click ‘Create’ button to save the new tool.

  4. Navigate to the Endpoints tab and click the ‘+ New External API Integrator Endpoint’ button to configure a new Endpoint.

...


Request Header - If you are required to include a header token, first add it to your Custom Parameters (saved in Tool Registry) and then select it from the dropdown. Custom Parameters are saved in the Tool Registry. Authorization Tokens must be encrypted Custom Parameters. Do not include "Bearer" in the Custom Parameter. This field is not required if you have an API token. You can add the API token to Query Parameters Request Body.

...


Request Body - To add a field, click the ‘+ Add Field’ button. Provide a Field Name and a Field Type (Sting, Array, Date). API token can be added here.

...