- API Key: Passed in the request headers for every call. The API key is also referred to Was the LoginId.
- OAuth 2.0 Available for systems that require token-based authorization flows.
API Key Authentication
1
Create an API User
In the DNCScrub portal, navigate to User Admin. Create a new user that will be used for API access.
- Give the user a distinct full name like “API User - Do Not Delete” so it won’t be accidentally removed
- The recommended username is
apiuser(though any username works) - Set the user role to Administrator
2
Generate the API Key
After creating the user, click the “Get API Key” button. The API Key will be displayed in the “API Key” field and can be copied to your clipboard.
3
Store Your API Key
Save your API Key securely. You’ll need it for all API calls.
Using Your API Key
Include the API key in the HTTP header of every request:| Header Key | Value |
|---|---|
loginId | Your API Key |
Example with cURL
Example with JavaScript
Example with C#
OAuth 2.0 Authentication
For enhanced security, CCC APIs support OAuth 2.0 authentication in addition to API key authentication.OAuth Token API Playground
Try the OAuth token endpoint directly in the API playground.
OAuth Flow
1
Request Credentials
Contact support to receive your OAuth client credentials.
2
Get Access Token
Exchange credentials for an access token.
3
Make API Calls
Include the access token in API requests.
4
Refresh Token
Refresh the token before it expires (tokens expire after 1 hour).
Token Request
Request Parameters
| Parameter | Condition | Description |
|---|---|---|
client_id | Required | Your Account Id such as DEMO |
client_secret | Required | An API Key generated from DNCScrub.com portal. |
grant_type | Required | Must be set to client_credentials |