 |
This is a machine translation based on the English version of the article. It might or might not have already been subject to text preparation. If you find errors, please file a GitHub issue that states the paragraph that has to be improved. |
1. Introducción
Checkmk ofrece ahora toda una serie de interfaces diversas, sobre todo la API REST, con la que puedes hacer gran parte de lo que también es posible a través de la interfaz web. Sin embargo, también hay API para los complementos de comprobación, el inventario de hardware y software, Agent Bakery, etc. Hay artículos, referencias y otros recursos para todas estas interfaces, repartidos por toda esta Guía del usuario, el sitio web y el propio Checkmk.
En este artículo, te ofrecemos una visión general de todas las interfaces y recursos, y te damos algunos consejos sobre su manejo general. Muchos enlaces de este artículo son redundantes, ya que la información está pensada para responder a tres enfoques o preguntas diferentes:
¿Qué API ofrece Checkmk?
¿Qué artículos relacionados con las API se pueden encontrar en la Guía del usuario?
¿Qué recursos relacionados con las API hay disponibles en Checkmk?
La interfaz más importante es, sin duda, la API REST de Checkmk, que se puede utilizar para hacer casi todo lo que, desde el punto de vista de la programación, también se puede realizar a través de la interfaz web.
 |
La interfaz gráfica de usuario (GUI) interactiva de la API REST ofrece una introducción rápida y práctica a la API REST. Aquí puedes enviar y, opcionalmente, modificar consultas predefinidas. Puedes encontrar la GUI en el propio Checkmk a través de Help > Developer resources > REST API interactive GUI. |
La segunda interfaz principal son las API de plugins para desarrollar tus propias extensiones. Dependiendo de tu experiencia, puedes empezar aquí con nuestro artículo introductorio o con la referencia, que también puedes encontrar directamente en Checkmk: Help > Developer resource > Plug-in API references.
|
Incluso sin tener un sitio de Checkmk en funcionamiento, puedes ver una copia de la documentación de la API de plugins en docs.checkmk.com/plugin-api. |
En las tablas siguientes encontrarás estas API, pero también interfaces menos conocidas, como las del inventario de hardware y software, subinterfaces para el desarrollo de complementos de comprobación, como la API de gráficos explícita, así como cuasi-interfaces, como el formato de salida de las comprobaciones locales, el precursor sencillo y basado en scripts de los complementos completos.
2. Las API en Checkmk
| API | Guía del usuario | Web | Descripción |
|---|---|---|---|
API REST |
Funcionalmente, es un subconjunto de la interfaz web. |
||
API de Check |
Desarrollo de complementos de comprobación basados en agentes |
En Checkmk:Help > Developer resources > Plug-in API references > Agent based ("Check API")
, |
Programación de complementos de comprobación. |
API de inventario |
Desarrollo de complementos de inventario de hardware/software |
En Checkmk:Help > Developer resources > Plug-in API references > Agent based ("Check API") > Version 2
, |
Programación de complementos de comprobación. |
API de Bakery |
En Checkmk: Help > Developer resources > Plug-in API references > Bakery, |
Incluir complementos de comprobación en Agent Bakery. |
|
API de DCD |
En Checkmk: Help > Developer resources > Plug-in API references > Dynamic configuration connector, |
Conexiones personalizadas para la gestión dinámica de hosts con el Dynamic Configuration Daemon (DCD). |
|
API de gráficos |
Personalización de la visualización de métricas en el artículo sobre el complemento de comprobación basado en agente |
En Checkmk: Help > Developer resources > Plug-in API references > Graphing, |
Incluye métricas, gráficos y Perf-O-Meters. |
API de conjuntos de reglas |
Conjuntos de reglas para parámetros de comprobación en el artículo sobre el complemento de comprobación basado en agente |
En Checkmk: Help > Developer resources > Plug-in API references > Rulesets, |
Desarrolla tus propios conjuntos de reglas. |
API de llamadas del lado del servidor |
En Checkmk: Help > Developer resources > Plug-in API references > Server-side calls, |
Desarrolla comprobaciones activas y agentes especiales. |
|
API de HW/SW |
n.a. |
API web para consultar datos de inventario. |
|
Livestatus |
Recuperación de datos de estado a través de Livestatus, referencia de comandos de Livestatus |
n.a. |
Recuperación directa de datos de estado a través del lenguaje de consulta Livestatus (LQL). |
Interfaz de la consola de eventos |
La interfaz de estado de la Consola de eventos |
n.a. |
Acceso al estado interno y ejecución de comandos a través de un socket de Unix. |
Comprobaciones locales |
n.a. |
«Mini interfaz» para tus propias comprobaciones basadas en scripts. |
3. Artículos de la Guía del usuario
| Sección de API | Guía del usuario | Descripción |
|---|---|---|
Automatización |
Descripción de la API REST, así como su documentación y posibles usos. |
|
Una visión general de la interfaz de datos para información sobre hosts y servicios. |
||
Todas las tablas, encabezados, filtros y operadores. |
||
Descripción de la API web propia del inventario para acceso externo. |
||
La interfaz de estado de la Consola de eventos |
Se pueden leer datos desde la Consola de eventos y enviar comandos a través de un socket Unix y un subconjunto del protocolo Livestatus. |
|
Programación |
Artículo general con todas las posibilidades de extensiones y enlaces a más información. |
|
Desarrollo de complementos de comprobación basados en agentes |
Descripción detallada de cómo desarrollar un complemento de comprobación. |
|
Descripción detallada del desarrollo de un complemento de comprobación para datos SNMP. |
||
Desarrollo de complementos de inventario de hardware y software |
Descripción detallada de cómo desarrollar un complemento de inventario. |
4. Recursos en Checkmk
| En Checkmk | Descripción |
|---|---|
Help > Developer resources > Plug-in API references |
Una referencia basada en Sphinx de todas las API relevantes para el desarrollo de complementos de Check. |
Help > Developer resources > REST API documentation |
Referencia basada en ReDoc/OpenAPI para todas las consultas relevantes para Check, incluyendo ejemplos de código para Requests (Python), Urllib (Python), httpie y curl. |
Help > Developer resources > REST API interactive GUI |
Interfaz web interactiva para probar todos los puntos finales de la API, con comentarios directamente en la página. |
Help > Developer resources > Plug-in API references > Agent based ("Check API") |
En la sección «Version 2 > New in this version» encontrarás información importante para la migración de plugins antiguos a la versión actual de la API. |
5. Recursos en Internet
| Recurso | Descripción |
|---|---|
Tutorial en vídeo (en inglés) con ejemplos prácticos sobre cómo usar la API REST, por ejemplo, para configurar paradas programadas. |
|
Ejemplos de Curl en la Base de conocimientos de Checkmk para consultas concretas, por ejemplo, con operadores AND. |
|
En la tienda de complementos de Checkmk encontrarás muchas implementaciones prácticas de las API, incluido el código fuente. |