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:
1
Você já está na seção Referência da API da nossa documentação.
2
Abra a lista suspensa na barra lateral esquerda e selecione o produto com o qual você está trabalhando, como Midaz ou Reporter.
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.