Response Description

A successful response will return:

{
  "data": {
    "accessKey": "96146f31a1427ca0",
    "authorizationToken": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NLZXkiOiI5NjE0NmYzMWExNDI3Y2EwIiwidGltZXN0YW1wIjoxNjc0MDI5MTc2OTI4LCJlZmZlY3RpdmVEdXJhdGlvbiI6MzYwMCwiaWF0IjoxNjc0MDI5MTc2LCJleHAiOjE2NzQwMzI3NzZ9.xWTg3RQupOSkQo4sv0I-o7tQz_2Fa-3Cb3aXq3Xa2FQ",
    "exp": 3600
  },
  "success": true,
  "code": 0,
  "message": ""
}

Field Descriptions

data: Container for the main response information.

• accessKey: The access key provided in the request. Used for validation and to ensure the token is generated for the right access key.
• authorizationToken: The authorization token in the JWT format. This should be used in the Authorization header for subsequent API requests.
• exp: Integer representing the token's expiration time in seconds. Default value is 3600 seconds, i.e., 1 hour.

success: Boolean value indicating the success or failure of the API request. true denotes success, and false denotes failure.

code: Integer indicating the status of the response. A value of 0 represents success.

message: String containing any additional information or error messages associated with the API call.

For possible failure states, see the example on the right panel.