2️⃣Authentication

This step assumes you have successfully obtained your API credentials following API Credentials and are ready to go.

This step is not strictly required if you are using our Postman collection as authentication is done automatically on every request provided that correct API credentials are set in your Postman environment.

As stated in Authentication section of our API integration guide, in order to access any API endpoint you need to obtain a JWT token using your previously issued credentials.

Initial Authentication

Retrieve authentication token using API credentials

POSThttps://api.offblocks.xyz/v1/auth/token

Body

application/json

apiKey*string (uuid)

Unique API key used to identify your API integration. Note this can be different for live and sandbox environments

apiSecret*string

API secret

Response

200400401500

Successful operation

Body

application/json

token*string

JWT token that can be used for further requests to authenticated endpoints

expiresAt*integer

token expiration time (UNIX timestamp)

tokenType*string

token type. Must be "Bearer"

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/auth/token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "apiKey": "123e4567-e89b-12d3-a456-426614174000",
      "apiSecret": "text"
    }),
});
const data = await response.json();

Response

200

{
  "token": "text",
  "tokenType": "text"
}

If your request was successful, you will receive a token as part of response, together with its expiration timestamp (by default all tokens expire after 1 hour).

You can now use a valid token to make requests to other endpoints of the API by providing it as an Authorization header in a following way:

Authorization: "Bearer <token>"

// For example 
// Authorization: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MDE1MjY4NTUsIklkIjoiZGZjMTU3MzAtZGI2Zi00MjY1LWE3NjgtNjQ2ODhlNzE4NjA3IiwiR2VuZXJhdGlvbiI6MH0.326XVPWFcc_Z6zg0rCZ5NLou1Mxmql_Ri0r0vD8R4ko"

If you want to change your API credentials, you can make an authenticated request to the following endpoint. Please note, all previously issued tokens will become invalid.

Update API credentials

Add or update API credentials. If credentials are updated this action invalidates all issued tokens and active sessions

PUThttps://api.offblocks.xyz/v1/auth/credentials

Authorization

bearerAuth

Body

application/json

apiKey*string (uuid)

Unique API key used to identify your API integration. Note this can be different for live and sandbox environments

apiSecret*string

API secret

Response

204400401500

Successful operation

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/auth/credentials', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "apiKey": "123e4567-e89b-12d3-a456-426614174000",
      "apiSecret": "text"
    }),
});
const data = await response.json();