Primeiros pasos
Erros
Cando algo falla, a API responde co estado HTTP correspondente e un corpo con code e message dentro de error.
No seu programa, use code. message é un texto en inglés pensado para axudar a quen depura e pode cambiar.
Formato do erro404
{
"error": {
"code": "not_found",
"message": "Item not found or you do not have access to it."
}
}Sen 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 | Cando ocorre |
|---|---|---|
| 400 | key_in_query |
A chave enviouse no enderezo (parámetros api_key, apikey, key ou token). Envíea na cabeceira e xere unha chave nova, porque a anterior puido quedar gardada nos rexistros do servidor. |
| 400 | invalid_parameter |
Un parámetro ten un valor non válido, como per_page por riba do máximo. |
| 401 | missing_api_key |
A solicitude non incluía ningunha chave. |
| 401 | invalid_api_key |
A chave non existe, foi revogada ou o seu usuario está desactivado. |
| 404 | not_found |
O endpoint non existe, ou ben o elemento non existe ou pertence a unha organización que o usuario non pode ver. |
| 404 | organization_not_found |
O organization indicado non corresponde a unha organización na que o usuario poida ver este tipo de elemento. |
| 405 | method_not_allowed |
A API só acepta GET (e HEAD). |
| 429 | rate_limited |
Alcanzouse o límite de solicitudes. Agarde os segundos indicados en Retry-After. |
| 500 | server_error |
Erro interno. Ténteo de novo nuns intres; se o problema continúa, contacte coa asistencia técnica. |
Cando tentalo de novo
Só ten sentido repetir a mesma solicitude despois dun 429 (agardando o Retry-After) ou dun 500. Os demais erros requiren unha corrección na solicitude ou na chave.