Introducción a la API

Aprende a integrar la API de MonitorNOC con tus herramientas internas, despliegues automáticos o CI/CD.

MonitorNOC cuenta con una API REST completa en formato JSON para que desarrolladores, equipos de DevOps y MSPs automaticen el aprovisionamiento de monitores, extraigan reportes de SLA o sincronicen incidentes con portales corporativos.

1. URL Base

Todas las peticiones a la API deben dirigirse a la siguiente dirección:

https://api.monitornoc.com/api/v1

2. Autenticación

La API utiliza tokens de portador (Bearer Tokens) para autenticar las solicitudes. Los administradores pueden generar claves de API desde la sección Ajustes de Organización → Claves de API del panel de control.

Debes incluir tu token en la cabecera Authorization de cada llamada:

Authorization: Bearer mn_live_abc123XYZ...

Si el token es inválido o ha expirado, la API responderá con un estado 401 Unauthorized en formato JSON.

3. Códigos de Respuesta Estándar

  • 200 OK: Petición exitosa. Devuelve el recurso solicitado.
  • 201 Created: Recurso creado exitosamente (ej: tras añadir un monitor).
  • 400 Bad Request: Error en los datos del body (ej: falta el campo host o el formato de correo es incorrecto).
  • 401 Unauthorized: Token de API faltante o inválido.
  • 403 Forbidden: El token no cuenta con permisos suficientes (RBAC).
  • 404 Not Found: El recurso solicitado (target, incidente, status page) no existe.
  • 429 Too Many Requests: Límite de peticiones excedido (Rate limiting).