Monitorización de API

Los monitores de API te permiten verificar automáticamente que tus endpoints son accesibles, funcionan con eficiencia y devuelven los datos correctos. Así te aseguras de que tus aplicaciones e integraciones funcionan como esperas.

Igual que con otros monitores, si un monitor de API detecta un problema puedes trabajar con tu equipo para resolver la incidencia y, si quieres, actualizar tu página de estado.

Funciones principales

• Prueba tus endpoints de API desde varias ubicaciones del mundo cada 30 segundos.
• Valida códigos de estado HTTP, cuerpo JSON, cabeceras y tiempos de respuesta.
• Incluye cabeceras personalizadas, parámetros de consulta o cargas JSON.
• Recibe avisos inmediatos si un endpoint está caído, lento o devuelve resultados inesperados.
• Integra Slack, correo, SMS, llamadas telefónicas, webhooks y más.

Añadir tu primer monitor de API

Para crear un monitor, ve a tu proyecto → Monitores → Añadir monitor.

Tipo de monitor

Elige API como tipo de monitor.

Introduce la URL del endpoint que quieres monitorizar; por ejemplo,
https://api.tuservicio.com/v1/users.

Configuración de la petición

Puedes adaptar por completo tu petición de API:

• Método HTTP: GET, POST, PUT, PATCH, DELETE, OPTIONS o HEAD
• Cuerpo: envía JSON, datos de formulario, GraphQL o texto plano con tu petición
• Autenticación: añade autenticación básica, clave de API o autorización con token Bearer
• Parámetros de consulta: añade pares clave/valor a la URL de la petición
• Cabeceras: añade las cabeceras personalizadas que necesite tu petición

El monitor se considera correcto si

Un monitor de API tiene éxito cuando se cumplen todas las comprobaciones indicadas.
Puedes definir una o varias de estas comprobaciones:

• Código de estado: por ejemplo, que la respuesta sea 200 OK
• Tiempo de respuesta: por ejemplo, menos de 1 segundo
• El cuerpo contiene: por ejemplo, "success": true
• Ruta JSON: por ejemplo, que data.status sea igual a "active"
• La cabecera contiene: por ejemplo, Content-Type: application/json

Si alguna de estas condiciones no se cumple, el monitor se marcará como caído y se enviarán las alertas según tus ajustes de alertas.

Ajustes avanzados

• Nombre descriptivo: asigna a tu monitor un nombre claro para identificarlo fácilmente.
• Ejecutar comprobaciones cada: decide con qué frecuencia se prueba el endpoint.
• Ejecutar desde: elige las ubicaciones de prueba (Estados Unidos, Canadá, Europa, Asia).
• Añadir a la página de estado: muestra públicamente la disponibilidad y las estadísticas de respuesta de tu API.
• Cuando un monitor falla: abre una incidencia, notifica a los suscriptores o publica en tu página de estado.
• Cuando un monitor se recupera: resuelve las incidencias y actualiza tu página de estado automáticamente.