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

# API REST

> Integre com o Midaz por meio de uma API REST versionada: payloads JSON, versionamento explícito e um design previsível baseado em recursos.

A API REST do Midaz dá a você acesso programático ao ledger. Ela usa métodos HTTP padrão e códigos de status.

## Design REST, formato JSON e versionamento

***

* **Design RESTful**: A API segue os princípios REST para uma estrutura previsível.
* **Formato JSON**: A API documentada usa JSON para requisições e respostas.
* **Versionamento**: Prefixos de versão explícitos mantêm as mudanças retrocompatíveis.

A API expõe os recursos principais do Midaz: organizações, ledgers, contas, ativos, portfólios, transações e operações. Cada recurso tem seus próprios endpoints.

Para passar uma integração dos contratos da API v1 para os contratos v2, consulte [Migrar da API v1 para a API v2](https://docs.lerian.studio/pt/products/midaz/migrating-to-api-v2.md).

> [!TIP]
>
> Para detalhes técnicos sobre os endpoints disponíveis, veja a [Referência da API](https://docs.lerian.studio/pt/reference/introduction.md).


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