Marca blanca — Autenticación

Permite a los clientes referidos autenticarse en modo marca blanca: la sesión se genera con el contexto de la marca del cliente padre (logo y url de retorno), para embeber la plataforma AVEONLINE bajo su propia identidad visual.

Importante

La marca blanca está disponible únicamente para empresas referidas (registradas como hijas de un cliente padre en AVEONLINE). Si la empresa no es referida y solicita marca blanca, la autenticación responde 401.

El contexto de marca blanca (logo del cliente padre y urlretorno) se devuelve tanto dentro del token (JWT) como en el cuerpo de la respuesta (data.marcablanca). Puede leerlo directamente del response o decodificando el payload del token.

Request

url

https://app.aveonline.co/api/auth/v3.0/index.php

Method

POST

Header

Content-Type: application/json

Params JSON

• tipo* String Tipo de autenticación. Para este flujo siempre "AuthProduct".
• user* String Usuario de AVEONLINE de la empresa referida.
• password* String Contraseña del usuario.
• marcablanca* Boolean Enviar en true para solicitar la sesión en modo marca blanca.
• urlretorno String Url del dominio del cliente a la cual se retornará al usuario al salir de la plataforma. Se devuelve dentro del token.
• tokenTime Number Horas de vigencia del token. Por defecto 12.

Ejemplo

{
  "tipo": "AuthProduct",
  "user": "usuarioempresa",
  "password": "contraseña",
  "marcablanca": true,
  "urlretorno": "https://clientex.com/dashboard"
}

Response

Success 200

• status String Resultado de la operación, "ok".
• message String Mensaje de respuesta, "sesion ok".
• data Object Sesión del usuario (los mismos campos de una autenticación estándar).
  • token String Token (JWT) de la sesión. Dentro de su payload también viaja el contexto de marca blanca.
  • marcablanca Object Contexto de marca blanca (presente solo en sesiones de marca blanca).
    • activa Boolean Confirma que la sesión es de marca blanca.
    • logo String Url del logo del cliente padre, para presentar en la interfaz.
    • urlretorno String La misma url de retorno enviada en la autenticación.

{
  "status": "ok",
  "message": "sesion ok",
  "data": {
    "id": 25505,
    "usuario": "usuarioempresa",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJhcHAuYXZlb25saW5lLmNvIi...",
    "marcablanca": {
      "activa": true,
      "logo": "https://app.aveonline.co/app/temas/logos_empresa/logo-clientex.png",
      "urlretorno": "https://clientex.com/dashboard"
    },
    "urlMarcaBlanca": "https://guias.aveonline.co/marca-blanca?usuario=eyJ0eXAiOiJKV1Q..."
  }
}

note

El objeto data contiene todos los campos habituales de la sesión (nombres, rol, empresa, etc.); aquí se muestran abreviados por claridad. El mismo bloque marcablanca viaja además dentro del payload del token.

Módulos

Los módulos habilitados no viajan en el token. Al consultar el listado de módulos con un token de marca blanca, la plataforma devuelve automáticamente solo los módulos permitidos para este modo.

Errores

Usuario no autorizado para marca blanca 401

La empresa autenticada no es un cliente referido:

{
  "status": "error",
  "message": "Usuario no autorizado para marca blanca"
}

Credenciales incorrectas 404

{
  "status": "error",
  "message": "Error en usuario o contraseña"
}

Faltaron credenciales 400

{
  "status": "error",
  "message": "Faltaron credenciales"
}