You must obtain an API Key and Secret before you can authenticate to Data Integrity Suite APIs.
If you requested a trial, follow the steps for new users after your trial workspace has been provisioned. If you are an existing customer, follow the steps to retrieve credentials from within the Data Integrity Suite.
The workflow for obtaining credentials depends on whether you are a new user signing up for a free trial or an existing Data Integrity Suite customer.
For new users (30-day free trial)
New users receive API credentials after a trial workspace has been provisioned, which may require involvement from the Precisely sales team.
- Submit a request for a Data Integrity Suite trial.
- As part of the trial request process, a trial workspace is provisioned, which may involve review or approval by the sales team.
-
Once the trial workspace is created, an API Key and API Secret are generated for that workspace.
- Use the generated API Key and Secret to authenticate and call Data Integrity Suite APIs during the trial period.
For existing Data Integrity Suite customers
-
Access the Data Integrity Suite
Sign in to your Data Integrity Suite workspace. You need to do this to manage API credentials for that workspace.
-
Navigate to Account → API Keys
All API credentials for the workspace are managed from the API Keys tab under Account.
-
View all existing API keys
The API Keys tab displays all API Keys that have already been created for the workspace. API Keys remain visible after creation and can be reused by applications that already have the associated secret.
-
Understand API Secret visibility and recovery
The API Secret appears only once when you create the API key. The Suite does not allow you to retrieve a previously generated secret after you leave the page — you can only view it once at creation or generate a new key pair. If you need the secret, click the Regenerate secret icon or click +Generate API Key from the API Keys tab to create a new one.
-
Use the API Key and Secret for authentication
Use your API Key and API Secret to authenticate requests to Data Integrity Suite APIs. You can do this by configuring Basic Authentication headers or generating OAuth 2.0 access tokens.
- API credentials are workspace-specific.
- Keep API keys and secrets secure and do not share them publicly.
- A workspace supports multiple API keys, which allows you to rotate keys safely without interrupting service.