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

# Bem-vindo à nossa Referência da API

> Explore as APIs da Lerian, organizadas por produto e plugin, com as convenções que elas compartilham.

> [!TIP]
>
> **Esta seção é para desenvolvedores e integradores técnicos**. Para uma visão geral de negócio do que os produtos Lerian fazem, comece por [Quem somos](https://docs.lerian.studio/pt/start-here/about-lerian/who-we-are.md). Você também pode explorar páginas de produtos específicos, como [Sobre o Midaz](https://docs.lerian.studio/pt/products/midaz/about-midaz.md) e [O que é o Matcher?](https://docs.lerian.studio/pt/products/matcher/what-is-matcher.md).

Esta seção documenta as APIs da Lerian, agrupadas em Produtos, Trilhos Brasil, Interfaces e Plataforma.

## Estruturado por produto, com suporte a plugins

***

Cada produto, como Midaz ou Reporter, tem sua própria seção de API. Plugins, como as interfaces de Pix e TED, têm suas próprias seções em Interfaces.

Por exemplo, a referência do Midaz tem APIs para entidades principais como Ledgers e Transações. Ela também cobre Fees e CRM, que fazem parte do Midaz.

## Principais destaques

***

* **Arquitetura plugin-first**: Os recursos são modulares. Cada plugin tem seu próprio conjunto de APIs.

## O que você vai encontrar aqui

***

* **Fundamentos de integração**: Conceitos como novas tentativas, paginação, metadados e ferramentas de estabilidade.
* **Estabilidade e qualidade**: Tratamento de erros, boas práticas de teste, processo de QA e cobertura de suporte.
* **Listas de erros**: Cada referência de API inclui uma referência dedicada de códigos de erro.

## Como navegar

***

Para acessar a referência de um produto:

**Step 1**

Você já está na seção **Referência da API** da nossa documentação.

**Step 2**

Abra a lista suspensa na barra lateral esquerda e selecione o produto com o qual você está trabalhando, como Midaz ou Reporter.

**Step 3**

Você vai chegar a um espaço dedicado com detalhes de API específicos do produto, referências completas de schema e exemplos reais de payload.


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