Skip to main content

Public Authentication

Obtain the Certificall Identification Token​

This section of the API is dedicated to obtaining the Certificall identification token, required to securely access the other API endpoints.

Endpoint​

POST /auth/token

Description​

This endpoint allows users to retrieve a Certificall identification token by providing their login credentials. This token is essential to authenticate subsequent requests to the Certificall API.

Request​

Headers​

  • Content-Type: application/json

Request Body (Payload)​

  • username (String): Username.
  • password (String): Password.

Request body example:

{
  "username": "your_username",
  "password": "your_password"
}

Responses​

Successful Response​

  • Status Code: 200 OK
  • Type: PublicAuthCredentialsResponseDto
  • Description: The response includes an access token.

Successful response example:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Authentication Failure Response​

  • Status Code: 401 Unauthorized
  • Description: The request is denied due to incorrect credentials.

Using the Token​

Once the token is obtained, it must be included in the Authorization header of subsequent requests, preceded by the Bearer prefix, to authenticate access to the other API endpoints.

Header example with token:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Security and Best Practices​

  • Ensure that login credentials are transmitted via a secure HTTPS connection.
  • Store and manage the identification token securely to prevent unauthorized access.
  • If you suspect the token has been compromised, immediately request a new token and revoke the old one.

By following these instructions, you will be able to securely obtain and use the identification token necessary to interact with the Certificall API.