API de autenticación de usuario

Antes de consultar datos de usuario o modificar configuraciones mediante la API REST de Vivoldi, obtén un token de acceso para una autenticación segura.

El uso de tokens con validez limitada refuerza la seguridad de la cuenta y protege las solicitudes API frente a amenazas externas.

Incluye el token en el encabezado X-Access-Token para realizar llamadas seguras a la API.

Esta API está disponible a partir del plan Personal.

POST

/api/user/v1/auth

{
    "eml": "your@gmail.com"
}

Request Parameters

eml string
Correo electrónico.
Se utiliza para consultar o modificar la información de los usuarios añadidos dentro de una organización en el plan Business o superior.
Se ignora en los planes Personal y Premium.
{
    "code": 0,
    "message": "",
    "result": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response Parameters

code integer
Código de respuesta: 0 = Éxito, otros valores = Error
message string
Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje de error.
result string
Al solicitar ver o actualizar la información del usuario, debes incluirlo en el encabezado HTTP como X-Access-Token.
El token es válido durante 1 minuto y debe renovarse (volviendo a llamar a esta API) cuando expire.

¿Por qué se necesita un token de autenticación?

Todas las solicitudes API deben autenticarse para verificar la identidad y los permisos del usuario.

Esta API cumple las siguientes funciones:

  • Identificar al cliente que realiza la llamada
  • Validar los permisos del usuario
  • Bloquear solicitudes no autorizadas
  • Gestionar el estado de sesión segura

Cuándo usar esta API

<p> Esta API debe utilizarse antes de acceder a cualquier endpoint relacionado con la cuenta, como <a href="/url/api/user/retrieve">Retrieve User</a> o <a href="/url/api/user/update">Update User</a>. </p> <p> El token emitido debe incluirse en el encabezado HTTP como <code>X-Access-Token</code> en todas las solicitudes posteriores. Su corta duración reduce la exposición de sesiones y mejora la seguridad. </p>

Significado de un token de 1 minuto

Un tiempo de validez de 1 minuto es un diseño centrado en la seguridad.
Si el token se ve comprometido, expirará automáticamente en un minuto, reduciendo el riesgo.

La implementación recomendada es generar el token justo antes de la llamada API y usarlo inmediatamente.
Almacenar tokens para reutilizarlos puede provocar errores de autenticación.

Definición del usuario objetivo y condiciones de plan

En el plan Business o superior, los administradores pueden autenticarse en nombre de un usuario especificando su email en el parámetro eml.

Esto permite automatizar la gestión y consulta de usuarios dentro de la organización.
Esta API solo está disponible para cuentas con plan Personal o superior, por lo que debes verificar tu suscripción.

Aspectos a tener en cuenta

  • Almacena los tokens de forma segura y evita cualquier exposición externa
  • Evita usar tokens directamente en el cliente, ya que supone un riesgo de seguridad
  • Implementa un mecanismo de renovación automática cuando el token expire
  • Utiliza la API exclusivamente a través de HTTPS