Saltar al contenido principal

Habilitando CRM

Después de instalar CRM, abre el archivo .env con cualquier editor de texto y actualiza las siguientes variables antes de comenzar:
# DATA SECURITY
LCRYPTO_HASH_SECRET_KEY=my-hash-secret-key
LCRYPTO_ENCRYPT_SECRET_KEY=my-encrypt-secret-key
  • LCRYPTO_HASH_SECRET_KEY: Esta es tu clave de hash. Verifica la integridad de los datos y confirma que las solicitudes provienen de una fuente confiable.
  • LCRYPTO_ENCRYPT_SECRET_KEY: Esta es tu clave de cifrado. Protege datos sensibles cifrándolos y los descifra cuando es necesario.
Necesitarás generar estas claves tú mismo y pegarlas en el archivo .env. Puedes usar el siguiente comando para generar las claves:
  • Cada clave debe ser única, por lo que tendrás que ejecutar el comando dos veces, una vez para cada clave, para generar valores separados y seguros.

Generar una clave de hash

openssl rand -hex 32

Generar una clave de cifrado

openssl rand -hex 32
Mantén tus claves seguras.Una vez generadas, almacena tus claves de forma segura. Recomendamos usar un Secret Manager para protegerlas de la exposición.

Uso típico

Así es como puedes comenzar:

Paso 1 – Crear el Titular

Comienza creando un titular (holder), que representa un individuo u organización en el sistema.
Aunque muchos campos están marcados como opcionales a nivel del contrato de la API, algunos plugins (como integraciones de CRM o KYC) pueden requerirlos.Si no estás seguro, verifica los requisitos específicos del plugin antes de proceder.
Ten en cuenta también:
  • La API no valida la exactitud de los datos.
  • Proporcionar valores incorrectos (como ledgerId o accountId que no coincidan) puede resultar en fallos de integración, especialmente con proveedores externos o el componente Ledger.
Ten especial cuidado de proporcionar identificadores válidos y datos reales cuando sea necesario.
También puede realizar acciones como:

Paso 2 – Conectar el titular a Midaz usando una Cuentas Alias

Una vez que el titular está creado, usa el endpoint Crear una Cuentas Alias para configurar una Cuentas Alias (una cuenta a nivel CRM que representa la Cuenta Midaz) y vincular el Titular a ella en un solo paso. Esta vinculación es clave para:
  • Rastrear transacciones vinculadas al titular.
  • Habilitar tarifas, notificaciones y otras funciones a nivel de cuenta.
  • Impulsar flujos posteriores como facturación y verificación de identidad.
Sin esta conexión, la mayoría de las funciones impulsadas por CRM no funcionarán como se espera.
También puedes realizar acciones como:

¿Qué sucede después?

Con los titulares correctamente creados y vinculados, ahora puedes:
  • Enriquecer datos CRM con plugins adicionales (por ejemplo, KYC, puntuación, segmentación).
  • Activar flujos de trabajo que dependan de atributos de identidad u organizacionales.
  • Validar o filtrar transacciones basándose en datos a nivel de persona.
El plugin CRM establece los cimientos; lo que construyas encima depende de ti.