Making Requests
In order to work with the API certain “rules” must be followed, more specifically what headers must be present in order to validate requests.
Headers
There are 3 headers required by the public API to validate requests:
- ATRACKED_CLIENT_TYPE
- ATRACKED_CLIENT_ID
- AUTHORIZATION
Client type
The client type, or its nature, specify what kind of client/user is making the request. It lets the API know what kind of operations the requester is allowed to do, for example the CLIENT type won’t be able to make admin related operations.
values:
- OPERATOR
- CLIENT
Client ID
The unique ID to identify the organisation using the public API that has been given.
Authorization
Once authenticated, all upcoming requests must be authorized using the JWT received on a successful authentication request using the Authorization header.
The format is the following: "Bearer " + JWT
Note: Mind the space between the prefix and the token value
(Obvious) Note: The /authenticate resource doesn’t require this header
Example
Here is an example of a new shipment creation request made with Postman:
Swagger Documentation
Here is the link leading to the API's Swagger documentation: https://api.a-tracked.com/swagger-ui/.