Add an API endpoint - Precisely Data Integrity Suite

Define which API endpoints from a source will be available in your pipelines. Configure request and response parameters to control what data flows in and out of the API call.

1. In your Data Integrity Suite workspace, click Configuration.
2. Click the APIs tab.
3. In the API Sources panel, click the API source to which you want to add or edit endpoints.
   The number of endpoints already configured for the source appears next to the source name.
4. Choose to add or edit an endpoint.

   To	Do this
   Add a new endpoint	Click Add Endpoint and continue with the remaining steps.
   Edit an existing endpoint	Click the vertical ellipsis next to the endpoint name, then click Edit. Modify any settings as needed.

   The Configure API Endpoint page opens.
5. For Endpoint and Method, select the HTTP method to be invoked by your pipeline.
   1. In the left dropdown, select the endpoint path.
   2. In the right dropdown, select the HTTP method (GET, POST, PUT, DELETE, etc.).
6. For API Name, enter a meaningful label that uniquely identifies this endpoint configuration.
   Use a name that describes what the endpoint does, such as "Verify Address" or "Geocode Location".
7. For Description, briefly describe what task this endpoint performs in your pipeline.
8. Configure the request parameters.
   The Request section displays all available parameters from the selected endpoint. These are automatically populated based on your endpoint selection.
   Note: Request parameters are defined by the method definition in the OpenAPI specification.
   1. Optional: If header parameters are required, click Add header to specify key-value pairs.
   2. If Batch size is available for the selected method, set the number of records to bundle in a single API call.
      Note: Batch size affects performance and cost. For example, Address Verification recommends a batch size of 10, while Address Geocode recommends 25. Increase batch size for better speed and efficiency, or decrease it if requests timeout or generate out-of-memory errors.
   3. Review the list of available parameters.
   4. Select which parameters will be exposed for user entry in the pipeline.
      Note: You cannot clear the checkbox for required request parameters.
   5. Optional: In the Default Value column, provide a default value for any parameter.
   6. Optional: Where an edit button appears next to a parameter name, click it to provide a friendly name for display in pipelines or workflows.
9. In the Response section, configure which response fields will be available in your pipeline.
   The Response section displays all available response parameters from the API. These are automatically populated based on your endpoint selection.
   Note: Response parameters are defined by the method definition in the OpenAPI specification.
   1. Review the list of available response fields.
   2. Select the response fields you want to expose for use in your pipeline.
      Note: You cannot clear the checkbox for required response fields.
   3. Optional: Where an edit button appears next to a field name, click it to provide a friendly name for display in pipelines or workflows.
10. Click Save to save the API endpoint configuration.