Using the API Reference
Table of Contents
API Documentation You Require API Keys to use this feature. Please contact support to get Access. Billable Support Feature Setting Up Server Connection and Authentication Step 1: Configure Server Connection Step 2: Authenticate for AccessAPI Documentation
This API documentation is also a powerful tool for making API calls to our test server and platform. API Reference
You Require API Keys to use this feature. Please contact support to get Access.
Billable Support Feature
The API is an included feature of the solution. If required, Professional Services are available based on an accepted quote and availability of resources.
Setting Up Server Connection and Authentication
Getting started is as simple as configuring the server settings and establishing authentication. Follow these steps to get started:
Step 1: Configure Server Connection
- Navigate to the "Base URL" section on the right side of the API Reference Page.
- Click on the server name displayed in the "Base URL" value.
This action initiates the process of modifying the server name for your convenience.
Example:
- Complete the editing process, ensuring your desired server name is accurately represented.
Example:
:
Step 2: Authenticate for Access
With the server value successfully configured, proceed to establish authentication for secure access. While both API keys and access tokens (access_token) can be utilized, API keys offer the simplest interaction with the documentation tool. However, note that access tokens do have a time-out feature.
- Ensure you possess a valid Bearer token, either in the form of an access token or an API key.
- Integrate the Bearer token into your authentication workflow for a seamless connection.
Example:
