La API consiste en un fichero PHP al que podemos hacer llamadas desde un navegador o bien por línea de comando con herramientas como curl, nativas en sistemas GNU/Linux.
El sistema de seguridad con el que cuenta la API es triple: basado en direcciones IP permitidas, basado en contraseña de API, y basado en credenciales de usuario.
Para poder hacer uso de esta utilidad debemos previamente configurar sus opciones de seguridad desde la consola de Pandora FMS.
Para ello, nos vamos a Setup -> Setup -> General Setup, y buscaremos los campos “IP list with API access” y “API password”.
En el primer campo añadimos las direcciones IP desde las que queramos que se tenga acceso a la API, siendo una dirección IP por cada línea. También podemos utilizar el comodín * para dar acceso desde cualquier dirección IP (desaconsejado).
En el segundo campo introducimos la contraseña que queramos, es importante saber que después esta contraseña se pasará como parámetro al hacer la llamada HTTP a la API, junto con la contraseña del usuario que se utilice para hacer la llamada, por lo que es recomendable que las comunicaciones sean seguras mediante el uso de https para cifrar el canal.
Una vez configurados correctamente estos dos parámetros podremos hacer uso de todas las funciones de que dispone la API. Como ejemplo podemos hacer la siguiente llamada desde un navegador ejecutado en una máquina cuya dirección IP haya sido autorizada en el parámetro “IP list with API access”:
http://console_IP/pandora_console/include/api.php?info=version
Como vemos la llamada se compone de la ruta al fichero api.php, seguida de ? para el paso de parámetros, después separaremos cada parámetro con &. Cada parámetro se define mediante nombreparametro=valor.
Veamos un ejemplo para devolver información de los grupos de módulos:
http://192.168.70.208/pandora_console/include/api.php?op=get&op2=module_groups&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
Las posibilidades que ofrece la API son muchas, y la llamada puede complicarse bastante en función de la operación que vayamos a realizar y el número de parámetros que necesitemos pasarle, por lo que hay que ser cuidadoso y realizar pruebas poco a poco hasta ganar soltura con el uso de ésta potente utilidad.
En el siguiente enlace de la documentación encontrará más información sobre su uso:
https://pandorafms.com/manual/es/documentation/08_technical_reference/02_annex_externalapi