Skip to content
This repository has been archived by the owner on Apr 21, 2024. It is now read-only.

How to use

Ujjwal Ayyangar edited this page Dec 6, 2019 · 1 revision

GetSatPro API Documentation

How to use this documentation

Postman is an API developmental tool that is used for interacting with HTTP APIs

General structure of the tool :

  • Sending a request :

Different HTTP methods are available in the drop down button.

  • Viewing a response

  • Sending a json (in POST requests) (keep this empty for GET requests)
  1. For this, you need to go to the Body tab and click on the raw radio button.
  2. Select the content setting as JSON (look at the drop down present on the right most side of the radio buttons pane).
  3. Type the json structure.

  • Setting apropriate headers

  • Setting JWT tokens for sending authenticated requests

We use JWT tokens for making authenticated requests in our API.

Whenever you hit a POST request on the Login route, you will get a token string (present in the token key of the json structure). For reference checkout the Login documentation here.

To use this token follow the following steps :

  1. Copy the token string
  2. Click on the authorization tab
  3. On TYPE select, Bearer Token
  4. Inside the Token text field on the right side, paste the token string.

Clone this wiki locally