L’API consiste en un fichier .php auquel nous pouvons faire des appels depuis un navigateur ou en ligne de commande avec des outils tels que “curl”, natif des systèmes GNU/Linux.
Le système de sécurité de l’API est triple : basé sur les adresses IP autorisées, basé sur le mot de passe de l’API, et basé sur les informations d’identification de l’utilisateur.
Pour pouvoir utiliser cet utilitaire, nous devons préalablement configurer ses options de sécurité depuis la console de Pandora FMS.
Pour ce faire, allez dans Configuration -> Général, et cherchez les champs “Liste des IP avec accès API” et “Mot de passe API“.
Dans le premier champ, nous ajoutons les adresses IP à partir desquelles nous voulons avoir accès à l’API, soit une adresse IP pour chaque ligne, et nous pouvons également utiliser le joker * pour donner accès à partir de n’importe quelle adresse IP (non recommandé).
Dans le deuxième champ, nous introduisons le mot de passe que nous voulons, il est important de savoir que plus tard ce mot de passe sera passé en paramètre lors de l’appel HTTP à l’API, avec le mot de passe de l’utilisateur qui est utilisé pour faire l’appel, il est donc recommandé de sécuriser les communications en utilisant https pour crypter le canal.
Une fois que ces deux paramètres sont correctement configurés, nous pouvons utiliser toutes les fonctions dont dispose l’API. À titre d’exemple, nous pouvons effectuer l’appel suivant à partir d’un navigateur exécuté dans une machine dont l’adresse IP a été autorisée dans le paramètre “Liste des IP avec accès API”.
http://console_IP/pandora_console/include/api.php?info=version
Comme nous le voyons, l’appel est composé du chemin d’accès au fichier api.php, suivi de ? pour l’étape du paramètre, puis nous séparerons chaque paramètre par &. Chaque paramètre est défini par le paramètre nom=valeur. Voyons un exemple de renvoi d’informations des groupes de modules :
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
Les possibilités offertes par l’API sont nombreuses, et l’appel peut devenir assez compliqué selon l’opération que nous allons effectuer et le nombre de paramètres que nous devons lui passer, donc nous devons être prudents et tester petit à petit jusqu’à ce que nous gagnions en facilité avec l’utilisation de ce puissant utilitaire.
Vous trouverez dans le lien suivant de la documentation de plus amples informations sur son utilisation:
https://pandorafms.com/manual/fr/documentation/08_technical_reference/02_annex_externalapi