Configuración del Portal Web de Marca Blanca

Esta guía rápida lo ayudará a integrar nuestra solución de incorporación digital White Label Web, desde la generación de URLs de incorporación hasta la personalización básica.

Generación de una URL de Incorporación

Para comenzar, debe generar una URL única que sus usuarios utilizarán para completar el proceso de incorporación. Esto se realiza a través de un endpoint de la API.

Endpoint

• Método: POST
• URL: /integrations

Encabezados Requeridos

• gestok-client-token: Su token de cliente.

Parámetros del Cuerpo

Los siguientes parámetros deben incluirse en el cuerpo de la solicitud:

• customId (string): Un identificador personalizado para el proceso de incorporación. Este campo es obligatorio.
• webhook (string): La URL donde se enviarán notificaciones sobre eventos de incorporación. Este campo es obligatorio.
• lang (string): El código de idioma para el proceso de incorporación (por ejemplo, es_ES para español). (Opcional, por defecto es es_ES)
• phoneStep (boolean): Indica si el paso del número de teléfono se incluye en el proceso de incorporación. (Opcional, por defecto es true)
• acceptations (array): Una lista de términos o acuerdos adicionales que se mostrarán al usuario. (Opcional)
• evidencePortalWebhook (array): La URL donde se enviarán las evidencias. (Opcional)
  • Nota: Si está utilizando el Portal de Evidencias, es obligatorio proporcionar el evidencePortalWebhook para recibir las evidencias generadas durante el proceso.
  • Para más información, consulte la Documentación del Portal de Evidencias.

Respuesta

Después de una solicitud exitosa, recibirá un JSON con los siguientes datos:

• onboardingId: Un identificador único para el proceso de incorporación.
• url: La URL generada para que el usuario inicie el proceso.
• status: El estado inicial del proceso de incorporación.

Ejemplo de Solicitud

curl -X POST https://api.your-service.com/integrations \
-H "gestok-client-token: your-client-token" \
-d '{
  "customId": "demo-portal-12",
  "webhook": "https://your-webhook.com",
  "lang": "es_ES",
  "phoneStep": false,
  "acceptations": []
}'

Ejemplo de Respuesta

{
  "onboardingId": "onboardingId",
  "url": "https://onboarding-web/{onboardingId}",
  "status": "CREATED"
}

Qué Hacer con la URL Generada

Proporcione la URL a sus usuarios finales. Ellos podrán acceder al flujo de incorporación, que incluye:

• Aceptación de términos y condiciones.
• Captura de documentos de identidad usando una cámara.
• Prueba de vivacidad con desafíos simples.
• Confirmación del proceso completado.

Personalización de Textos y Estilos

La solución White Label Web permite personalizar textos, colores y estilos visuales para alinearse con la identidad de su marca. Esto incluye:

• Textos: Configuración de mensajes, títulos y etiquetas.
• Estilos: Colores, fuentes, logotipos e iconos.

También puede editar el logotipo e íconos para que coincidan mejor con la imagen de su marca.

Para más detalles sobre cómo personalizar, visite nuestra guía completa: Guía de Personalización

---