Respostas
A API normalmente retorna JSON no corpo da resposta. Alguns endpoints não retornam JSON, mas o código de status HTTP.
Códigos de status de resposta
A API usa os seguintes códigos de status de resposta, conforme definido na RFC 2616 e na RFC 6585:
| Código | Status | Descrição |
|---|---|---|
| 200 | OK | A requisição foi bem-sucedida. O cliente pode ler o resultado da requisição no corpo e nos cabeçalhos da resposta. |
| 201 | Created | A requisição foi concluída e resultou na criação de um novo recurso. |
| 202 | Accepted | A requisição foi aceita para processamento, mas o processamento ainda não foi concluído. |
| 204 | No content | A requisição foi bem-sucedida, mas não retorna nenhum conteúdo no corpo da mensagem. |
| 304 | Not modified | Não modificado. Consulte requisições condicionais. |
| 400 | Bad request | A requisição não pôde ser entendida pelo servidor devido à sintaxe incorreta. O corpo da mensagem conterá mais informações; consulte o esquema de resposta. |
| 401 | Unauthorized | A requisição requer autenticação ou, se incluiu credenciais, a autorização foi recusada para essas credenciais. |
| 403 | Forbidden | O servidor entendeu a requisição, mas está se recusando a atendê-la. |
| 404 | Not found | O recurso solicitado não foi encontrado. Esse erro pode ser devido a uma condição temporária ou permanente. |
| 429 | Too many requests | Foi aplicado um limite de requisições. |
| 500 | Internal server error | Você nunca deveria receber este erro porque nossos codificadores experientes capturam todos... mas, se for azarado o suficiente para receber um, por favor, informe-nos através de um comentário na parte inferior desta página. |
| 502 | Bad gateway | O servidor estava atuando como um gateway ou proxy e recebeu uma resposta inválida do servidor upstream. |
| 503 | Service unavailable | O servidor está temporariamente indisponível para lidar com a requisição devido a uma condição temporária, que será resolvida após algum tempo. Você pode tentar enviar a requisição novamente. |