GLPI - Utiliser l'API REST de GLPI avec Postman
Présentation
vous allez utiliser différents outils pour découvrir l'utilisation de l'API de GLPI :
Postman : c'est un outil utile lorsqu'un site Web de développeur d'
API n'est pas disponible tout en offrant la possibilité d'enregistrer, d'organiser et de réutiliser facilement les
API.
Python
Utiliser Postman pour effectuer des appels d'API au simulateur d'API
Installation de Postman sur votre ordinateur
Après installation du logiciel il n'est pas nécessaire de se créer un compte.
Cliquez sur le lien Skip an go to the app :
1ère requête sans authentification
Dans la fenêtre principale à côté de l'onglet Overview, cliquez sur l'icône plus “+“ pour créer une requête sans titre. Par défaut, il s'agit d'une requête GET.
Cliquez sur la flèche vers le bas en regard de
GET pour afficher les différentes opérations d'
API, y compris GET, POST et DELETE. Laissez la sélection sur
GET. Cliquez sur la flèche vers le haut en regard de
GET pour fermer la liste.
-
Pour vérifier que la demande d'API a réussi regardez le code Status :
il indique 200 OK ;
la section
Body permet de voir la réponse qui est
Pretty et
HTML : vous avez le contenu d'une page
HTML qui est la documentation sur l'
API de GLPI ;
Accès à la documentation de l'API
Saisissez l'URL de l'API dans un navigateur pour accéder à la documentation de l'API :
Requête pour obtenir la liste des entités accessibles à un utilisateur
Pour utiliser une API, il est indispensable de s'appuyer sur la documentation de celle-ci.
En consultant l'API de GLPI vous pouvez visualiser qu'il y a une requêter GET appelé Get my entities qui donne les informations suivantes :
Documentation | Commentaires |
Get my entities | |
* URL : apirest.php/getMyEntities/
Il est nécessaire de renseigner des paramètres dans l'entête (Headers) :
Vous pouvez indiquer des paramètres dans l'URL (query string) :
Requête pour obtenir un jeton de session
Voici la documentation de l'API de GLPI à propos de la requête Init session :
Il est nécessaire de renseigner des paramètres dans l'entête (Headers) :
Obtenir un jeton d'application (App-Token)
Demandez à l'enseignant de vous communiquer cet App-Token pour l'API de GLPI.
Obtenir un jeton d'utilisateur (user_token)
Pour obtenir un jeton d'accès pour votre compte GLPI :
Créer la requête avec Postman
Dans la fenêtre principale, cliquez sur l'icône plus “+“ pour créer une requête sans titre.
Gardez le type de requête GET ;
-
Cliquez sur l'onglet
Authorization et choisissez dans la liste déroulante
API Key
Dans le champ Key saisissez user_token ;
Dans le champ
Value collez la valeur du jeton d'
API que vous avez généré pour votre compte et que vous avez copiée ;
Dans le champ Add to sélectionnez dans la liste déroulante Query Params
Cliquez sur l'onglet Headers pour saisir la clé d'application (App-Token) qui vous a été communiquée par l'enseignant ;
Dans le champ Key saisissez App-Token ;
Dans le champ Value collez la valeur de la clé d'application (App-Token) qui vous a été communiquée par l'enseignant ;
En cliquant sur le lien 6 Hidden vous pouvez visualiser tous les champs d'en-tête transmis dans la requête d'API en HTTP.
Lancer la requête
Cliquez sur Send ;
Pour vérifier que la demande d'API a réussi regardez le code Status :
Créer la requête pour obtenir la liste des entités accessibles à un utilisateur
Vous avez maintenant toutes les informations pour obtenir la liste des entités accessibles à un utilisateur :
- Dans la fenêtre principale, cliquez sur l'icône plus ”+“ pour créer une requête sans titre.
Gardez le type de requête GET ;
-
Cliquez sur l'onglet Headers et saisissez les deux paramètres suivants :
le paramètre App-Token avec la valeur communiquée par l'enseignant ;
le paramètre Session-Token avec la valeur que vous avez obtenue ave la requête initSession ;
Cliquez sur l'onglet Params et saisissez le paramètre facultatif suivant pour visualiser en plus des l'entités les sous entités :
le paramètre is_recursive avec la valeur true ;
Lancer la requête en cliquant sur Send ;
Pour vérifier que la demande d'API a réussi regardez le code Status :
Travail à faire :
En vous aidant de la documentation de l'API de GLPI, créez avec Postman une requête pour afficher les informations sur votre ordinateur renseignées dans GLPI.
Vous aurez besoin :
de consulter la documentation sur la requête Get an item ;
du type d'élément (itemtype) : Computer
de l'identifiant de votre ordinateur (id) : pour obtenir cet ID depuis GLPI, sélectionner votre ordinateur et vous devriez visualiser dans l'url son id.
L'URL de la requête Get an item est de la forme : apirest.php/:itemtype/:id.
Cela signifie que l'URL de votre requête pour l'ordinateur dont l'ID est 24 doit être : apirest.php/Computer/24
Information : Les types d'équipement sont les suivants : Computer, NetworkEquipment, Peripheral, Phone, Printer
Retour Activité A8