Primeros pasos

Errores

Cuando algo sale mal, la API responde con el estado HTTP correspondiente y un cuerpo con code y message dentro de error.

En su programa, use code. message es un texto en inglés pensado para ayudar a quien está depurando y puede cambiar.

Formato del error404

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

Sin clave401

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

Códigos de error

Estado	Código	Cuándo ocurre
400	`key_in_query`	La clave se envió en la URL (parámetros `api_key`, `apikey`, `key` o `token`). Envíela en el encabezado y genere una clave nueva, ya que la anterior pudo haber quedado registrada en los logs.
400	`invalid_parameter`	Un parámetro tiene un valor no válido, como `per_page` por encima del máximo.
401	`missing_api_key`	La solicitud no incluyó ninguna clave.
401	`invalid_api_key`	La clave no existe, fue revocada o su usuario está desactivado.
404	`not_found`	El endpoint no existe, o bien el elemento no existe o pertenece a una organización que el usuario no puede ver.
404	`organization_not_found`	El `organization` indicado no corresponde a una organización en la que el usuario pueda ver este tipo de elemento.
405	`method_not_allowed`	La API solo acepta `GET` (y `HEAD`).
429	`rate_limited`	Se alcanzó el límite de solicitudes. Espere los segundos indicados en `Retry-After`.
500	`server_error`	Error interno. Vuelva a intentarlo en unos momentos; si el problema continúa, comuníquese con soporte.

Cuándo volver a intentarlo

Solo tiene sentido repetir la misma solicitud después de un 429 (esperando el Retry-After) o de un 500. Los demás errores requieren una corrección en la solicitud o en la clave.