Saltar al contenido principal
Este plugin no pertenece al dominio transaccional del ledger. En cambio, enriquece las cuentas del Ledger con atributos relevantes para el negocio sin interferir con la lógica, consistencia o rendimiento del ledger. CRM es donde viven los metadatos del usuario. No se trata de saldos, transferencias o tarifas—se trata de quién está detrás de la cuenta y qué necesitas saber para operar tu negocio.

​
Código abierto y versionado con Midaz

El plugin CRM es de código abierto, no requiere licencia y se mantiene en el mismo repositorio que Midaz. Su versión siempre coincide con la versión de Midaz Core (por ejemplo, Midaz v3.5.0 → CRM v3.5.0). Aunque se versionan juntos, CRM se despliega de forma independiente y puede habilitarse u omitirse según tu caso de uso.
Prueba el plugin CRM localmentePuedes ejecutar el plugin CRM localmente sin desplegar en Kubernetes usando nuestro repositorio plugins-docker-compose.

​
¿Por qué usar CRM?

Las cuentas del Ledger de Midaz son genéricas por diseño, construidas para ser primero transaccionales y agnósticas al dominio. El plugin CRM interviene para agregar significado a esas cuentas, vinculando cada una a perfiles de usuario detallados y contextos de negocio. Debido a que es opcional y se despliega de forma independiente, CRM puede adoptarse incrementalmente—solo cuando tu caso de uso requiera metadatos de cliente o negocio más allá del ledger.

​
Ejemplos de casos de uso

  • Banca (individuos y empresas): CRM almacena identificadores como CPF o CNPJ, dirección, datos de contacto o números de cuenta, mientras Midaz maneja exactamente la misma lógica de transacción para cualquier tipo de cliente.
  • Cadenas de suministro (proveedor, fábrica, minorista): CRM rastrea metadatos como IDs de proveedores, ubicaciones de almacenes o información contractual. Estos datos no pertenecen a la transacción en sí, pero son esenciales para las decisiones de negocio.
CRM es un plugin opcional. Puedes desplegarlo solo si tu producto o contexto regulatorio requiere metadatos de cliente o negocio.

​
Entidades

CRM gira en torno a dos entidades principales:
  • Holder (Titular) – La entidad principal en CRM, que representa a la persona asociada con una cuenta del Ledger en Midaz. Almacena atributos relacionados con la identidad y características individuales.
  • Alias Account (Cuenta Alias) – Define el contexto de negocio asociado con una Cuenta del Ledger en Midaz Ledger, incluyendo detalles financieros como información de cuenta bancaria.
En la Figura 1, puedes encontrar una ilustración de cómo las entidades de CRM están conectadas a Midaz.

​
Principios de diseño

El plugin CRM está construido para:
  • Separación de responsabilidades: Mantiene los datos del perfil de usuario fuera de la lógica transaccional.
  • Rendimiento del sistema: Sin orquestación a nivel de usuario dentro de los servicios principales de Midaz.
  • Flexibilidad de despliegue: Puede habilitarse, escalarse u omitirse independientemente del ledger.
  • Límites de dominio claros: Evoluciona junto con Midaz sin acoplarse a los internos del ledger.
CRM no valida reglas a nivel de Ledger ni procesos de cumplimiento como KYC. Es una capa de datos neutral y persistente diseñada para máxima interoperabilidad.

​
Comportamiento de la API

CRM está implementado como una API de registro independiente. Proporciona persistencia y acceso estructurado a datos no transaccionales vinculados a cuentas en Midaz.
  • No aplica validaciones como estado del usuario, perfil de riesgo o verificación de documentos.
  • Es agnóstico al activo, Ledger o lógica de agrupación utilizada en las cuentas de Midaz.
  • Asegura acceso consistente a los metadatos del titular sin contaminar la capa transaccional.

​
Seguridad y cumplimiento

Lerian proporciona Midaz y sus plugins como componentes on-premise—lo que significa que tú mantienes el control de tu infraestructura, políticas de cumplimiento y ciclo de vida de datos de usuario. Aunque CRM es de código abierto y libre de licencia, sigue los mismos estándares de seguridad que el resto de la plataforma Midaz:
  • Los datos en tránsito están cifrados usando protocolos estándar de la industria.
  • Los datos en reposo están protegidos mediante cifrado y controles de acceso granulares.
La gestión de claves de cifrado es responsabilidad del cliente. Recomendamos encarecidamente usar servicios de gestión de secretos para almacenar, rotar y controlar el acceso a las claves.
Confiamos en que nuestros clientes definan y apliquen sus propias políticas en torno a LGPD, GDPR y otras regulaciones regionales de protección de datos — el plugin CRM simplemente proporciona la estructura. Sin embargo, para aprovechar al máximo esa estructura—y asegurar que tus prácticas de manejo de datos se alineen con un entorno seguro y conforme— es esencial revisar las Recomendaciones de seguridad antes de desplegar cualquier plugin en tu entorno. Ya sea que estés trabajando con Access Manager, Fee Engine, Pix o CRM, cada plugin debe implementarse en alineación con las mejores prácticas de seguridad — incluyendo asegurar los límites de red, gestionar secretos, aplicar gestión de parches y aplicar controles de acceso estrictos. Siguiendo estas directrices, ayudas a asegurar que cada plugin se ejecute de forma segura, se integre sin problemas con tu infraestructura y mantenga el cumplimiento, la integridad de datos y la confianza del usuario.

​
Estrategias de eliminación de datos

En Lerian, tratamos la propiedad de datos seriamente. Por eso el plugin CRM te da control total sobre cómo se elimina la información, con dos opciones integradas:
  • Eliminación suave (predeterminado): El registro permanece en la base de datos pero se marca como eliminado. Esto es útil si necesitas mantener un rastro de auditoría o recuperar información más tarde.
  • Eliminación definitiva: Si tu política interna requiere eliminación completa, puedes usar un comando específico para eliminar los datos permanentemente—sin recuperación.
Tus políticas definen el comportamiento. CRM se adapta a tus requisitos de cumplimiento sin imponer restricciones.

​
Control de acceso

¿Necesitas restringir quién puede acceder a tus datos de CRM? Puedes habilitar nuestro plugin Access Manager para ayudarte a restringir quién tiene acceso a los datos.

​
Habilitando Access Manager

Para habilitar el control de acceso, primero asegúrate de que Access Manager esté instalado. Luego, abre el archivo .env ubicado en la raíz de la carpeta CRM usando cualquier editor de texto, y configura las siguientes variables de entorno: 
## AUTH
---

PLUGIN_AUTH_ADDRESS=http://plugin-auth:4000
PLUGIN_AUTH_ENABLED=true
Una vez habilitado, el plugin CRM aplica permisos de acceso basados en tu configuración de autenticación.
Access Manager está disponible bajo el modelo Enterprise. Si deseas evaluarlo, ponte en contacto con nuestro equipo.

​
Próximos pasos

Explorar la API de CRM

Consulte endpoints para holders, alias accounts y partes relacionadas.

Usando CRM

Aprenda a registrar holders y vincularlos a cuentas del ledger.