Descubra Como Testar a API

Utilizando o Swagger UI

Para uma experiência interativa de teste com nossa API, disponibilizamos uma interface Swagger UI. Siga os passos abaixo para testar a API:

Acesso à Referência da API: Primeiro, acesse nossa Referência da API. Aqui, você encontrará todos os endpoints disponíveis e poderá explorar as especificações detalhadas de cada um.
Geração do Token de Acesso: Para testar os endpoints, você precisará de um token de acesso. Isso pode ser obtido utilizando o endpoint /oauth2/token, que é o primeiro listado na referência da API. Use suas credenciais de sandbox para gerar o token.
Autenticação no Swagger UI: Após gerar o token, clique no botão "Authorize" no Swagger UI e insira o token de acesso. Isso permitirá que você faça solicitações autenticadas diretamente da interface do Swagger.
Teste os Endpoints: Com o token configurado, você pode usar a funcionalidade "Try it out" para fazer solicitações de teste diretamente pela interface do Swagger UI.

Para desenvolvedores que preferem usar o Postman, nossa API pode ser facilmente importada:

Baixe a API Reference: Baixe a referência da API no formato YAML a partir deste link.
Importe no Postman: No Postman, utilize a opção de importação para carregar a referência da API que você baixou. Isso irá configurar automaticamente todos os endpoints e parâmetros necessários para testar a API.
Configure as Credenciais: Assim como no Swagger UI, você precisará gerar um token de acesso e configurar no Postman para autenticar suas solicitações.

Sempre teste os cenários mais comuns de uso para garantir a integração correta.
Verifique a manipulação de erros e respostas para diferentes tipos de solicitações.

Estes passos lhe proporcionarão uma compreensão abrangente de como nossa API funciona e como integrá-la com suas aplicações.