API Documentation

User - Authentication ​

Overview ​

The "User - Authentication" endpoint allows users to authenticate and obtain an authorization token for accessing secured API endpoints. This process is crucial for ensuring that only authenticated users can perform operations within the system. By providing your email address and password, you can request an authentication token that grants access to further API interactions.

Endpoint ​

POST /api/v2013/authentication/token

Headers ​

The request must include the following headers:

FieldTypeDescription
AcceptStringSpecifies the format in which the client expects the server to return the response data. The allowed value is application/json, indicating that the response should be in JSON format. This helps the server understand how to format the response to meet the client's expectations.
Content-TypeStringIndicates the format of the request body sent by the client. The allowed value is application/json, meaning that the data being sent to the server is formatted as JSON. This informs the server of the data type it should expect and how to process it accordingly.

Request Payload ​

FieldTypeDescription
emailStringYour registered email address
passwordStringYour CBD account password

Obtaining the Authorization Token ​

To authenticate and obtain the Authorization token for accessing the API endpoints, follow these steps:

  1. Endpoint: Send a POST request to the following URL: https://absch.cbddev.xyz/api/v2013/authentication/token
  2. Payload: Include your CBD email address and password in the request body as JSON:
json
{
  "email": "<your cbd email>",
  "password": "<your cbd password>"
}
  1. Response: Upon successful authentication, the server will respond with an authentication token (authenticationToken) and its expiration timestamp (expiration):
json
{
  "authenticationToken": "<AUTHENTICATION TOKEN>",
  "expiration": "2024-07-17T02:01:54.2274392Z"
}
  1. Usage: Use the authenticationToken received in the response as the Bearer token in the Authorization header for subsequent API requests:
javascript
Authorization: Bearer <AUTHENTICATION TOKEN>

Replace <AUTHENTICATION TOKEN> with the actual token received from the authentication endpoint. This authentication process ensures secure access to the API endpoints using your CBD credentials.

Playground ​

Swagger playground is loading, please wait...