Skip to end of metadata
Go to start of metadata

This page describes how to authenticate your REST API calls when using Sisense version 5.8 and earlier and provides examples of how to connect with HTTP request tools such as Postman and cURL. 

For Sisense version 5.8 and earlier, you can use the Global Token located in the Admin page of the Sisense Web Application.The token lets the server verify your identity. 

For versions of Sisense later than 5.8, see Using the REST API for information about authenticating requests. 

To retrieve the Global Token for authenticating requests :

  1. In the Sisense Web Application, select Admin > REST API.
  2. Click REST API Reference to view the list of operations and API documentation.
  3. Access the endpoint in v0.9 of the REST API at /settings/api to return your API key. 
    OR
    access the /settings/api/generate endpoint to generate a new API key. 
  4. To pass the token, add it to the X-Api-Key header (X-Api-Key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX) with the following attributes:

Using an HTTP request tool

Postman

Sisense recommends Postman , which is a Chrome extension that lets you run HTTP requests using a comfortable GUI. The HTTP requests can be executed to view the result, or saved as code snippets in a variety of programming languages.

  1. Select the method type and enter the endpoint in the URL field.
  2. Under the Header tab, in the Key field, enter X-Api-Key.
  3. In the Value field, enter your JWT generated token.
  4. Click Send. The response is displayed in the Body area.

cURL

You can also use cURL from command line, or any other tool that can run HTTP requests with your headers and data. The version of Sisense you are using determines the type of authorization header you must include in your call to the REST API in cURL.

You must include a JWT encoded token that includes your Global Token.

C:\>curl -X GET --header "Accept: application/json" "http://localhost:8081/api/dashboards" --header "X-Api-Key: eyJhbGciOiJIUzI1NiIsInR5cCI6I


  • No labels