Errors

Se puede saber si la solicitud fue exitosa verificando el status al recibir una respuesta de la API. Si una respuesta no es exitosa, la API devolverá un código 400 o 500 y un mensaje de error.

Status codes

Aquí algunos de los códigos de estado que pueden recibir al hacer una solicitud a la API.

Name
2xx
Description
Un status 2xx indica que la solicitud fue exitosa.
Name
4xx
Description
Un status 4xx indica que la solicitud fue incorrecta o no se pudo procesar.
Name
5xx
Description
Un status 5xx indica que la API no pudo procesar la solicitud debido a un error en el servidor.

Mensajes de error

Cuando la API no puede procesar una solicitud, devolverá un mensaje de error. Este mensaje de error contiene información sobre lo que salió mal y cómo solucionarlo.

Aquí una lista de los mensajes de error que pueden recibir al hacer una solicitud a la API.

Name
invalid_request
Description
Significa que la solicitud no se pudo procesar porque la solicitud era incorrecta.
Name
rate_limit
Description
Por el momento el límite aplica a todos los usuarios por igual. Si se excede el límite, la API devolverá un error 429. Por el momento se pueden hacer 100 requests cada 10 segundos.
En desarrollo Estaremos trabajando en un sistema de autenticación para que los usuarios puedan hacer más requests por segundo.

Respuesta de error

{
  "type": "invalid_request",
  "message": "Se debe incluir provincia y cantón: /distritos/1/01 o /distritos/101",
  "documentation_url": "https://territorios.fetchcr.com/docs/distritos"
}