GuidesDiscussions
API Reference

Authentication

Authentication for Paradox public APIs requires either OAuth 2.0 or Basic Authentication. Please contact the Paradox Integrations Team to request your account ID and API secret key.

Depending on your environment, you will need to call one of the following API endpoints to generate a token.

Olivia DEV2 endpoint: https://dev2api.paradox.ai/api/v1/public/auth/token
Olivia TEST endpoint: https://testapi.paradox.ai/api/v1/public/auth/token
Olivia STG endpoint: https://stgapi.paradox.ai/api/v1/public/auth/token
Olivia PROD endpoint: https://api.paradox.ai/api/v1/public/auth/token
EU STG endpoint: https://api.stg.eu1.paradox.ai/api/v1/public/auth/token
EU Prod endpoint: https://api.eu1.paradox.ai/api/v1/public/auth/token

OAuth 2.0 - Preferred Authentication Method

Headers (Content-Type: application/x-www-form-urlencoded)
Body (type: x-www-form-urlencoded)

  • grant_type: client_credentials
  • client_id: Account ID provided by Paradox
  • client_secret: Secret Key provided by Paradox

Response

  • access_token: <access_token>
  • expires_in:
  • token_type:

All subsequent requests must contain the access token within the headers as follows:

  • Authorization: Bearer

OAuth 2.0 - Postman Built-In Authentication

On the Authorization tab in a Postman, select “OAuth 2.0” for the Authentication type. Select “Request Headers” for the option “Add authorization data to”
Complete the rest of the Settings as follows-

  • Header Prefix = Bearer
  • Token Name = Paradox PROD (or your choice to name token)
  • Grant Type = Client Credentials
  • Access Token URL = https://api.paradox.ai/api/v1/public/auth/token (substitute preferred endpoint as listed above)
  • Client ID = Account ID provided by Paradox
  • Client Secret = Secret Key provided by Paradox
  • Client Authentication = Send client credentials in body
  • Click “Get New Access Token”. If successful, you will receive a success message.
  • Click “Proceed” and “Use Token” to use the new token on the request.

You can check the “Headers” tab to confirm the token was correctly added to the request.

Basic Authentication

On the Authorization tab in a Postman, select “Basic Auth” for the Authentication type.

  • Username: Account ID provided by Paradox
  • Password: API Secret provided by Paradox

You can check the “Headers” tab to confirm the token was correctly added to the request.