This is an endpoint to verify the connection and authorization is working correctly.

The authorization token consists of the following two things: an API key & an API Secret.

  • API Key
The API Key belongs to an user within the client application where the connection is made to. This key is used to identify the user and is part of the generated token.
  • API Secret
The API Secret belongs to the client application where the connection is made to. This secret is used to hash the token parts into the authorization token.
Token generation

The authorization token is structured as followed: "::". And is then hashed using HMAC SHA256 and the API Secret. The hashed result needs to be lowercased and dashes should to be removed.

Authorization header

In the Authorization header needs to be added for each request. It looks like the following: "bloxs :".

Timestamp header

The timestamp used to generate the token needs to be added with each request in the "x-timestamp" header.

Code samples can be found at: https://github.com/bloxssoftware/bloxs-api