Primeiros passos

Erros

Quando algo dá errado, a API responde com o status HTTP correspondente e um corpo com code e message dentro de error.

Use o code no seu programa. A message é um texto em inglês para ajudar quem está depurando e pode mudar.

Formato do erro404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

Sem chave401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

Códigos de erro

Status	Código	Quando acontece
400	`key_in_query`	A chave foi enviada no endereço (parâmetros `api_key`, `apikey`, `key` ou `token`). Envie no cabeçalho e gere uma chave nova, porque a anterior pode ter ficado gravada em logs.
400	`invalid_parameter`	Um parâmetro tem valor inválido, como `per_page` acima do máximo.
401	`missing_api_key`	A requisição não trouxe chave.
401	`invalid_api_key`	A chave não existe, foi revogada ou o usuário dela está desativado.
404	`not_found`	O endpoint não existe, ou o item não existe ou é de uma empresa que o usuário não pode ver.
404	`organization_not_found`	O `organization` informado não é de uma empresa em que o usuário pode ver esse tipo de item.
405	`method_not_allowed`	A API só aceita `GET` (e `HEAD`).
429	`rate_limited`	O limite de requisições foi atingido. Espere os segundos de `Retry-After`.
500	`server_error`	Erro interno. Tente de novo em instantes; se continuar, fale com o suporte.

Quando tentar de novo

Só vale repetir a mesma requisição depois de um 429 (esperando o Retry-After) ou de um 500. Os outros erros pedem uma correção na requisição ou na chave.