Interact with our REST API

This section explains how to use our interactive API documentation to play.

You need to obtain the access token in order to authenticate with the API endpoints and retrieve the responses.

Get Access Token

Each user has their own unique token to authenticate the requests, which should be added in the header of the request.

To get the User Token follow the below steps:

1. Navigate to the appropriate interactive REST API documentation link.
   • v1.0
   • v2.0
   • v3.0
   • v4.0
   • v5.0
   • v6.0
2. Expand the Authentication section and then click Try it out.

3. We have already hosted the Bold BI Server for a public demo on this domain. To access the public demo, you need to obtain the access token using the sample credentials provided below.

 **Username** - `guest@boldbi.com`

 **grant_type** - `password`

 **password** - `Demo759!`
 

4. Click Execute and you will receive the response as shown below. Obtain the access_token from the Response body. 5. Now you need to add the access token as the Authorization header for further API calls. 6. Click the Authorize button, which is located in the top right corner of the page. 7. A dialog box will open, in which you should enter the access token in the Value box using this format: ‘Bearer’ + access_token. Then, click the Authorize button. 8. Now, you can interact with the other REST APIs by using the necessary parameters that are mentioned in each API.

NOTE: In this interactive document, API responses and their code descriptions are also mentioned.