Skip to content

API Documentation ​

Welcome to the API documentation of our project. Below are the details of the endpoints exposed by our REST API.

Authentication ​

POST /api/v1/auth/login ​

Authenticate a user and retrieve an access token.

Request ​

  • URL: /api/v1/auth/login
  • Method: POST
  • Content-Type: application/json

Body Parameters ​

ParameterTypeDescription
usernamestringThe user's username.
passwordstringThe user's password.

Example ​

json
{
  "username": "john.doe",
  "password": "password123"
}