Différences

Ci-dessous, les différences entre deux révisions de la page.

--- si7:configuration:glpi_gestionapirest [2021/03/02 09:15]
techer.charles_educ-valadon-limoges.fr
+++ si7:configuration:glpi_gestionapirest [2021/03/04 22:19] (Version actuelle)
techer.charles_educ-valadon-limoges.fr [Créer la requêter pour obtenir la liste des entités accessibles à un utilisateur]
@@ Ligne 1: / Ligne 1: @@
-====== GLPI - Utiliser l'API REST de GLPI ======
+====== 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 :
@@ Ligne 6: / Ligne 6: @@
 ===== Utiliser Postman pour effectuer des appels d'API au simulateur d'API =====
-Installez Postman sur votre ordinateur :
+==== Installation de Postman sur votre ordinateur ====
   * le fichier d'installation Windows est dans le dossier Classe
   * site de téléchargement : https://www.postman.com/downloads/
@@ Ligne 27: / Ligne 28: @@
     * 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====
 <WRAP center round info >
 Saisissez l'URL de l'API dans un navigateur pour accéder à la documentation de l'API :
@@ Ligne 61: / Ligne 63: @@
   * le paramètre //is_recursive// (par défaut à false) est facultatif et sera à indiquer sous la forme d'un couple nom=valeur. Si vous indiquez ce paramètre il s'écrira **is_recursive=true**.
+==== Requête pour obtenir un jeton de session====
 Voici la documentation de l'API de GLPI à propos de la requête **Init session** :
 <WRAP center round info>
@@ Ligne 125: / Ligne 128: @@
     * la section **Body** permet de voir la réponse qui est **Pretty** et **JSON** : vous avez le jeton de session au format JSON.
-==== Créer la requêter pour obtenir la liste des entités accessibles à un utilisateur ====
+==== 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 :
-  * le jeton de session
+  * le jeton de session **Session-Token** ;
-  * le jeton d'application
+  * le jeton d'application **App-Token**.
 - 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 ;
-  - Entrez l'URL suivante de la demande dans le champ Request URL  : [[http://10.xxx.xxx.xxx/glpi/apirest.php/initSession]]
+  - Entrez l'URL suivante de la demande dans le champ **Request URL**  : [[http://10.xxx.xxx.xxx/glpi/apirest.php/getMyEntities/]]
-  - Cliquez sur l'onglet **Authorization** et choisissez dans la liste déroulante **API Key**
+  - Cliquez sur l'onglet **Headers** et saisissez les deux paramètres suivants  :
-  - Dans le champ **Key** saisissez **user_token** ;
+    - le paramètre **App-Token** avec la valeur communiquée par l'enseignant ;
-  - 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 ;
+    - le paramètre **Session-Token** avec la valeur que vous avez obtenue ave la requête **initSession** ;
-  - Dans le champ **Add to** sélectionnez dans la liste déroulante **Query Params**
 {{ :si7:configuration:postman_09.png |}}
+  - 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**  ;
 {{ :si7:configuration:postman_10.png |}}
+  - Lancer la requête en cliquant sur **Send** ;
+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 **JSON** : vous avez la lise des entités et des sous-entités avec leur identifiant.
 {{ :si7:configuration:postman_11.png |}}
+<WRAP center round todo>
+**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
+</WRAP>
 ==== Retour Activité A8 ====
   * [[glpi_gestionconfig_00|A8 - La gestion des configurations avec GLPI]]

Les cours du BTS SIO

Outils pour utilisateurs

Outils du site

Différences

Outils de la page