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

> [!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?](https://docs.lerian.studio/pt/products/midaz/what-is-midaz.md). Para opções de deploy, veja [SaaS e BYOC](https://docs.lerian.studio/pt/start-here/evaluate-and-deploy/deployment-models.md).

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 Midaz](https://docs.lerian.studio/pt/products/midaz/midaz-setup.md).

* Isso instala o Midaz Ledger.

### Autenticação e autorização

O Midaz não inclui um sistema de autenticação ou autorização integrado. Você pode integrar o Midaz 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 a autenticação e a autorização do Midaz e de outros produtos Lerian.

> [!TIP]
>
> O Access Manager aceita padrões de identidade comuns como OAuth2 e OIDC. Para mais detalhes, consulte o guia [Access Manager](https://docs.lerian.studio/pt/platform/access-manager.md).

## 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.**](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-organization.md)

> [!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.

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

> [accordion] Gerenciando Organizações
>
> * Recupere todas as Organizações usando o endpoint [List Organizations](https://docs.lerian.studio/pt/reference/products/midaz/v2/list-organizations.md).
> * Recupere uma Organização específica com o [Retrieve an Organization](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-organization-by-id.md)
> * Atualize os detalhes da Organização usando o endpoint [Update an Organization](https://docs.lerian.studio/pt/reference/products/midaz/v2/update-organization.md).
> * Exclua uma Organização em Homologação usando o endpoint [Delete an Organization](https://docs.lerian.studio/pt/reference/products/midaz/v2/delete-organization.md).
>   * 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

Crie pelo menos um Ledger em cada Organização. Você pode criar vários Ledgers, se necessário.

* [**Para criar um Ledger, use o endpoint Create a Ledger.**](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-ledger.md)

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

> [accordion] Gerenciando Ledgers
>
> * Recupere todos os Ledgers usando o endpoint [List Ledgers](https://docs.lerian.studio/pt/reference/products/midaz/v2/list-ledgers.md).
> * Recupere um Ledger específico com o endpoint [Retrieve a Ledger](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-ledger-by-id.md).
> * Atualize os detalhes do Ledger usando o endpoint [Update a Ledger](https://docs.lerian.studio/pt/reference/products/midaz/v2/update-ledger.md).
> * Exclua um Ledger em Homologação usando o endpoint [Delete a Ledger](https://docs.lerian.studio/pt/reference/products/midaz/v2/delete-ledger.md).
>   * 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

Cada Ledger pode ter vários Ativos. Crie cada Ativo individualmente.

* [**Para criar um Ativo, use o endpoint Create an Asset.**](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-asset.md)

> [!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.

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

> [accordion] Gerenciando Ativos
>
> * Recupere todos os Ativos usando o endpoint [List Assets](https://docs.lerian.studio/pt/reference/products/midaz/v2/list-assets.md).
> * Recupere um Ativo específico com o endpoint [Retrieve an Asset](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-asset-by-id.md).
> * Atualize os detalhes do Ativo usando o endpoint [Update an Asset](https://docs.lerian.studio/pt/reference/products/midaz/v2/update-asset.md).
> * Exclua um Ativo com o endpoint [Delete an Asset](https://docs.lerian.studio/pt/reference/products/midaz/v2/delete-asset.md).

### 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 Segmento, use o endpoint Create a Segment.**](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-segment.md)

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

> [accordion] Gerenciando Segmento
>
> * Recupere todos os Segmentos usando o endpoint [List Segments](https://docs.lerian.studio/pt/reference/products/midaz/v2/list-segments.md).
> * Recupere um Segmento específico com o endpoint [Retrieve a Segment](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-segment-by-id.md).
> * Atualize os detalhes do Segmento usando o endpoint [Update a Segment](https://docs.lerian.studio/pt/reference/products/midaz/v2/update-segment.md).
> * Exclua um Segmento usando o endpoint [Delete a Segment](https://docs.lerian.studio/pt/reference/products/midaz/v2/delete-segment.md).

### Etapa 2.5 - Crie um Portfólio (opcional)

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

* [**Para criar um Portfólio, use o endpoint Create a Portfolio.**](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-portfolio.md)

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

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

### Etapa 2.6 - Crie as Contas

Agora você pode adicionar as contas relacionadas aos Ativos que quer usar com o Ledger. Cada Conta guarda um Ativo.

* [**Para criar uma conta, use o endpoint Create an Account.**](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-account.md)

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

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

## Etapa 3 - Explore nossas APIs

***

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

## Precisa de ajuda?

***

* Explore nossa [central de documentação](https://docs.lerian.studio/pt/start-here/welcome-to-our-guides.md) para guias detalhados e recursos.
* [Fale com nossa equipe de suporte](https://docs.lerian.studio/pt/products/midaz/lerian-support-portal.md) para um atendimento personalizado.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.