Pular para o conteúdo principal

​
Habilitando o CRM

Após instalar o CRM, abra o arquivo .env com qualquer editor de texto e atualize as seguintes variáveis antes de começar: 
# DATA SECURITY
LCRYPTO_HASH_SECRET_KEY=my-hash-secret-key
LCRYPTO_ENCRYPT_SECRET_KEY=my-encrypt-secret-key
  • LCRYPTO_HASH_SECRET_KEY: Esta é sua chave de hashing. Ela verifica a integridade dos dados e confirma que as requisições vêm de uma fonte confiável.
  • LCRYPTO_ENCRYPT_SECRET_KEY: Esta é sua chave de criptografia. Ela protege dados sensíveis criptografando-os e os descriptografa quando necessário.
Você precisará gerar essas chaves por conta própria e colá-las no arquivo .env. Você pode usar o seguinte comando para gerar as chaves:
  • Cada chave deve ser única, então você terá que executar o comando duas vezes, uma para cada chave, para gerar valores separados e seguros.

​
Gerar uma chave de hashing

openssl rand -hex 32

​
Gerar uma chave de criptografia

openssl rand -hex 32
Mantenha suas chaves seguras.Uma vez geradas, armazene suas chaves de forma segura. Recomendamos usar um Secret Manager para protegê-las contra exposição.

​
Uso típico

Veja como você pode começar:

​
Passo 1 – Crie o Holder

Comece criando um holder, que representa um indivíduo ou organização no sistema.
Embora muitos campos sejam marcados como opcionais no contrato da API, alguns plugins (como CRM ou integrações de KYC) podem exigi-los.Se não tiver certeza, verifique os requisitos específicos do plugin antes de prosseguir.
Observe também:
  • A API não valida a precisão dos dados.
  • Fornecer valores incorretos (como ledgerId ou accountId incompatíveis) pode resultar em falhas de integração, especialmente com provedores externos ou o componente Ledger.
Tenha cuidado extra para fornecer identificadores válidos e dados reais quando necessário.
Você também pode realizar ações como:

​
Passo 2 – Conecte o holder ao Midaz usando uma Alias Account

Uma vez que o holder é criado, use o endpoint Criar uma Alias Account para configurar uma Alias Account (uma conta a nível de CRM que representa a Conta do Midaz) e vincular o Holder a ela em um único passo. Esse vínculo é fundamental para:
  • Rastrear transações vinculadas ao holder.
  • Habilitar taxas, notificações e outras funcionalidades a nível de conta.
  • Alimentar fluxos subsequentes como faturamento e verificação de identidade.
Sem essa conexão, a maioria das funcionalidades orientadas pelo CRM não funcionará como esperado.
Você também pode realizar ações como:

​
O que acontece depois?

Com os holders devidamente criados e vinculados, você agora pode:
  • Enriquecer dados do CRM com plugins adicionais (ex.: KYC, scoring, segmentação).
  • Acionar workflows que dependem de atributos de identidade ou organizacionais.
  • Validar ou filtrar transações com base em dados a nível de pessoa.
O plugin CRM estabelece a fundação; o que você constrói em cima dele é com você.