> ## 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.

# Guia de início rápido

> Configure o Midaz pela primeira vez, desde a instalação e configuração do ambiente até a criação da primeira estrutura de ledger e o envio de uma transação de teste.

<Tip>
  **Este guia é indicado para desenvolvedores** que estão configurando o Midaz pela primeira vez. Se você busca uma visão geral de negócio sobre como o Midaz funciona, veja [O que é o Midaz?](/pt/products/midaz/what-is-midaz). Para opções de deploy, veja [SaaS e BYOC](/pt/start-here/evaluate-and-deploy/deployment-models).
</Tip>

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](/pt/products/midaz/midaz-setup).

* 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.

<Tip>
  O Access Manager aceita padrões de identidade comuns como OAuth2 e OIDC e se integra nativamente a todos os produtos Lerian. Para mais detalhes, consulte o guia [Access Manager](/pt/platform/access-manager).
</Tip>

## 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.**](/pt/reference/products/midaz/v2/create-organization)

<Tip>
  Se sua organização tiver várias filiais, você pode criar várias Organizações e designar uma **Organização Pai**.

  Por exemplo, se a Empresa XYZ tem filiais em Nova York e no Brasil, você pode criar uma Organização para a Empresa XYZ e defini-la como a organização pai da XYZ Nova York e da XYZ Brasil.
</Tip>

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

<Accordion title="Gerenciando Organizações">
  * Recupere todas as Organizações usando o endpoint [List Organizations](/pt/reference/products/midaz/v2/list-organizations).
  * Recupere uma Organização específica com o [Retrieve an Organization](/pt/reference/products/midaz/v2/get-organization-by-id)
  * Atualize os detalhes da Organização usando o endpoint [Update an Organization](/pt/reference/products/midaz/v2/update-organization).
  * Exclua uma Organização em Homologação usando o endpoint [Delete an Organization](/pt/reference/products/midaz/v2/delete-organization).
    * Para Organizações em Produção, a exclusão exige contato com o suporte da Lerian por motivos de segurança.
</Accordion>

### 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.**](/pt/reference/products/midaz/v2/create-ledger)

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

<Accordion title="Gerenciando Ledgers">
  * Recupere todos os Ledgers usando o endpoint [List Ledgers](/pt/reference/products/midaz/v2/list-ledgers).
  * Recupere um Ledger específico com o endpoint [Retrieve a Ledger](/pt/reference/products/midaz/v2/get-ledger-by-id).
  * Atualize os detalhes do Ledger usando o endpoint [Update a Ledger](/pt/reference/products/midaz/v2/update-ledger).
  * Exclua um Ledger em Homologação usando o endpoint [Delete a Ledger](/pt/reference/products/midaz/v2/delete-ledger).
    * Para Ledgers em Produção, a exclusão exige contato com o suporte da Lerian por motivos de segurança.
</Accordion>

### 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.**](/pt/reference/products/midaz/v2/create-asset)

<Tip>
  Quando você cria um Ativo, o Midaz configura automaticamente uma Conta Externa, caso ainda não exista uma. A Conta Externa respalda todas as transações que entram e saem do Ledger.
</Tip>

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

<Accordion title="Gerenciando Ativos">
  * Recupere todos os Ativos usando o endpoint [List Assets](/pt/reference/products/midaz/v2/list-assets).
  * Recupere um Ativo específico com o endpoint [Retrieve an Asset](/pt/reference/products/midaz/v2/get-asset-by-id).
  * Atualize os detalhes do Ativo usando o endpoint [Update an Asset](/pt/reference/products/midaz/v2/update-asset).
  * Exclua um Ativo com o endpoint [Delete an Asset](/pt/reference/products/midaz/v2/delete-asset).
</Accordion>

### 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.**](/pt/reference/products/midaz/v2/create-segment)

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

<Accordion title="Gerenciando Segmento">
  * Recupere todos os Segmentos usando o endpoint [List Segments](/pt/reference/products/midaz/v2/list-segments).
  * Recupere um Segmento específico com o endpoint [Retrieve a Segment](/pt/reference/products/midaz/v2/get-segment-by-id).
  * Atualize os detalhes do Segmento usando o endpoint [Update a Segment](/pt/reference/products/midaz/v2/update-segment).
  * Exclua um Segmento usando o endpoint [Delete a Segment](/pt/reference/products/midaz/v2/delete-segment).
</Accordion>

### 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.**](/pt/reference/products/midaz/v2/create-portfolio)

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

<Accordion title="Gerenciando Portfólios">
  * Recupere todos os Portfólios usando o endpoint [List Portfolios](/pt/reference/products/midaz/v2/list-portfolios).
  * Recupere um Portfólio específico com o endpoint [Retrieve a Portfolio](/pt/reference/products/midaz/v2/get-portfolio-by-id).
  * Atualize os detalhes do Portfólio usando o endpoint [Update a Portfolio](/pt/reference/products/midaz/v2/update-portfolio).
  * Exclua um Portfólio com o endpoint [Delete a Portfolio](/pt/reference/products/midaz/v2/delete-portfolio).
</Accordion>

### 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.**](/pt/reference/products/midaz/v2/create-account)

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

<Accordion title="Gerenciando Contas">
  * Recupere todas as Contas usando o endpoint [List Accounts](/pt/reference/products/midaz/v2/list-accounts).
  * Recupere uma Conta específica com o endpoint [Retrieve an Account](/pt/reference/products/midaz/v2/get-account-by-id).
  * Atualize os detalhes da Conta usando o endpoint [Update an Account](/pt/reference/products/midaz/v2/update-account).
  * Exclua uma Conta com o endpoint [Delete an Account](/pt/reference/products/midaz/v2/delete-account).
</Accordion>

## Etapa 3 - Explore nossas APIs

***

Consulte a [Referência da API](/pt/reference/introduction) para saber mais sobre o Midaz, desde o tratamento de metadados até a idempotência.

## Precisa de ajuda?

***

* Explore nossa [central de documentação](/pt/start-here/welcome-to-our-guides) para guias detalhados e recursos.

* Participe da [comunidade no Discord](https://discord.lerian.studio/).

* [Fale com nossa equipe de suporte](https://lerian.studio/support) para um atendimento personalizado.
