Monitorear una API con pasos y variables
Arma un monitoreo compuesto de una API con autenticación de la bóveda, varios pasos que se pasan variables, validaciones JSON y métricas propias.
En esta página
Un monitoreo de API corre una o varias peticiones en orden, como lo haría tu sistema: inicia sesión, captura un dato de la respuesta, lo usa en la siguiente petición y valida cada resultado. Puede graficar valores numéricos de las respuestas y alertar con umbrales.
Antes de empezar
Necesitas permiso para operar en Aplicaciones.
Los tokens, claves y certificados se guardan en la bóveda. Un administrador los crea en Configuración → Monitoreo → Credenciales.
Paso 1: datos generales
Entra a Aplicaciones → WebServices y presiona Agregar WebService (o Editar en uno existente).
Escribe el Nombre y, si quieres, elige el Grupo (opcional).
El formulario tiene las pestañas Petición, Autenticación, Validaciones, Pasos, Métricas y Dónde corre. Cuando hay más de un paso, en Petición y Validaciones eliges arriba a qué paso corresponde lo que editas.
Paso 2: la petición
En Petición:
Elige el Método y escribe la URL.
Agrega Parámetros y Headers con Agregar parámetro y Agregar header.
Para métodos con cuerpo, elige el Tipo de Cuerpo: Sin cuerpo, JSON, Formulario o Texto. Si el JSON no es válido, el formulario te avisa.
En Opciones, ajusta el Tiempo límite (s) (1 a 60), Seguir redirecciones y Verificar el certificado TLS.
Revisa la Vista previa de la petición.
No pongas tokens ni claves en los headers ni en los parámetros: usa la pestaña Autenticación. Un método que cambia datos (POST, PUT, PATCH, DELETE) se ejecuta en cada revisión; al guardar se pide confirmación.
Paso 3: la autenticación (login, token u OAuth2)
En Autenticación:
En Credencial, elige una de la bóveda. Pueden ser:
Token de API (en un header o un parámetro, con prefijo).
Usuario y clave (Basic).
OAuth2.
Token obtenido desde otra API (un login previo).
Opcional: elige un Certificado de cliente (mTLS).
Si hay varios pasos, marca en Pasos que usan la autenticación cuáles la llevan.
Los secretos nunca se muestran ni quedan en los resultados.
Paso 4: los pasos y las variables
En Pasos:
Presiona Agregar paso (hasta 10). Ponle un nombre a cada uno.
Con los botones de cada paso puedes editar su petición, subirlo, bajarlo, duplicarlo o quitarlo.
En Variables que captura, presiona Capturar variable y define:
El nombre de la variable, por ejemplo
tokenopedido.De dónde sale: Ruta JSON (por ejemplo
$.data.id), Header (por ejemploLocation) o Expresión regular.Secreta, si no debe mostrarse ni guardarse.
Usa la variable en los pasos siguientes escribiendo su nombre entre dobles llaves, por ejemplo
{{pedido}}, en la URL, los headers, los parámetros o el cuerpo.
Si un paso usa una variable que ningún paso anterior captura, el formulario te avisa.
Paso 5: las validaciones
En Validaciones, elige el tipo y presiona Agregar validación:
Tipo | Qué compara |
|---|---|
Código HTTP | Los códigos esperados, como |
Tiempo de respuesta | Aviso y crítico en milisegundos. |
Header | Que un header existe, no existe, es igual a o contiene un valor. |
Cuerpo (texto o expresión) | Que el cuerpo contiene, no contiene, calza con la expresión o no calza con la expresión. |
Valor JSON por ruta | Que el valor en una ruta (por ejemplo |
Cada validación es Crítica o de Aviso. Una crítica deja el servicio caído y detiene los pasos siguientes; una de aviso lo deja en advertencia. Todas deben cumplirse.
Paso 6: las métricas
En Métricas, grafica valores numéricos capturados en los pasos:
Presiona Agregar métrica (hasta 10).
Elige la variable (no secreta), escribe el nombre (por ejemplo Pedidos pendientes) y la unidad.
Elige Alerta si sube de o Alerta si baja de y escribe el aviso y el crítico.
La latencia de cada paso se grafica siempre.
Paso 7: dónde corre, probar y guardar
En Dónde corre, elige Revisar desde. Ver Elegir desde dónde se revisa.
Presiona Probar ahora. Debajo aparece Resultado de «Probar ahora» con el estado, la latencia y el detalle de cada paso.
Presiona Guardar. Si falta algo, el formulario lo lista antes de guardar.