Add an API source - Precisely Data Integrity Suite

Data Integrity Suite

Product
Spatial_Analytics
Data_Integration
Data_Enrichment
Data_Governance
Precisely_Data_Integrity_Suite
geo_addressing_1
Data_Observability
Data_Quality
dis_core_foundation
Services
Spatial Analytics
Data Integration
Data Enrichment
Data Governance
Geo Addressing
Data Observability
Data Quality
Core Foundation
ft:title
Data Integrity Suite
ft:locale
en-US
PublicationType
pt_product_guide
copyrightfirst
2000
copyrightlast
2026

Create an API source by uploading an OpenAPI specification in JSON format and configuring authentication. Once added, you can define endpoints and use them in your pipelines.

Note: To view the APIs tab and perform this task, you must have permission to View and Manage API Source.
  1. In the Data Integrity Suite workspace, click Configuration.
  2. Click the APIs tab.
  3. In the API Sources panel, click Add.
  4. Upload the OpenAPI specification file for the API source.
    You need an OpenAPI specification file in JSON format. Either drag and drop the file to the upload box or click choose a file to browse for it.
  5. In the Base URL section, select the base URLs for the source.
    These are the root addresses that will be available for API endpoints. You can add multiple base URLs to support different environments (development, staging, production).
  6. In Default Base URL, choose the base URL that will be selected by default.
  7. For API Source Name, enter a label that identifies the API source.
    Use a clear, descriptive name that indicates the API's purpose or provider.
  8. For Authentication Type, select a supported authentication method.
    Authentication Type What to provide
    Basic A username and password combination.
    apiKey An API key provided by the service.
    Bearer A bearer token for OAuth 2.0 or similar token-based authentication.
    Note: You can only select authentication types that are defined in the OpenAPI specification.
  9. Choose the Secret Key Method.
    Manual Manually enter the secret key or credentials.
    Key Vault Store credentials securely in a Key Vault. Select the vault and enter the token secret path.
  10. Optional: Click Test Base URL to verify the connection.
    Note: The system attempts to connect to the default Base URL. A success message confirms that the URL is reachable and the authentication is valid.
  11. Click Add API Source to save the API source.
    Optionally, click Add and Configure Endpoints to save the source and immediately add an endpoint.
    Note: You can add endpoints later if needed.
The API source is created and ready to use. You can now add endpoints to this source and use them in pipelines or workflows. Add endpoints on the APIs tab in the workspace Configuration panel, or add them directly when configuring a Make API Call pipeline step or workflow activity.