Login Endpoint - Español
Descripción
Este endpoint permite a los usuarios autenticarse utilizando un correo electrónico codificado en base64 y un token de acceso generado por Auth0. Una vez autenticados, el sistema genera un JWT (JSON Web Token) que se envía como parte de la URL en la respuesta para futuras autenticaciones y sesiones seguras.
URL
POST /api/login
Autenticación
Token Requerido: Access token de Auth0
- Obtener el Token: Debes registrar tu aplicación con Auth0 y configurarla para utilizar el flujo de autorización que mejor se adapte a tus necesidades (por ejemplo, Client Credentials, Authorization Code, etc.). El token de acceso debe solicitarse a Auth0 utilizando el
client_id,client_secrety los scopes adecuados que permitan acceder a este endpoint. - Uso del Token: El token de acceso debe ser incluido en todas las solicitudes al endpoint de login en el header de autorización como un Bearer Token.
Headers
| Key | Value | Description |
|---|---|---|
| Authorization | Bearer {token} | Token de acceso de Auth0 necesario para la autenticación. |
Parámetros del cuerpo (Body)
| Parámetro | Requerido | Descripción |
|---|---|---|
| Sí | Correo electrónico del usuario codificado en base64. |
Respuestas
Success Response
Código: 200 OK
Contenido del cuerpo:
{
"status": "success",
"url": "https://yourdomain.com/site/callback?token=jwt_token_here",
"message": "User logged in"
}
Descripción: La respuesta incluye el estado de la operación, un mensaje descriptivo, y una URL con el JWT generado como parámetro para la redirección del usuario.
Error Responses
Contenido del cuerpo:
{
"status": "error",
"message": "Unauthorized or invalid token"
}
Descripción: Se retorna cuando el token de Auth0 no es válido o ha expirado.
Código: 400 Bad Request
Contenido del cuerpo:
{
"status": "error",
"message": "Email is required"
}
Descripción: Se retorna cuando no se ha incluido el correo electrónico en la solicitud.
Datos de Respuesta
| Campo | Tipo | Descripción |
|---|---|---|
| status | string | Estado de la respuesta, puede ser "success" o "error". |
| url | string | URL a la que el cliente puede ser redirigido, incluye el JWT en respuestas exitosas. |
| message | string | Mensaje descriptivo sobre el resultado de la operación. |
Tabla de Posibles Valores de Error en Message
| Mensaje |
|---|
| "Username invalid" |
| "User doesn't have any licence" |
| "User doesn't have a profile" |
| "Unknown error" |
| Unauthorized or invalid token |
| Email is required |
Ejemplo de uso
Solicitud:
curl -X POST "https://yourdomain.com/api/login" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your_auth0_access_token" \
-d '{"email": "dXNlckBleGFtcGxlLmNvbQ=="}'
Respuesta:
{
"status": "success",
"url": "https://yourdomain.com/site/callback?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"message": "User logged in"
}