8.6.7. Utilisation d'un endpoint API

8.6.7.1. Introduction

Cette procédure indique comment :

exécuter un endpoint localement
récupérer la réponse
avoir le .json correspondant
connaître le modèle de la réponse et d'avoir un exemple de celle-ci

En cliquant sur le bouton `Try it out`, il est possible de tester la requête sélectionnée et l’outil génère la requête à utiliser avec curl.
La Procédure d'exécution d'un endpoint indique comment utiliser l'interface graphique swagger pour sélectionner un API, exécuter la requête, récupérer la réponse et le curl de la requête.
Toutefois cette requête hérite des droits (et donc du token) du créateur de la requête.
Pour effectuer une requête avec des droits différents, se référer à la Procédure pour modifier le token associé à la requête.

8.6.7.2. Liens associés

Voir la présentation de l'API

Voir la Présentation de l'interface API

8.6.7.3. Prérequis

Utilisateur : membre du groupe Administrator

8.6.7.4. Opérations préliminaires

Connexion à GCenter via un navigateur (voir Connexion à l'interface web via un navigateur internet)

8.6.7.5. Procédure d’accès à l'API

Après appui sur la commande `API reference` du menu `Help`, l'écran `Gatewatcher API` est affiché.

8.6.7.6. Procédure d'exécution d'un endpoint

Pour illustrer cet exemple, l'API choisi est celui qui permet de lister les GCaps connecté au GCenter.

Sélectionner le thème `Gcaps` dans la liste des thèmes existants (5).
Cliquer sur l'API `GET/api/gcap/ (Administrators, Operators) Get all the GCaps linked to the GCenter`.

La fenêtre ci-dessous est affichée.

Astuce

Pour certains endpoints, il est obligatoire se saisir des paramètres avant de pouvoir l'exécuter.
Cliquer sur le bouton (2) `Try it out`.

La fenêtre est modifiée ...
Cliquer sur le bouton (1) `Execute`.

La requête est lancée et la fenêtre suivante est affichée.

Cette fenêtre comprend plusieurs parties :
- la zone d'affichage (2) `Curl` pour la requête Curl
- la zone d'affichage (3) `URL` pour la requête URL
- la zone (4) `Server response` :
  - le `Code` (5) de retour :
    Si le code a pour valeur `200` alors l'exécution s'est correctement effectuée.
    
    Si le message `code 400 Undocumented Error Bad Request` est affiché, vérifier que les paramètres obligatoires soient bien saisis.
  - le corps de la réponse (6) : se référer à la Présentation de l'interface API
  - la zone détaillant l'en-tête de la réponse (7)
  - la valeur en ms de la durée de la requête (8)
  - le bouton `Download` pour télécharger le fichier .json correspondant
- la zone `Responses`
  
  Cette zone affiche des informations différentes suivant l'utilisation du lien `Model` ou `Example Value`.
- soit le modèle de sortie (`Model`) : se référer à la Présentation de l'interface API
- soit un exemple de la réponse dans le champ attendue avec des valeurs pour exemple (`Example Value`) : se référer à la Présentation de l'interface API
  
  Les valeurs sont :
  - pour le type integer (valeur 0)
  - pour le type string (valeur = string)
  - pour le type boolean (valeur = true)

8.6.7.7. Procédure pour modifier le token associé à la requête

Cliquer sur le bouton (1).

La fenêtre `Available authorizations` est affichée :

Deux options sont possibles :
- soit l'utilisation d'un apikey (token préalablement créé)
- soit l'utilisation d'une autorisation par nom et mot de passe d'un compte préalablement créé
Pour utiliser un apikey (token préalablement créé) :
- coller le token dans le champ `value`
- valider en cliquant sur le bouton `Authorize`
- fermer la fenêtre avec le bouton `Close`
Note

Le token peut avoir une durée de vie limitée : voir la Procédure pour ajouter une nouvelle clé API.
Pour utiliser une autorisation :
- cliquer dans le champ `Username`
  
  La liste des comptes existants est affichée.
- entrer le mot de passe du compte
- valider en cliquant sur le bouton `Authorize`
- fermer la fenêtre avec le bouton `Close`