# Base Request Structure

Every API request is an http request to URL like *domain + /api/ + api_method.

Example:

curl -X POST https://platform.tpthub.com/api/login \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer eyJ0eXA...HGSlfMZx14" \
  --data '{"username":"admin","password":"admin"}'

Further in the documentation the following form will be used to designate an API request:

POST /api/login
{"username": "admin", "password": "admin"}

Request mandatory headers:

  • Accept: application/json for correct request/response processing
  • Authorization: Bearer ${JWT_TOKEN} for requests where authorisation is required
Last Updated: 10/19/2020, 2:25:12 PM