XTOPIA API - API | XTOPIA Developers

XTOPIA API (known as API OUT)

We'll assign an OAuth client_id and client_secret for each of your applications

Authenticate

Ask users to authenticate and authorize your application with XTOPIA

Start making requests!

Make requests to our API Endpoints with the users' OAuth credentials

STEP 1: Register

Please login to your existing XTOPIA account to get started.

Go to XTOPIA > APPS > API Builder > XTOPIA API Credentials to create your application.
Enter the following information & save it.

Name
Description
Apps

After registered, you can get the client id & client secret for API authentication.

STEP 2: Authenticate

The XTOPIA API uses the OAuth 2.0 protocol.

Authenticated requests require an access_token. These tokens are unique and should be stored securely. Access tokens may expire at any time in the future.

Request the access_token

Your application must get the permisson to access the data, hence your application will required to get a Authorization Token with https://api.xtopia.io/token.

These are the required parameters:

client_id: your client id
client_secret: your client secret
grant_type: client_credentials is currently the only supported value

STEP 3: Start making requests!

Once you've registered your application, it's easy to start requesting data from XTOPIA.

All endpoints are only accessible via https and are located at api.xtopia.io.

API Endpoints

Please refer to the API documentation for information about API requests.

FAQs

1. How to test API with https://api.xtopia.io?
NOTE:
You need to register your application to get the client_id & client_secret in order to start using the API.

Go to https://api.xtopia.io
To get access_token, click on the "!" icon & enter the client_id & client_secret, set the type as "Request Body", then click on the Authorize button. The "!" icon will change from red color to blue color once the authentication is successful.
2. How to create custom query and call by XTOPIA API?
Go to XTOPIA > SETTINGS > QUERY to create your own query.
After you have define your query, you can consume the query data with XTOPIA API > /v{version}/query/custom/{defineId}
NOTE:
{defineId} is the Globally Unique Name which set by you when created the query.