# The API Token Setup Process

Creating an API Token allows access to the DX2 Public API and DX2 Analytics OData API. In addition to DX2's Portal offering allowing for management of Documents, Users, and various other entities, you can query and make changes to the state of Documents and various other areas within DX2 through the DX2 Public API. Communicating with this API requires a token to prove your identity. These credentials can be created by setting up a new API Token Connector.

The DX2 Public API URL is: https://publicapi.dx2.com/

The DX2 Analytics OData API URL is: https://analyticsapi.dx2.com/odata

API Token

# Trading Partner Key

The Trading Partner Key is the key used to identify you as a Trading Partner within DX2.

# API Client ID Token

The API Client ID Token is a unique identifier used when connecting to the DX2 Public API and DX2 Analytics API.

# API Secret Token

The API Secret Token can be thought of as the password which allows access to the DX2 Analytics API

WARNING

The Secret API Token will only be displayed once. Subsequent views of this token will not show the Secret API Token. This is for security purposes, and is standard practice across many web applications when working with secrets. Ensure that you record this value in a secure location, or you may need to create a new API Token to continue using the DX2 Public API or DX2 Analytics API.

# Viewing an existing Token

After a token has been created, you may view its API Client ID for identification purposes. As previously stated, the Secret Token will not be displayed when viewing the Connector Configuration.

Last Updated: 6/08/2020, 9:59:39 pm