> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # O que é o CRM? > A camada opcional de CRM adiciona identidade do cliente, dados de contato e contexto de negócio às contas do Ledger do Midaz, fora do ledger. O CRM não faz parte do domínio transacional do ledger. Ele adiciona atributos de negócio às contas do ledger. O CRM é onde vivem os metadados de usuário. Ele não guarda saldos, transferências ou tarifas. Ele registra quem está por trás de uma conta e o que você precisa para rodar seu negócio. ## API atual *** O CRM é servido pelo Ledger apenas em `/v2`, sob `/v2/organizations/{organization_id}/...`. O `/v1` não expõe o CRM. Use o namespace de autorização `midaz` com os recursos `holders` e `instruments`. > [!TIP] > > **Teste o CRM localmente** > > Você pode rodar o CRM localmente, sem Kubernetes, com o stack do Midaz de [Primeiros passos](https://docs.lerian.studio/pt/products/midaz/midaz-getting-started.md). ## Por que usar o CRM? *** As contas do ledger do Midaz são genéricas por design. Elas são orientadas à transação e agnósticas de domínio. O CRM adiciona significado a essas contas e vincula cada uma a um perfil de usuário e a um contexto de negócio. Você não precisa usar o CRM. Pode adotá-lo depois, apenas quando seu caso de uso precisar de metadados de cliente ou de negócio além do ledger. ### Exemplos de casos de uso * **Bancário (pessoas físicas e jurídicas)**: o CRM guarda identificadores como CPF ou CNPJ, um endereço, dados de contato ou números de conta. O Midaz roda a mesma lógica de transação para os dois tipos de cliente. * **Cadeias de suprimento (fornecedor, fábrica, varejista)**: o CRM rastreia metadados como IDs de fornecedor, localizações de armazém ou detalhes de contrato. Esses dados não pertencem à transação, mas orientam decisões de negócio. > [!TIP] > > O CRM vem embutido no ledger do Midaz, então não há um serviço separado para fazer deploy. Use-o apenas se o seu produto ou contexto regulatório precisar de metadados de cliente ou de negócio. ## Entidades *** O CRM tem duas entidades principais: * **[Titular](https://docs.lerian.studio/pt/products/midaz/crm/holders.md)** – a entidade principal do CRM. Representa a persona de uma conta do ledger do Midaz. Guarda atributos de identidade e características individuais. * **[Instrumento](https://docs.lerian.studio/pt/products/midaz/crm/alias-accounts.md)** – o contexto de negócio de uma [conta do ledger](https://docs.lerian.studio/pt/products/midaz/accounts.md) no **Ledger do Midaz**. Guarda detalhes financeiros como informações de conta bancária. A *Figura 1* mostra como as entidades do CRM se conectam ao Midaz. ![Como as entidades do CRM, Titular e Instrumento, se conectam a contas no ledger do Midaz](https://mintcdn.com/lerian-49cb71fc/ps2sUQlGBPg-b1IO/images/pt/d2/entities-new.svg?fit=max\&auto=format\&n=ps2sUQlGBPg-b1IO\&q=85\&s=6c06f520dbf2c6b5028b372b9ddfded3) Figura 1. Como as entidades do CRM se conectam ao Midaz ## Princípios de design *** O CRM foca em: * **Separação de responsabilidades**: mantém os dados de perfil de usuário fora da lógica de transação. * **Deploy mais simples**: o CRM vem embutido no binário do ledger, sem serviço separado para rodar. * **Fronteiras de domínio claras**: evolui com o Midaz sem se acoplar aos internos do ledger. > [!CAUTION] > > O CRM não valida processos de compliance como o KYC. É uma camada de dados neutra e persistente. ## Comportamento da API *** O CRM roda dentro do binário do ledger do Midaz. Ele expõe uma API de registro para dados não transacionais vinculados a contas do Midaz. * Ele não aplica validações como status do usuário, perfil de risco ou verificação de documentos. * Ele é agnóstico ao ativo ou à lógica de agrupamento usados nas contas do Midaz. * Ele dá acesso consistente aos metadados de titular sem carregar a camada de transação. ## Segurança e compliance *** No BYOC, você executa o Midaz e seus componentes na sua própria infraestrutura. Você mantém o controle da sua infraestrutura, das suas políticas de compliance e do ciclo de vida dos dados de usuário. O CRM vem com o Midaz e segue os mesmos padrões de segurança do restante da plataforma: * **Dados em trânsito**: o Midaz serve HTTP simples, então termine o TLS no seu ingress ou service mesh. * **Dados em repouso**: o Midaz criptografa os campos protegidos do CRM antes de armazená-los. > [!CAUTION] > > Você é responsável pelo gerenciamento das chaves de criptografia. Use um serviço de gerenciamento de segredos para guardar e controlar o acesso às chaves. Você define e aplica suas próprias políticas para LGPD, GDPR e outras regras regionais de proteção de dados. O CRM fornece a estrutura. Revise as [recomendações de segurança](https://docs.lerian.studio/pt/products/midaz/security-recommendations.md) antes de fazer deploy de qualquer componente no seu ambiente. Aplique boas práticas de segurança a todos os componentes: **Access Manager**, **Fees Engine**, **Pix** e **CRM**. Proteja as fronteiras de rede, gerencie segredos, aplique patches e reforce o controle de acesso. ## Estratégias de exclusão de dados *** O CRM dá a você controle total sobre como ele remove dados. Ele oferece duas opções: * **Exclusão reversível** (padrão): o CRM marca o registro como excluído, mas o mantém no banco de dados. Use-a para manter uma trilha de auditoria ou recuperar dados depois. * **Exclusão definitiva**: onde sua política permite a remoção, o CRM remove o registro do banco de dados dele. Suas políticas definem o comportamento. ## Controle de acesso *** Para restringir quem pode acessar seus dados de CRM, habilite nosso [Access Manager](https://docs.lerian.studio/pt/platform/access-manager.md). ### Habilitando o Access Manager Primeiro, instale o **Access Manager**. Em seguida, abra o arquivo `.env` do ledger do Midaz e defina estas variáveis de ambiente: ```text Text theme={null} ## AUTH PLUGIN_AUTH_HOST=http://plugin-auth:4000 PLUGIN_AUTH_ENABLED=true ``` Depois de habilitá-lo, o CRM aplica as permissões de acesso da sua configuração de autenticação. > [!TIP] > > Para avaliar o Access Manager, [fale com nosso time](https://lerian.studio/contact). > [!TIP] > > Veja [Primeiros passos com o CRM](https://docs.lerian.studio/pt/products/midaz/crm/crm-getting-started.md) para um guia passo a passo. ## Próximos passos *** > [card] [Conceitos principais](https://docs.lerian.studio/pt/products/midaz/crm/crm-core-concepts-overview.md) > > Entenda as entidades principais gerenciadas pelo CRM: Titulares e Instrumentos. > [card] [Explore a API do CRM](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-holder.md) > > Veja os endpoints para titulares, instrumentos e partes relacionadas. > [card] [Usando o CRM](https://docs.lerian.studio/pt/products/midaz/crm/crm-using-overview.md) > > Aprenda a cadastrar titulares e vinculá-los a contas do ledger. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.