Como usar esta documentação?

Dicas básicas sobre como usar esta documentação

Toda nossa documentação é criada de forma a facilitar o entendimento de todos nossos conceitos de produto, além de prover informações completas sobre todo nosso processo de integração.

Para tornar esta documentação mais acessível e completa, dividimos a mesma em duas sessões que podem ser acessadas pelo menu superior desta página:

Documentação

Trata-se de um guia com explicações conceituais do nosso sistema, sem abordar aspectos técnicos da mesma, como endpoints e requisições HTTP.

Nela você terá explicações mais detalhadas sobre como funciona nosso produto.

Referência da API

Trata-se de uma documentação técnica, que enfatiza o funcionamento de nossa API e os endpoints através do qual você poderá utilizar nossos serviços.

Ela é destinada para programadores que estão integrando-se conosco, e possui os seguintes recursos úteis:

Menu Lateral

Menu lateralMenu lateral

Menu lateral

O menu lateral serve como um índice de todos os itens da Documentação e da Referência.

Com ele você consegue se guiar de maneira fácil por todos os tópicos de nosso sistema.

Exemplos de integração

Exemplo de integraçãoExemplo de integração

Exemplo de integração

Os exemplos de integração mostram como montar a requisição para acessar algum recurso da nossa API. Através dele você terá exemplos de requisição cURL e os SDKs que temos disponíveis.

Do lado direito, teremos exemplos de retorno HTTP para cada tipo de requisição.

Com isso em mente você estará pronto para integrar conosco! E não se esqueça, qualquer duvida não hesite em nos contatar!