Saltar al contenido principal

Referencia de la API

Códigos de error

Códigos de error

Los endpoints de la API de MenuGaze devuelven códigos de estado HTTP estándar. Las respuestas de error incluyen un cuerpo JSON con detalles sobre lo que salió mal.

Formato de las respuestas de error

{
  "success": false,
  "error": "Human-readable error message"
}

Códigos de estado

Código Significado Causas comunes
200 OK La solicitud se completó correctamente. El cuerpo de la respuesta contiene los datos solicitados.
201 Created El recurso se creó correctamente. Lo devuelven los endpoints POST cuando tienen éxito.
400 Bad Request Faltan campos o hay campos no válidos en el cuerpo de la solicitud. Verifique que todos los campos obligatorios estén presentes y tengan el formato correcto.
401 Unauthorized Falta el token de autenticación o no es válido. Asegúrese de incluir un token Bearer válido en el encabezado Authorization. Es posible que el token haya vencido: inicie sesión de nuevo para obtener un token nuevo.
403 Forbidden Está autenticado, pero no tiene permiso para acceder a este recurso. Esto suele significar que está intentando acceder a un recurso de otro restaurante o modificarlo.
404 Not Found El recurso solicitado no existe. Verifique que el ID en la ruta de la URL sea correcto.
429 Too Many Requests Se superó el límite de solicitudes. Consulte el encabezado Retry-After para saber cuántos segundos debe esperar antes de reintentar. Los endpoints de autenticación están limitados a 10 solicitudes cada 15 minutos por IP. La creación de pedidos está limitada a 5 solicitudes por minuto por IP.
500 Internal Server Error Ocurrió un error inesperado en el servidor. Si el problema persiste, comuníquese con soporte. Estos errores se registran automáticamente para su investigación.
503 Service Unavailable El servicio no está disponible temporalmente. Esto puede ocurrir durante el mantenimiento o cuando un servicio externo necesario (p. ej., el secreto del worker) no está configurado. Vuelva a intentarlo después de unos momentos.

Límite de solicitudes

Los endpoints con límite de solicitudes devuelven el estado 429 cuando se supera el límite. La respuesta incluye:

  • Encabezado Retry-After: la cantidad de segundos que debe esperar antes de hacer otra solicitud.
  • Un mensaje de error que indica el límite de solicitudes que se superó.

Los límites de solicitudes se aplican por dirección IP. Límites actuales:

Endpoint Límite
Inicio de sesión y registro 10 solicitudes cada 15 minutos por IP
Creación de pedidos 5 solicitudes por minuto por IP
Artículos relacionados 30 solicitudes por minuto por IP