O Playground da API: experimentar um pedido real a partir do navegador, passo a passo

A resposta curta: o Playground faz pedidos reais à API a partir do navegador, sem instalar nada. Escolhe a operação, preenche o pedido, envia e vê a resposta. Ao mesmo tempo, mostra o código do pedido em curl, PHP, Python e JavaScript, que acompanha o que vai escrevendo.

Duas formas de o abrir

Onde	Como funciona
Na página Playground	Mostra todas as operações, com a caixa «Pesquisar operação». Escolhe uma e o painel abre nessa mesma página.
Dentro de cada operação	Nas páginas das áreas, cada operação tem o botão Playground, que abre o mesmo painel sem sair da página.

Passo a passo

1	Comece por uma operação sem chave: GET /v1/ping confirma que a API responde. É o melhor primeiro teste.

2	Escreva a chave, quando a operação a pede, no campo «Chave da API». Para ensaiar, use uma chave sandbox_. O botão Mostrar deixa ver o que escreveu.

3	Preencha os parâmetros. Os obrigatórios estão marcados.

4	Escolha os cabeçalhos. Accept-Language define a língua das mensagens; «Acrescentar cabeçalho» junta outros.

5	Escreva o corpo em JSON, nas operações que o têm. A página diz se o JSON é válido antes de enviar.

6	Carregue em Enviar pedido, ou em Ctrl+Enter.

7	Leia a resposta: estado, tempo, pedidos restantes, corpo e cabeçalhos. Veja como ler a resposta.

Do navegador, a API só aceita quatro cabeçalhos: Authorization, Content-Type, Idempotency-Key e Accept-Language. Os outros que acrescentar entram só no código gerado, para usar no seu programa.

Porque funciona aqui e não no seu site

Os navegadores só podem chamar a API a partir da documentação. As páginas do seu site não conseguem usar a chave directamente, e ainda bem: a chave ficaria à vista de quem abrisse a página. No seu projecto, a chamada faz-se no servidor. O porquê está em erros de CORS.

O Playground precisa de JavaScript. Sem ele, cada operação abre a sua explicação, na página da área. Cuidados com a chave: a sua chave no Playground.

Faça o primeiro pedido agora: o ping não precisa de chave.

Abrir o Playground

VEJA TAMBÉM

A sua chave no Playground da API: onde fica, porquê começar com sandbox_ e o aviso das prod_

Ler a resposta no Playground da API: estado, tempo, pedidos restantes, cabeçalhos e histórico

Exemplos de código na documentação da API: curl, PHP, Python e JavaScript, prontos a adaptar

Um percurso de leitura na documentação da API: do primeiro pedido à integração pronta

Erro de CORS entre o seu front end e a sua API: como resolver

PRODUTO RECOMENDADO

Hospedagem de sites com cPanel

Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 396,00 MT/mês (plano de 3 anos, com cupão)

Ver planos

Categorias

Categorias