Documentacion de API - Inicio de sesión

Esta documentación cubre los puntos finales para la gestión del inicio de sesión y autenticación en la API.

Acceso a los recursos de la API:

Para poder acceder a los recursos de esta API, es indispensable contar con un token de autenticación. Este token se genera mediante un proceso de inicio de sesión en el cual se debe proporcionar un nombre de usuario y una contraseña válidos. Una vez que el usuario se autentique correctamente, el sistema devolverá un token que será necesario para incluir en las solicitudes subsecuentes.

Este token debe ser enviado en el encabezado Authorization de cada solicitud, en formato Bearer [token]. Sin este token válido, no será posible acceder a los recursos protegidos de la API.

Proceso de autenticación:

  1. Enviar una solicitud POST a la ruta de autenticación con el nombre de usuario y la contraseña.
  2. Recibir un token en caso de autenticación exitosa.
  3. Incluir el token en las solicitudes subsecuentes para acceder a los recursos de la API.

1. Inicio de sesión

Endpoint: POST /api/v1/auth/login

Descripción: Este endpoint permite al usuario autenticarse proporcionando su nombre de usuario y contraseña. Si la autenticación es exitosa, se generará un token de acceso que deberá ser usado para acceder a los recursos protegidos de la API.

Request Body:

{
    "username": "user_example",
    "password": "user_password"
}

Request Headers:

  • Content-Type: application/json

Response:

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjM0NTY3ODkwLCJleHBpcmVkX3N0YW5kYXJkX2V4cGVyaWVuY2VzX3Rva2VuIjoib2F1dG9rdG9rZW4ifQ.Sfsdf47sdf8fWQRE5Fhsdf98s8fjasdhsf9_8fjs"
}

Errores posibles:

  • 401 Unauthorized: Si las credenciales de usuario son incorrectas.
  • 400 Bad Request: Si el cuerpo de la solicitud está incompleto o malformado.

Uso del token:

Una vez que obtienes el token de autenticación, debes incluirlo en el encabezado Authorization de todas las solicitudes subsecuentes, en formato Bearer [token].

Ejemplo de solicitud con token:

Endpoint: GET /protected-resource

Request Headers:

  • Authorization: Bearer [token]

Response:

{
    "message": "Acceso autorizado al recurso protegido."
}