API protocols
The API follows REST principles and supports the following request methods:- POST: Submit data or trigger actions.
- GET: Retrieve information from the system.
Content-Type: application/json
header.
Authentication
You must authenticate API requests using a Bearer token. Obtain a token by sending your client credentials to the authentication endpoint. Include the token in theAuthorization
header of every request.
For details on authentication, see the Authentication reference.
Base URL
All API requests must be sent to the appropriate regional endpoint based on your deployment:If you’re unsure of your region, feel free to contact us.
Error handling
The API returns standard HTTP status codes to indicate success or failure. If a request fails, the response includes an error code and description to help you troubleshoot the issue. For more information, see how to handle errors.API status and availability
Check the system status page to monitor downtime, maintenance schedules, and service disruptions.Next steps
To start using the API:- Authenticate and obtain a Bearer token.
- Use the token to send API requests.
- Refer to the relevant endpoint documentation for request and response details.