Boufin Connect
Boufin Connect permite integrar fácilmente toda la funcionalidad de extracción de datos financieros de Boufin en aplicaciones existentes, sin necesidad de desarrollar una interfaz propia.
Guías de integración
1. Configuración inicial
Configuración inicial necesaria para utilizar Boufin Connect. Define el comportamiento y características visuales según los requerimientos específicos de cada implementación.
2. Token OTP
Documentación para la generación del Token OTP (One-Time Password) para la autenticación de Boufin Connect. Incluye flujos para personas naturales y jurídicas.
3. Flujo de Integración
Documentación para la integración de Boufin Connect mediante un Iframe utilizando la librería IframeEmbed
, con autenticación por Token OTP, comunicación bidireccional y obtención del consentId
.
4. Extracción de datos
Proceso completo para extraer datos de productos financieros autorizados mediante Boufin Connect. Incluye la creación de Task Token, extracción de datos de productos y gestión de consentimientos.
Flujo de integración
El siguiente diagrama muestra la secuencia para integrar Boufin Connect. Cada etapa del proceso se describe a continuación.
Pasos 1 & 2: Obtención del Token OTP
Para obtener un 🔒 Token OTP es necesario realizar una petición desde el servidor utilizando una 🔑 API Key junto con los identificadores solicitados en la configuración inicial. Este proceso se documenta en la sección Token OTP. Esta petición también proporcionará un consentId
que se utilizará para autorizar la extracción de datos relacionados a los productos definidos en la configuración.
La 🔑 API Key no debe ser expuesta en aplicaciones públicas. Debe ser resguardada y utilizada únicamente en ambiente de backend.
Pasos 3 al 5: Integración y Autorización del Usuario
El 🔒 Token OTP debe ser entregado a la aplicación (web o móvil) para que inicialice Boufin Connect en un iframe, siguiendo las instrucciones documentadas en la sección Flujo de Integración. Una vez inicializado, Boufin Connect utiliza el token para autorizar la sesión y desplegar la interfaz que permite al usuario final realizar el proceso de consentimiento. Durante este proceso, el usuario proporciona sus credenciales y selecciona la entidad de donde se extraerá la información.
Pasos 6 al 8: Finalización del Consentimiento
Al finalizar el proceso de consentimiento, se enviará a la aplicación el consentId
mediante Post-message, el cual debe ser entregado al servidor para completar los pasos siguientes.
Boufin Connect maneja distintos estados que pueden ser comunicados a la aplicación. Para más detalles, consultar el manejo de mensajes desde el Iframe.
Pasos 9 & 10: Obtención del Task Token
Desde el servidor, utilizando la 🔑 API Key junto con el target
y el clientId
, es necesario obtener un 🔒 Task Token. Este token JWT permite acceder a los consentimientos y datos del usuario específico, este proceso se detalla en la sección Task Token.
Pasos 11 & 12: Extracción de Datos
Finalmente, desde el servidor se utiliza el 🔒 Task Token como autorización para extraer los datos de productos específicos. Para cada extracción se envía el consentId
obtenido anteriormente y el identificador del product
deseado. Para más información, consultar la documentación de Extracción de datos.
Gestión de consentimientos
Adicionalmente, Boufin Connect proporciona endpoints para consultar y gestionar los consentimientos asociados a un usuario. Esto permite verificar el estado de las autorizaciones, obtener información detallada de cada consentimiento y administrar las sesiones activas, los detalles se encuentran en Gestión de consentimientos.