Códigos de Error

Esta página enumera los posibles códigos de error devueltos por la API de Tráfico No Deseado, junto con sus significados y ejemplos de respuestas. Todas las respuestas de error están en formato JSON con un status de "error" y un message que describe el problema.

Resumen de Códigos de Error

La API utiliza códigos de estado HTTP estándar para indicar errores. La tabla a continuación resume los posibles códigos de error:

Código de Estado HTTP	Significado	Descripción
400	Solicitud Incorrecta	La solicitud está mal formada o contiene parámetros no válidos.
401	No Autorizado	Falta la clave API o es inválida.
403	Prohibido	La clave API no tiene permiso para acceder al recurso solicitado.
404	No Encontrado	El recurso solicitado (por ejemplo, sesión, intento o registro de malware) no existe.
429	Demasiadas Solicitudes	Se ha excedido el límite de tasa (100 solicitudes/minuto para la mayoría de los puntos finales, 50 solicitudes/minuto para /sessions, /attempts, /malware).
500	Error Interno del Servidor	Ocurrió un error inesperado en el servidor.

Ejemplos de Respuestas de Error

A continuación se presentan ejemplos de respuestas de error para cada código de error.

400 Solicitud Incorrecta

Devuelto cuando la solicitud contiene parámetros no válidos, como un filtro con formato incorrecto o campos requeridos faltantes.

Ejemplo de Respuesta:

{
  "status": "error",
  "message": "Invalid filter format: JSON parsing error"
}

401 No Autorizado

Devuelto cuando falta el encabezado X-API-Key o la clave API proporcionada es inválida.

Ejemplo de Respuesta:

{
  "status": "error",
  "message": "Invalid or missing API key"
}

403 Prohibido

Devuelto cuando la clave API no tiene permiso para acceder al punto final o recurso solicitado.

Ejemplo de Respuesta:

{
  "status": "error",
  "message": "Access forbidden: Insufficient permissions"
}

404 No Encontrado

Devuelto cuando el recurso solicitado (por ejemplo, una sesión específica, intento o registro de malware) no existe.

Ejemplo de Respuesta:

{
  "status": "error",
  "message": "Session not found"
}

429 Demasiadas Solicitudes

Devuelto cuando se excede el límite de tasa. La respuesta puede incluir un encabezado Retry-After que indica cuándo reintentar.

Ejemplo de Respuesta:

{
  "status": "error",
  "message": "Rate limit exceeded. Please try again later."
}

500 Error Interno del Servidor

Devuelto cuando ocurre un error inesperado en el servidor. Contacta al administrador de la API si esto persiste.

Ejemplo de Respuesta:

{
  "status": "error",
  "message": "Internal server error. Please try again later."
}

Manejo de Errores

Para manejar errores de manera efectiva:

• Verifica el campo status en la respuesta. Si es "error", inspecciona el message para más detalles.
• Para errores 429, implementa un retroceso exponencial o respeta el encabezado Retry-After.
• Asegúrate de que el encabezado X-API-Key esté incluido y sea válido para evitar errores 401.
• Valida los parámetros de consulta y los formatos de filtro para prevenir errores 400.
• Para errores 500 persistentes, contacta con el administrador de la API.