Erros
Toda resposta de erro tem o mesmo corpo:
{
"error": "Parâmetro desconhecido: stauts.",
"code": "invalid_parameter"
}codeé estável. Compare por ele no seu código.erroré uma frase em português para quem lê o log. Ela pode melhorar com o tempo.- No
429, o corpo traz tambémretryAfter, em segundos.
Toda resposta, de sucesso ou de erro, leva o cabeçalho X-Request-Id. Ao falar com o suporte sobre uma falha, informe esse valor.
Códigos
| Status | code | Quando |
|---|---|---|
| 400 | invalid_json | O corpo da requisição não é um JSON válido. |
| 400 | invalid_parameter | Parâmetro inválido. |
| 401 | unauthenticated | Não autenticado. |
| 401 | invalid_credential | Credencial inválida. |
| 403 | insufficient_scope | Escopo insuficiente. |
| 404 | not_found | Recurso não encontrado. |
| 409 | conflict | O estado atual do recurso não permite esta operação. |
| 429 | rate_limited | Limite de requisições atingido. Tente de novo depois do tempo indicado em Retry-After. |
| 500 | internal_error | Erro interno. Tente de novo; se persistir, fale com o suporte informando o X-Request-Id. |
Parâmetros
Parâmetro que a operação não conhece é recusado com 400, para um erro de digitação como stauts=open não devolver a lista inteira sem aviso. Valor fora da faixa também é 400, e a frase diz qual parâmetro.
Identificador que não existe na sua organização é 404, mesmo quando o recurso existe em outra.