Saltar al contenido principal

Cómo monitorear una API REST

Un monitor HTTP básico solo verifica que el servidor responde. Para una API REST necesitas validar también que la respuesta tiene el formato correcto, los datos esperados y una latencia aceptable. Esta guía explica cómo hacerlo en StatusInspector.

1. Crear el monitor​

  1. En el panel, ve a Monitores → Nuevo monitor.
  2. Elige el tipo HTTP / Web.
  3. Selecciona el perfil API (avanzado) para ver todas las opciones.

2. Configurar la petición​

CampoQué configurar
URLEl endpoint completo de tu API (ej. https://api.ejemplo.com/v1/health)
MétodoGET para endpoints de consulta; POST si necesitas enviar un cuerpo
Intervalo60 s en Pro/Enterprise; 300 s en Free
TimeoutAjusta según el SLO de latencia de tu API; valor típico: 5000–10 000 ms

Autenticación​

Selecciona el tipo de autenticación de tu API:

TipoCuándo usarlo
Bearer tokenAPIs con JWT o tokens OAuth
BasicAutenticación HTTP básica (user:password)
API key (header)Clave en un header personalizado (ej. X-API-Key)

Los secretos se cifran y no se exponen en el panel al editar.

Body y headers personalizados​

Para endpoints POST/PUT/PATCH, añade el body JSON y el header Content-Type: application/json.

3. Configurar assertions JSON​

Las assertions validan el contenido de la respuesta, no solo el código HTTP.

Ejemplo — verificar que el health check responde "ok":

[
  { "type": "http_code", "value": 200 },
  { "type": "json_equals", "path": "status", "value": "ok" },
  { "type": "json_exists", "path": "data.id" },
  { "type": "latency_lt", "value": 2000 }
]

Reglas clave:

  • Las assertions se evalúan en orden; la primera que falle detiene la evaluación (fail-fast).
  • Un fallo de assertion produce estado DOWN del monitor.
  • Ver la guía completa de assertions JSON para todos los operadores.

4. Configurar alertas​

  1. Ve a la pestaña Alertas del monitor.
  2. Añade una regla: canal + evento DOWN (caída).
  3. Añade opcionalmente una regla para Recuperación (la API vuelve a responder).
  4. Si quieres alertar por latencia alta sin que haya caída, configura el campo Latencia máxima y activa la notificación para DEGRADED.

5. Buenas prácticas​

  • Usa un endpoint de health dedicado en tu API (/health, /status, /ping) que verifique dependencias internas (base de datos, caché) sin lado efectos.
  • No pongas secretos de producción directamente; usa la configuración de autenticación del monitor que los cifra.
  • Empieza con pocas assertions claras (código + campo de estado) y añade más según necesidad. Demasiadas assertions frágiles generan ruido.
  • Ajusta el timeout según el comportamiento real de tu API; un timeout muy bajo genera falsos positivos.
  • Valida el monitor manualmente con el botón Ejecutar ahora antes de activarlo en producción.

6. Monitorear flujos multi-paso (autenticación + llamada protegida)​

Si tu API requiere obtener primero un token y usarlo en la siguiente petición, usa Synthetic multi-step:

  1. Paso 1: POST /auth/token → extrae token del body.
  2. Paso 2: GET /api/resource con header Authorization: Bearer {{token}}.

Ver Synthetic multi-step para el flujo completo.

Referencias​