Saltar al contenido principal

Configuración inicial

Para utilizar Boufin Connect, es necesario crear una configuración inicial. Esta configuración determina el comportamiento y las características visuales de Boufin Connect según los requerimientos específicos de cada implementación. Permite generar el Widget Config ID que se utiliza en la generación del Token OTP.

Estructura de configuración​

La configuración se define a través de un objeto widgetConfig que contiene los siguientes parámetros:

{
  "widgetConfig": {
    "clientId": "client-id",
    "entity": {
      "name": "name"
    },
    "featureFlags": {
      "FEATURE_FLAG_USE_REAL_ENTITIES_ICONS": true
    },
    "flowType": "USER",
    "tyc": {
      "name": "default",
      "version": "latest"
    },
    "oneShot": false
  }
}

Parámetros de configuración​

  • clientId (string, requerido)

  • entity (object, requerido)

    • name (string, requerido): Nombre de la entidad o empresa que utilizará el widget.

  • flowType (string, requerido)

    • Define el tipo de cuentas que se conectarán a través de Boufin Connect.
    • Valores posibles:
      • USER: Para personas naturales que conectarán sus cuentas personales.
      • COMPANY: Para personas jurídicas que conectarán cuentas empresariales.

  • featureFlags (object, opcional)

    • Configuraciones personalizadas de Boufin Connect como pares clave-valor.
    • Permite habilitar o deshabilitar funcionalidades específicas del widget.
    • Feature flags disponibles:
      • FEATURE_FLAG_USE_REAL_ENTITIES_ICONS: Controla si se muestran los iconos oficiales de las entidades financieras (true) o iconos genéricos con el color asociado a la entidad (false).

  • tyc (object, requerido)

    • Configuración de términos y condiciones. Los parámetros disponibles para name y version se pueden consultar en la documentación oficial.
    • name (string, requerido): Nombre de los términos y condiciones a utilizar.
    • version (string | number, requerido): Versión específica o "latest" para la versión más reciente.

  • oneShot (boolean, requerido)

    • Define el alcance del consentimiento del usuario.
    • true: Consentimiento para una extracción única.
    • false: Consentimiento para múltiples extracciones de las acciones autorizadas. Cuando la opción se establece en false, el consentimiento tiene un período de validez definido. Durante ese período, se pueden realizar múltiples extracciones de los productos autorizados. Esta es la opción que se debe seleccionar cuando se desea mantener las cuentas de los usuarios sincronizadas de manera periódica.

Identificadores y credenciales​

Los siguientes identificadores y credenciales deben solicitarse al Customer Success Manager de Boufin:

  • Client ID (string, requerido)

    • Identificador único del cliente proporcionado por Boufin.

  • Widget Config ID (string, requerido)

    • Identificador único de la configuración de Boufin Connect.
    • Se proporciona en base a la configuración definida en esta sección.

  • API key (string, requerido)

    • Clave de autenticación para acceder a los endpoints de Boufin.
    • Se debe incluir en el header x-api-key de las peticiones HTTP.
    • Importante: No debe ser expuesta en aplicaciones públicas. Debe ser resguardada y utilizada únicamente en ambiente de backend.