Pular para o conteúdo principal
Começar com o Midaz é simples. Siga estas etapas para construir sua base e explorar as possibilidades.

​
Etapa 1 - Configure seu ambiente

Para configurar seu ambiente Midaz, siga as etapas na página Instalando o monorepo do Midaz.
  • Isso instalará o Midaz Ledger.

​
Autenticação e autorização

O Midaz não inclui um sistema integrado de autenticação ou autorização. Isso oferece flexibilidade para integrar com seu provedor de identidade ou stack de segurança existente. Se você precisa de uma solução pronta para uso, pode habilitar o Access Manager, uma funcionalidade opcional desenvolvida pela Lerian. Ele gerencia tanto autenticação quanto autorização, facilitando o controle de quem pode acessar o quê em todo o seu ecossistema Lerian — incluindo o Midaz e todos os outros produtos da Lerian.
O Access Manager suporta padrões de identidade comuns como OAuth2 e OIDC e se integra nativamente com todos os produtos da Lerian. Para mais detalhes, consulte o guia do Access Manager.

​
Etapa 2 - Crie sua estrutura no Midaz

Comece criando a estrutura de dados que alimenta seus fluxos de trabalho.

​
Etapa 2.1 - Crie uma Organização

O primeiro passo é criar sua Organização dentro do Midaz.
Se sua organização possui várias filiais, você pode criar diversas Organizações e designar uma Organização Pai.Por exemplo, se a Empresa XYZ possui filiais em Nova York e no Brasil, você pode criar uma Organização para a Empresa XYZ e defini-la como pai da XYZ Nova York e XYZ Brasil.
Para uma lista completa de endpoints para gerenciar sua Organização, expanda a seção abaixo:

​
Etapa 2.2 - Crie um Ledger

Cada organização deve ter pelo menos um Ledger. No entanto, você pode ter vários Ledgers dentro de cada Organização, se necessário. Para uma lista completa de endpoints para gerenciar seu Ledger, expanda a seção abaixo:
  • Recupere todos os Ledgers usando o endpoint Listar Ledgers.
  • Recupere um Ledger específico com o endpoint Recuperar um Ledger.
  • Atualize os detalhes do Ledger usando o endpoint Atualizar um Ledger.
  • Exclua um Ledger em Homologação usando o endpoint Excluir um Ledger.
    • Para Ledgers em Produção, a exclusão requer contato com o suporte da Lerian por questões de segurança.

​
Etapa 2.3 - Crie os Assets

Sua Organização pode ter vários Assets. No entanto, cada Asset deve ser criado individualmente, permitindo configurações específicas como casas decimais.
Quando você cria um Asset, o Midaz configura automaticamente uma Conta Externa se ainda não existir uma. Isso garante suporte contínuo para todas as transações que entram e saem do Ledger.
Para uma lista completa de endpoints para gerenciar seus Assets, expanda a seção abaixo:

​
Etapa 2.4 - Crie um Segmento (opcional)

Se desejar, você pode usar o Segment ID como um rótulo de agrupamento personalizado que permite agrupar contas de acordo com políticas definidas pelo usuário, apoiando a segmentação e o gerenciamento eficiente de contas. Para uma lista completa de endpoints para gerenciar seu Segmento, expanda a seção abaixo:

​
Etapa 2.5 - Crie um Portfólio

Crie um Portfólio para agrupar suas contas de diferentes Assets. Para uma lista completa de endpoints para gerenciar seus Portfólios, expanda a seção abaixo:

​
Etapa 2.6 - Crie as Contas

Agora você pode adicionar as contas relacionadas aos Assets que deseja utilizar com o Ledger. Você precisará criar uma conta para cada Asset. Para uma lista completa de endpoints para gerenciar suas Contas, expanda a seção abaixo:

​
Etapa 3 - Explore nossas APIs

Mergulhe na referência da API para saber mais sobre como o Midaz pode elevar suas operações. Do tratamento de metadados à idempotência, cada detalhe foi projetado para simplicidade e eficiência.

​
Precisa de ajuda?

Você não está sozinho. Estamos aqui para apoiar você em cada etapa do caminho.