This topic outlines the initial setup guidelines for using Data Integrity Suite APIs and lists some general practices to follow. As a first step, review Data Integrity Suite's Developer Portal to get an understanding of all the endpoints and the functionality surrounding our APIs. After reviewing the APIs, register by clicking Start a Trial in the Developer Portal (available in the top right corner). Then, review the following guidelines to ensure a smooth, optimal integration process that helps you avoid common pitfalls. Follow secure authentication practices and optimized request handling for efficient integration of Data Integrity Suite APIs into your applications.
Setup Guidelines
- Review and understand authentication requirements and ensure how to obtain authentication credentials and tokens.
- Keep the credentials secure.
- Specify the correct environment (Staging/Production).
- Set the endpoint URL correctly for an API (refer to documentation for the base URL and the path).
- Specify the required headers like
AuthenticationandContent-type. - Review the mandatory and optional parameters and ensure to include required path and query parameters.
- Format the Request body correctly.
- Review the Error and Response codes.