> ## 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, da instalação do ambiente à criação da sua primeira estrutura de ledger.

<Tip>
  **Este guia é destinado a desenvolvedores** que estão configurando o Midaz pela primeira vez. Se você está procurando uma visão geral de nível de negócio sobre como o Midaz funciona, veja [O que é o Midaz?](/pt/midaz/what-is-midaz). Para opções de deploy, veja [SaaS e BYOC](/pt/deployment-models).
</Tip>

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

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

<Tip>
  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](/pt/platform/access-manager/access-manager).
</Tip>

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

* [**Para criar uma Organização, use o endpoint Criar uma Organização.**](/pt/reference/midaz/create-an-organization)

<Tip>
  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.
</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 [Listar Organizações](/pt/reference/midaz/list-organizations).
  * Recupere uma Organização específica com o endpoint [Recuperar uma Organização](/pt/reference/midaz/retrieve-an-organization).
  * Atualize os detalhes da Organização usando o endpoint [Atualizar uma Organização](/pt/reference/midaz/update-an-organization).
  * Exclua uma Organização em Homologação usando o endpoint [Excluir uma Organização](/pt/reference/midaz/delete-an-organization).
    * Para Organizações em Produção, a exclusão requer contato com o suporte da Lerian por questões 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 Criar um Ledger.**](/pt/reference/midaz/create-a-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 [Listar Ledgers](/pt/reference/midaz/list-ledgers).
  * Recupere um Ledger específico com o endpoint [Recuperar um Ledger](/pt/reference/midaz/retrieve-a-ledger).
  * Atualize os detalhes do Ledger usando o endpoint [Atualizar um Ledger](/pt/reference/midaz/update-a-ledger).
  * Exclua um Ledger em Homologação usando o endpoint [Excluir um Ledger](/pt/reference/midaz/delete-a-ledger).
    * Para Ledgers em Produção, a exclusão requer contato com o suporte da Lerian por questões de segurança.
</Accordion>

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

* [**Para criar um Asset, use o endpoint Criar um Asset.**](/pt/reference/midaz/create-an-asset)

<Tip>
  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.
</Tip>

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

<Accordion title="Gerenciando Assets">
  * Recupere todos os Assets usando o endpoint [Listar Assets](/pt/reference/midaz/list-assets).
  * Recupere um Asset específico com o endpoint [Recuperar um Asset](/pt/reference/midaz/retrieve-an-asset).
  * Atualize os detalhes do Asset usando o endpoint [Atualizar um Asset](/pt/reference/midaz/update-an-asset).
  * Exclua um Asset com o endpoint [Excluir um Asset](/pt/reference/midaz/delete-an-asset).
</Accordion>

### 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 criar um Segmento, use o endpoint Criar um Segmento.**](/pt/reference/midaz/create-a-segment)

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

<Accordion title="Gerenciando Segmentos">
  * Recupere todos os Segmentos usando o endpoint [Listar Segmentos](/pt/reference/midaz/list-segments).
  * Recupere um Segmento específico com o endpoint [Recuperar um Segmento](/pt/reference/midaz/retrieve-a-segment).
  * Atualize os detalhes do Segmento usando o endpoint [Atualizar um Segmento](/pt/reference/midaz/update-a-segment).
  * Exclua um Segmento usando o endpoint [Excluir um Segmento](/pt/reference/midaz/delete-a-segment).
</Accordion>

### Etapa 2.5 - Crie um Portfólio

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

* [**Para criar um Portfólio, use o endpoint Criar um Portfólio.**](/pt/reference/midaz/create-a-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 [Listar Portfólios](/pt/reference/midaz/list-portfolios).
  * Recupere um Portfólio específico com o endpoint [Recuperar um Portfólio](/pt/reference/midaz/retrieve-a-portfolio).
  * Atualize os detalhes do Portfólio usando o endpoint [Atualizar um Portfólio](/pt/reference/midaz/update-a-portfolio).
  * Exclua um Portfólio com o endpoint [Excluir um Portfólio](/pt/reference/midaz/delete-a-portfolio).
</Accordion>

### 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 criar uma conta, use o endpoint Criar uma Conta.**](/pt/reference/midaz/create-an-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 [Listar Contas](/pt/reference/midaz/list-accounts).
  * Recupere uma Conta específica com o endpoint [Recuperar uma Conta](/pt/reference/midaz/retrieve-an-account).
  * Atualize os detalhes da Conta usando o endpoint [Atualizar uma Conta](/pt/reference/midaz/update-an-account).
  * Exclua uma Conta com o endpoint [Excluir uma Conta](/pt/reference/midaz/delete-an-account).
</Accordion>

## Etapa 3 - Explore nossas APIs

***

Mergulhe na [referência da API](/pt/reference/introduction) 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.

* Explore nosso [Hub de Documentação](/pt/welcome-to-our-guides) para guias e recursos detalhados.

* Junte-se à [comunidade no Discord](https://discord.lerian.studio/).

* [Entre em contato com nossa equipe de suporte](https://lerian.studio/support) para assistência personalizada.
