Primeiros passos

Erros

Quando algo corre mal, a API responde com o código de estado HTTP correspondente e um corpo com code e message dentro de error.

Utilize o code no seu programa. A message é um texto em inglês para ajudar quem está a depurar 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

Estado	Código	Quando acontece
400	`key_in_query`	A chave foi enviada no endereço (parâmetros `api_key`, `apikey`, `key` ou `token`). Envie-a no cabeçalho e gere uma chave nova, porque a anterior pode ter ficado guardada em logs.
400	`invalid_parameter`	Um parâmetro tem um valor inválido, como `per_page` acima do máximo.
401	`missing_api_key`	O pedido não incluiu nenhuma chave.
401	`invalid_api_key`	A chave não existe, foi revogada ou o respetivo utilizador está desativado.
404	`not_found`	O endpoint não existe, ou o item não existe ou pertence a uma empresa que o utilizador não pode ver.
404	`organization_not_found`	O `organization` indicado não corresponde a uma empresa em que o utilizador possa ver este tipo de item.
405	`method_not_allowed`	A API só aceita `GET` (e `HEAD`).
429	`rate_limited`	O limite de pedidos foi atingido. Aguarde os segundos indicados em `Retry-After`.
500	`server_error`	Erro interno. Tente novamente dentro de instantes; se o problema persistir, contacte o suporte.

Quando tentar novamente

Só vale a pena repetir o mesmo pedido depois de um 429 (após aguardar o Retry-After) ou de um 500. Os outros erros exigem uma correção no pedido ou na chave.