Guia de início rápido

Siga estas etapas para configurar o Midaz.

​

Etapa 1 - Configure seu ambiente

---

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

• Isso instala o Midaz Ledger.

​

Autenticação e autorização

O Midaz não inclui um sistema de autenticação ou autorização integrado. Isso oferece flexibilidade para integrar com seu provedor de identidade ou pilha de segurança existente. Se você precisar de uma solução pronta para uso, pode habilitar o Access Manager, um recurso opcional desenvolvido pela Lerian. Ele trata tanto a autenticação quanto a autorização em todo o seu ecossistema Lerian, incluindo o Midaz e todos os outros produtos Lerian.

​

Etapa 2 - Crie a estrutura do Midaz

---

Comece criando a estrutura de dados que seus workflows usam.

​

Etapa 2.1 - Crie uma Organização

A primeira etapa é criar sua Organização dentro do Midaz.

• Para criar uma Organização, use o endpoint Create an Organization.

Para uma lista completa de endpoints para gerenciar sua Organização, expanda a seção abaixo:

Gerenciando Organizações

• Recupere todas as Organizações usando o endpoint List Organizations.
• Recupere uma Organização específica com o Retrieve an Organization
• Atualize os detalhes da Organização usando o endpoint Update an Organization.
• Exclua uma Organização em Homologação usando o endpoint Delete an Organization.
  • Para Organizações em Produção, a exclusão exige contato com o suporte da Lerian por motivos de segurança.

​

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 criar um Ledger, use o endpoint Create a Ledger.

Para uma lista completa de endpoints para gerenciar seu Ledger, expanda a seção abaixo:

Gerenciando Ledgers

• Recupere todos os Ledgers usando o endpoint List Ledgers.
• Recupere um Ledger específico com o endpoint Retrieve a Ledger.
• Atualize os detalhes do Ledger usando o endpoint Update a Ledger.
• Exclua um Ledger em Homologação usando o endpoint Delete a Ledger.
  • Para Ledgers em Produção, a exclusão exige contato com o suporte da Lerian por motivos de segurança.

​

Etapa 2.3 - Crie os Ativos

Sua Organização pode ter vários Ativos. No entanto, cada Ativo deve ser criado individualmente, o que permite configurações específicas, como casas decimais.

• Para criar um Ativo, use o endpoint Create an Asset.

Para uma lista completa de endpoints para gerenciar seus Ativos, expanda a seção abaixo:

Gerenciando Ativos

• Recupere todos os Ativos usando o endpoint List Assets.
• Recupere um Ativo específico com o endpoint Retrieve an Asset.
• Atualize os detalhes do Ativo usando o endpoint Update an Asset.
• Exclua um Ativo com o endpoint Delete an Asset.

​

Etapa 2.4 - Crie um Segmento (opcional)

Se quiser, você pode usar o ID do Segmento como um rótulo de agrupamento personalizado que reúne contas de acordo com políticas definidas pelo usuário.

• Para criar um Produto, use o endpoint Create a Segment.

Para uma lista completa de endpoints para gerenciar seu Segmento, expanda a seção abaixo:

Gerenciando Segmento

• Recupere todos os Segmentos usando o endpoint List Segments.
• Recupere um Segmento específico com o endpoint Retrieve a Segment.
• Atualize os detalhes do Segmento usando o endpoint Update a Segment.
• Exclua um Segmento usando o endpoint Delete a Segment.

​

Etapa 2.5 - Crie um Portfólio

Crie um Portfólio para agrupar suas contas de diferentes Ativos.

• Para criar um Portfólio, use o endpoint Create a Portfolio.

Para uma lista completa de endpoints para gerenciar seus Portfólios, expanda a seção abaixo:

Gerenciando Portfólios

• Recupere todos os Portfólios usando o endpoint List Portfolios.
• Recupere um Portfólio específico com o endpoint Retrieve a Portfolio.
• Atualize os detalhes do Portfólio usando o endpoint Update a Portfolio.
• Exclua um Portfólio com o endpoint Delete a Portfolio.

​

Etapa 2.6 - Crie as Contas

Agora você pode adicionar as contas relacionadas aos Ativos que quer usar com o Ledger. Você precisará criar uma conta para cada Ativo.

• Para criar uma conta, use o endpoint Create an Account.

Para uma lista completa de endpoints para gerenciar suas Contas, expanda a seção abaixo:

Gerenciando Contas

• Recupere todas as Contas usando o endpoint List Accounts.
• Recupere uma Conta específica com o endpoint Retrieve an Account.
• Atualize os detalhes da Conta usando o endpoint Update an Account.
• Exclua uma Conta com o endpoint Delete an Account.

​

Etapa 3 - Explore nossas APIs

---

Consulte a Referência da API para saber mais sobre o Midaz, desde o tratamento de metadados até a idempotência.

​

Precisa de ajuda?

---

• Explore nossa central de documentação para guias detalhados e recursos.
• Participe da comunidade no Discord.
• Fale com nossa equipe de suporte para um atendimento personalizado.