Pre-requisites

Generating the API Security Token

All API endpoints to the Pulse Platform tenant for the client are secured using an API token that can be generated using the credentials to login to the Pulse Dashboard (emailid + password).

Use a REST client (ex: Postman/ARC/cURL) to initiate a request:

1. Request Type: POST
2. URI: (api-URL)/auth/login
3. Request Body:

   {
     "username": "<email-id>",
     "password": "<password>"
   }
   

4. Content-type: application/json
5. Response (success):

   {
     "orcas-token": "TOKEN"
   }
   

6. Response (failure):

   {
     "error": "Invalid request"
   }
   

Use the TOKEN from step 5. above to authenticate requests for API operations.

Expiry

TOKEN generated is expired in 8 hours from the time of creation

Usage

The API token generated needs to be sent as a Header Param to Rest API requests.

• Security Header Param:

orcas-token: TOKEN