POST | /login
Función que Realiza
Se encarga de validar los datos de un usuario previamente registrado, crear una sesión, devolver un token de acceso y establecer un token de refresco mediante cookie.
Funcionamiento
- URL Completa:
{domain}/api/v1/auth/login - Acción: POST
- Requiere Api-Key?: Si
- Requiere una Sesión?: No
- Recibe datos mediante: Body
- Cantidad de datos: 2
- Responde con contenido?: Si
- Responde únicamente con código de estado?: No
- Código: 200 | Ok
- Códigos de error: Vea la sección Errores
Contenido que se recibe por Body
- Solo se permite iniciar sesión a los usuarios con los roles [ADMIN, ROOT].
Estructura del JSON:
{"parámetro": "tipo de dato"}
{
"username": "String | <4 <-> 36>",
"password": "String | <8 <-> 255>"
}
Contenido que devuelve
Estructura del JSON:
{"parámetro": "tipo de dato"}
{
"accessToken": "String",
"user": {
"id": "String",
"username": "String",
"email": "String",
"personalId": "String",
"legacyId": Int,
"role": " Enum('ROOT','ADMIN','VENDEDOR','MERCH')"
}
}
Códigos de Error
| HTTP Code | Custom Code | Message |
|---|---|---|
| 422 | INVALID_REQUEST_DATA | Los datos enviados son inválidos o insuficientes. |
| 401 | USER_NOT_FOUND | El usuario no existe. |
| 401 | INSUFFICIENT_PERMISSIONS | No tienes los permisos suficientes para acceder a esta sección. |
| 401 | INVALID_PASSWORD | La contraseña no coincide. |