Accessing Authenticated Endpoints

API Key

This API document is a draft

For you to be able to access SmartConsign endpoints you will need to have your API Key authorized by SmartConsign, Please email support@smartconsign.io to get this key authorized.

For every request, including authentication, you need to add the header “x-api-key”, the value of which should be your API Key, which starts with “x-”.

Example

--header 'x-api-key: x-0012345...'

if you do not do this you will receive the following response:

{
    "message": "Forbidden"
}

Bearer

Once you get the access token, you should pass it as a header in each following request that requires authentication.

The header is “Authorization” and the values must be the constant “Bearer” followed by a space and the access token.

Example

--header 'Authorization: Bearer eyJhbGciOiJIUzI1N....long..value...LCJhbGci \