Primers passos
Errors
Quan alguna cosa falla, l'API respon amb l'estat HTTP corresponent i un cos amb code i message dins d'error.
Al vostre programa, utilitzeu code. message és un text en anglès pensat per ajudar qui depura i pot canviar.
Format de l'error404
{
"error": {
"code": "not_found",
"message": "Item not found or you do not have access to it."
}
}Sense clau401
{
"error": {
"code": "missing_api_key",
"message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
}
}Codis d'error
| Estat | Codi | Quan passa |
|---|---|---|
| 400 | key_in_query |
La clau s'ha enviat a l'URL (paràmetres api_key, apikey, key o token). Envieu-la a la capçalera i genereu una clau nova, perquè l'anterior pot haver quedat desada als registres del servidor. |
| 400 | invalid_parameter |
Un paràmetre té un valor no vàlid, com ara per_page per sobre del màxim. |
| 401 | missing_api_key |
La sol·licitud no incloïa cap clau. |
| 401 | invalid_api_key |
La clau no existeix, s'ha revocat o el seu usuari està desactivat. |
| 404 | not_found |
L'endpoint no existeix, o bé l'element no existeix o pertany a una organització que l'usuari no pot veure. |
| 404 | organization_not_found |
El valor d'organization indicat no correspon a cap organització en què l'usuari pugui veure aquest tipus d'element. |
| 405 | method_not_allowed |
L'API només accepta GET (i HEAD). |
| 429 | rate_limited |
S'ha assolit el límit de sol·licituds. Espereu els segons indicats a Retry-After. |
| 500 | server_error |
Error intern. Torneu-ho a provar d'aquí a una estona; si el problema continua, contacteu amb el servei d'assistència. |
Quan cal tornar-ho a provar
Només té sentit repetir la mateixa sol·licitud després d'un 429 (esperant el Retry-After) o d'un 500. La resta d'errors requereixen corregir la sol·licitud o la clau.