como começar

nesse guia de primeiros passos, fornecemos todas as informações necessárias para você se conectar às nossas APIs

seus primeiros passos

faça seu login

Em nossa página inicial, clique em fazer login, preencha seus dados e comece a usar nosso ambiente de teste.

Como fazer login

crie um novo projeto

Após o login, você será direcionado para a página das nossas APIs. Clique em “criar projeto” no menu Sandbox para acessar a página de projetos.

Criar um novo projeto

Na página de projetos Sandbox, clique em “criar projeto” e o nomeie, selecione as APIs que deseja utilizar e clique em “criar projeto”.

Selecione as APIs que deseja utilizar

crie suas credenciais

Em seu novo projeto, clique em “criar credenciais” para gerar seu client_id e client_secret, eles serão utilizados para chamar as APIs.

Criar credenciais

documentação da API

Após criar as chaves, clique em “ver documentação” da API desejada para carregar a página de teste de API, onde você terá acesso a documentação da aplicação.

Consultar a documentação da API desejada

Na documentação, clique no botão “ver especificação técnica” para acessar a página de teste das APIs.

Consultar a especificação técnica

Você também pode fazer download dos arquivos swagger de diferentes aplicações nas páginas de teste das APIs.

Realizar o download dos arquivos swagger das applicações

teste sua API

autenticação

Gere as credenciais client_id e cliente_secret do seu projeto caso ainda não o tenha feito, e clique em “solicitar token” para gerar o código.

Como solicitar o token para autenticação da API

execução

Habilite o botão “teste a API” e preencha os campos de parameters da API (não se esqueça dos campos obrigatórios), e clique em “testar”.

Como testar a API

resultado

Exemplo de resultado após a execução:

Resultado do teste da API

teste sua API via Postman

O Postman é um cliente REST para testar APIs. Permite ao usuário enviar solicitações, salvar respostas, adicionar testes e criar fluxos de trabalho. Para aprender mais sobre o Postman e descobrir suas funcionalidades acesse a página e faça o download do Postman.

Disponibilizamos também uma coleção para você testar nossas API's. Faça download da nossa coleção do Postman e comece agora mesmo!

1Download aplicação Postman