A resposta curta: depois de enviar um pedido no Playground, a caixa «Resposta» mostra o estado, o tempo, o tamanho e os pedidos que restam neste minuto, e dois separadores: Corpo e Cabeçalhos. É o mesmo que o seu programa vai receber.
O que cada parte diz
| Parte |
O que diz |
| Estado |
O código HTTP. Os 2xx são sucesso; os 4xx dizem que algo no pedido, na chave ou na permissão não está certo; os 5xx são falhas do lado da API. |
| Tempo |
Quanto a resposta demorou a chegar. |
| Tamanho |
O tamanho da resposta. |
| Pedidos restantes neste minuto |
Quantos pedidos a chave ainda pode fazer antes de chegar ao limite. |
| Corpo |
O JSON da resposta: data e meta quando corre bem, error quando não. |
| Cabeçalhos |
Os cabeçalhos que a API deixa o navegador ler, entre eles o X-Correlation-ID. |
Os cabeçalhos que vale a pena ver
| 1 |
X-Correlation-ID: o identificador deste pedido. É o que indica ao suporte se algo correr mal.
|
|
| 2 |
X-API-Mode: diz sandbox ou production, conforme a chave.
|
|
| 3 |
X-API-Simulated: true: aparece nas escritas simuladas, para não haver dúvidas de que nada mudou na conta.
|
|
Quando dá erro
Num erro, o corpo traz um code estável, em inglês, e uma mensagem para pessoas, na língua do Accept-Language. Ao lado aparece a ligação «O que quer dizer este erro?», que leva à explicação do código. O seu programa deve decidir pelo code, nunca pela mensagem, que pode mudar.
Quando não há resposta
| Mensagem |
O que quer dizer |
| «Sem resposta da API» |
Falha de rede, a API não estar disponível nesse endereço, ou o navegador ter recusado o pedido. |
| «O pedido demorou demasiado e foi cancelado» |
A resposta não chegou a tempo. Tente de novo. |
O histórico da sessão
Os pedidos que enviar ficam no «Histórico desta sessão», sem a chave. Fica só em memória: desaparece ao recarregar ou mudar de página, e o botão Limpar apaga-o antes disso.
|
Vai pedir ajuda? Copie o X-Correlation-ID e a hora do pedido. Com isso encontramos o pedido sem precisar de mais nada, e nunca precisa de nos enviar a chave.
|
PRODUTO RECOMENDADO Hospedagem de sites com cPanel Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 321,75 MT/mês (plano de 3 anos, com cupão) Ver planos |
Português
English
