Como usar esta documentação
A documentação está organizada para apoiar descoberta, desenho do fluxo e implementação técnica. O objetivo é evitar que você precise procurar em uma coleção grande de requests sem contexto.Essa página explica como o SITE é organizado (guias vs. catálogo vs. API
Reference). Se você quer um caminho recomendado por perfil ou objetivo, veja
Mapa da documentação. Se quer só bons termos
para pesquisar, veja Busca rápida.
O caminho mais comum
1
Comece pelo Quickstart
Use o Quickstart para validar credenciais, gerar token
e executar uma primeira chamada com Postman, Windows, macOS ou Linux.
2
Entenda o domínio
Use os guias de Pessoas, Empresas e Fluxos principais para entender quando
cada produto faz sentido.
3
Escolha os códigos service
Use Escolha o serviço certo quando você
sabe o problema de negócio, mas ainda não sabe quais consultas combinar.
4
Implemente no API Reference
Use a API Reference para copiar payloads,
conferir parâmetros e mapear responses.
Se você não sabe por onde executar
Você não precisa começar escrevendo código. A forma mais simples é testar no Postman, porque a ferramenta deixa URL, headers e body separados em abas. Depois que a chamada funcionar no Postman, você pode repetir o mesmo request no terminal:
O Quickstart mostra esse passo a passo com exemplos para
cada ambiente.
Áreas da documentação
Guias vs API Reference
Use os guias para decidir o que consumir. Use a API Reference para implementar a chamada.Quando usar o catálogo técnico
O catálogo técnico é útil quando você precisa conferir listas maiores de campos ou comparar serviços dentro do mesmo domínio. Para endpoints operacionais, como consulta ou alteração de cliente, use a seção Endpoints da API no API Reference.Quando usar exemplos por linguagem
Use Exemplos por linguagem quando quiser acelerar a implementação inicial emcurl, Node.js, Python ou C#.
Depois de validar o fluxo, troque o service e os campos do payload pelo
produto desejado.