9.6.2. Utilisation d'un endpoint API

9.6.2.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.

9.6.2.2. Prérequis

Utilisateur : membre du groupe Administrators

9.6.2.3. Opérations préliminaires

9.6.2.4. Procédure d’accès à l'API GBox

../../_images/BARRE_TITRE_OPERATOR.PNG
  • Cliquer sur le bouton (3) `API` de la barre de titre.
    L'écran suivant est affiché.
    ../../_images/GBOX-API-01.PNG

9.6.2.5. Procédure d'exécution d'un endpoint

Pour illustrer cet exemple, l'API choisi est celui qui permet de lister les modèles d'analyse.

  • Sélectionner le thème `templates` dans la liste des thèmes existants (5).

  • Cliquer sur l'API `GET/templates/ (Operators, Administrators) List and filter the templates`.
    La fenêtre ci-dessous est affichée.
    ../../_images/GBOX-API-02.PNG

    Note

    Pour l'exemple c'est l'endpoint `/templates` qui a été choisi.
    Pour rappel : l'objet est de lister et filtrer les modèles existants.

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 ...
    ../../_images/GBOX-API-08.PNG
  • Cliquer sur le bouton (1) `Execute`.
    La requête est lancée et la fenêtre suivante est affichée.
    ../../_images/GBOX-API-07.PNG
    Cette fenêtre comprend plusieurs parties :

    • la zone d'affichage (1) `Curl` pour la requête Curl

    • la zone d'affichage (2) `URL` pour la requête URL

    • la zone (3) `Server response` :

      • le `Code` (4) 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 (5) : se référer à la présentation de l'Présentation de l'interface API GBOX
      • la zone détaillant l'entête de la réponse (6)
      • la valeur en ms de la durée de la requête (7)
      • le bouton (8) `Download` pour télécharger le fichier .json correspondant
        ../../_images/GBOX-API-09.PNG
    • la zone (9) `Responses`
      Cette zone affiche des informations différentes suivant l'utilisation du lien (10) `Model` ou `Example Value`.

    • soit le modèle de sortie (`Model`) dans le champ (11) : se référer à la présentation Présentation de l'interface API GBOX

    • soit un exemple de la réponse dans le champ (11) attendue avec des valeurs pour exemple (`Example Value`) : se référer à la présentation Présentation de l'interface API GBOX
      Les valeurs sont :

      • pour le type integer (valeur 0)

      • pour le type string (valeur = string)

      • pour le type boolean (valeur = true)

    Note

    La copie d'écran est un exemple.

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

../../_images/GBOX-API-08.PNG
  • Cliquer sur le bouton (2).
    La fenêtre `Available authorizations` est affichée :
    ../../_images/GBOX-API-10.PNG

    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 (1) (token préalablement créé) :

    • coller le token dans le champ (2) `value`

    • valider en cliquant sur le bouton (3) `Authorize`

    • fermer la fenêtre avec le bouton (4) `Close`

    Note

    Le token peut avoir une durée de vie limitée : voir la Partie `API tokens` du sous menu `Accounts`.

  • Pour utiliser une autorisation (5) :

    • cliquer dans le champ (6) `Username`
      La liste des comptes existants est affichée.

    • entrer le mot de passe du compte (7)

    • valider en cliquant sur le bouton (8) `Authorize`

    • fermer la fenêtre avec le bouton (9) `Close`