Authentication

To use CDQ APIs, you must properly authenticate our services. For authentication, you can use the API key or OAuth2 Client Credentials.

Prerequisites

1. If your organization is already a CDQ customer, ask your internal point of contact to create a CDQ dedicated account. Account detail will be sent by email.
2. If your organization is not yet a CDQ customer, please contact us to get started.

Step 1: API Key Management

1. Log into the CDQ Cloud Apps

2. Navigate to the "API Key Management" App

Step 2: Generate the authentication details

3. Select the Create a new API Key button
4. Enter the name for the new API Key

API Key

1. Note down the generated API Key is marked in the green box.

Check the example:

X-API-KEY: ZHNmd2Ratc2dzZ2RZ3NWqZHNnc2c2Rndmnc2dmZHazZ3NnZzZ3anZHM=

2. Click the checkbox to confirm saving the API key and close the window.

3. Go back to a desired API section in Developer-Portal

4. Copy the provided API Key and paste it to the security box in the console

5. Set needed parameters and try it!

OAuth 2.0

1. Note down the generated Client ID and Client Secret are marked in the green box.

Check the example:

Client ID: f1096473-7g01-42fa-b1c5-e747b987da61
Client Secret: 5eg123cf6sp0g

2. Click the checkbox to confirm saving the API key and close the window.

3. Fetch token via token endpoint

In OAuth 2.0 approach, you must generate authentication token first.

• Use the below data in the API Client of your choice:

Example using cURL:

curl -X POST \ https://id.cdq.com/auth/realms/cs/protocol/openid-connect/token
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d 'grant_type=client_credentials' \
     -u "<Client Id>:<Client Secret>" \

Example using Insomnia:

• Add a new POST request with the token endpoint address
• In the request body select Form URL Encoded
• Set grant_type parameter to client_credentials

• Set authentication to Basic Auth and provide Client ID as a username and Client Secret as a password.

• Add Header Content-Type with application/x-www-form-urlencoded value.

• Hit Send

Successful response:

{
	"access_token": "eyJhbG...HSmgnS_0",
	"expires_in": 1800,
	"token_type": "Bearer",
}

4. Use the authentication token
   • Select one of many CDQ's endpoints and use the below data with the new request
   • Add token to every request towards CDQ, Authentication: Bearer

Example using cURL:

curl -X GET \ https://api.cdq.com/requiredapi
     -H "Authorization: Bearer eyJhbG...HSmgnS_0" \

Example using Insomnia:

• Add a new request with the required endpoint address
• Set authentication to Bearer and provide access_token value as a token.

• Hit Send

Successful response:

In the case of 403 Forbidden response check your access_token.

Basic Authentication

Your opinion matters!

We are constantly working on providing an outstanding user experience with our products. Please share your opinion about this tutorial!

Mail our developer-portal team: developer-portal@cdq.com