Steps to use the API
1
Get Your Credentials
Before you can begin using the API, you need to obtain your
clientId and clientSecret. These are the credentials that identify your application to our system and allow you to authenticate securely.To get access to either (or both), you’ll need to contact your Customer Success Manager. They’ll handle the setup and provide the necessary API credentials for each environment.2
Authenticate
Once you have your credentials, you’ll need to authenticate into the API in order to obtain a JWT (JSON Web Token). This token is used for securely accessing the API.Authentication is done through a simple
POST request with your clientId and clientSecret. When the request is successful, you’ll receive a JWT that will be used in subsequent API calls.For more details on the authentication process, refer to the Authentication Documentation.3
Make API Requests
After you’ve authenticated and received your JWT, you can start making API requests. For each API request, you need to include the JWT in the
Authorization header of your HTTP request.Here’s an example of making a simple API call: