...
Attributes of the HTTP response
Success response | |||
|---|---|---|---|
token | string | required | A security token required for future API usage. |
expired | string | required | Date and time when the security token expires. |
Failed response | |||
error | string | required | It contains a reason for the failed request. |
Examples
As previously stated, to procure a security token, it is imperative to dispatch a POST HTTP request to the /api/token endpoint of the API. Below, instances of potential communication between the API and consumers are provided.
...
Throughout the lifespan of a security token, consumers are entitled to submit requests to various endpoints within the API. Upon receiving the first response indicating an invalid request, consumers of the API should initiate the retrieval of a new security token.
| Drawio | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...