Pular para o conteúdo principal
As APIs da Lerian oferecem acesso confiável, escalável e seguro a tudo que a plataforma disponibiliza, desde fluxos de onboarding e gerenciamento de ledger até plugins para autenticação, tarifas, CRM e relatórios. Esta seção é seu ponto de entrada para todas as APIs do ecossistema Lerian, organizadas por produto. Seja integrando diretamente com o Midaz ou automatizando relatórios com o Reporter, você encontrará a referência completa aqui, incluindo todas as APIs de plugins relacionadas.

​
Estruturado por produto, com suporte a plugins

Cada produto, como Midaz ou Reporter, possui sua própria seção de API. Quando um produto suporta plugins (ex.: Midaz), as APIs desses plugins estão incorporadas na referência do produto. Isso facilita a compreensão da superfície completa do que você está integrando. Por exemplo, dentro da referência do Midaz, você encontrará APIs para entidades principais (como Ledgers e Transações), bem como para plugins como Pix, CRM e Motor de Tarifas.

​
Destaques principais

  • RESTful e previsível: Todos os endpoints seguem métodos HTTP e códigos de status padrão.
  • Formatos consistentes: Requisições e respostas usam JSON, com tipagem e estruturas claras.
  • Versionamento explícito: As APIs são versionadas para evitar mudanças que quebrem compatibilidade.
  • Arquitetura orientada a plugins: Os recursos são modulares — cada plugin tem seu próprio conjunto de APIs, documentado junto ao produto que ele estende.
Trabalhando em um plugin ou integração personalizada?Visite o Partners Hub para padrões de desenvolvimento, diretrizes de documentação e ferramentas.Recomendado para parceiros, clientes e equipes internas trabalhando em plugins personalizados.

​
O que você encontrará aqui

  • Primeiros passos: Guia de início rápido, instruções do sandbox e como funciona o modelo de licenciamento da Lerian.
  • Fundamentos de integração: Conceitos como retentativas, paginação, metadados e ferramentas de estabilidade.
  • Estabilidade e qualidade: Tratamento de erros, boas práticas de testes, processo de QA e cobertura de suporte.
  • APIs dos produtos:
    • Midaz: Ledgers, Transações, Ativos, Contas, Portfólios e extensões de plugins
    • Reporter: Criação de relatórios, upload de templates, filtros e exportação de relatórios
  • Listas de erros: Cada produto e plugin inclui referências dedicadas de códigos de erro.
Você está visualizando a documentação da versão atual das APIs da Lerian.Se você está trabalhando com uma versão anterior, use o seletor de versão (canto superior esquerdo) para acessar a documentação legada e evitar problemas de compatibilidade.

​
Versão atual vs versões anteriores

Mantemos documentação para ambas:
  • Versão atual: Os recursos mais atualizados, com suporte ativo.
  • Versão anterior: Descontinuada, mas ainda disponível com suporte parcial por tempo limitado.
Use o seletor de versão no canto superior esquerdo da tela para garantir que você está lendo a documentação correta para o seu ambiente. E se algo não estiver claro, nos avise — estamos sempre evoluindo a documentação para atender às suas necessidades.

​
Como navegar

Para acessar a referência de um produto:
1
Você já está na seção de Referência de API da nossa documentação.
2
Abra o menu suspenso na barra lateral esquerda e selecione o produto com o qual você está trabalhando, como Midaz ou Reporter.
3
Você acessará um espaço dedicado com detalhes específicos da API do produto — incluindo plugins relacionados, referências completas de schema e exemplos de payloads reais.