How to Get Started with Our APIs

Getting Started Guide

1.Login

Enter your Single Sign-On (SSO) credentials, which typically include a username and password.

Once logged in, you should have access to your dashboard. Browse or explore the available APIs in the catalog.

2. Create your first application

You'll often find an option to create a new application. This application serves as a way to manage your interactions with the API.

Click on the Create New Application or + button.

App Details: Give your application a name that helps you identify it easily. Optionally, you can provide a brief description to explain its purpose.

Select the Plan: APIs often have different usage plans. Choose the plan that best suits your needs and budget.

Select the API: If you have access to multiple APIs, choose the one you want to use with this application.

Finish: Once you've provided all the necessary information, click the Finish button to create your application.

3.Generate PAT

After creating your application, go to your profile or account settings. In this section, you should find the option to generate a personal access token.,

This token is used to authenticate your requests to the API on behalf of your application.

Click on the Generate Token or similar button. Once generated, the token will be displayed.

Make sure to copy and securely store this token, as it's typically only shown once.

4. Make an API request

With your application set up and your personal access token in hand, you can now start using the API. Navigate to the Data API or the relevant section where you intend to interact with the API.

Depending on the API documentation and tools provided by the platform, you can make requests to the API using various methods, such as HTTP requests GET.

Use your personal access token in the authorization header or parameter of your API requests to authenticate them.

A person standing on a ladder and looking out

By following these steps, you should be able to log in, create an application, generate a personal access token, and start testing and using the API through the platform.