Explorateur GraphQL

L’explorateur GraphQL utilise le client GraphiQL. Pour commencer, rendez vous sur explore.api.iiens.net.

Note

D’autres client peuvent être utilisés pour réaliser vos requêtes, comme la commande curl par exemple. L’avantage de l’explorateur est l’authentification automatique via AriseID Connect.

Important

L’explorateur vous authentifie via OAuth avec le scope api. Le jeton possède les mêmes permissions que votre utilisateur, sans restriction. Par exemple, un admin ARISE pourra accéder aux champs sensibles des utilisateurs.

Un client non authentifié est accessible à l’URL https://api.iiens.net/graphql.

Tip

Des explications plus poussées sur la syntaxe GraphQL sont retrouvables sur la page Introduction à GraphQL

Une fois connecté avec AriseID Connect, vous devriez vous retrouver sur une page similaire à la capture ci-dessus. À gauche, le contenu de la requête. Cela ressemble à du JSON et c’est normal car c’est la forme des données qui nous seront retournées. En bas l’onglet Variables permet d’ajouter des paramètres à notre requête pour la rendre réutilisable. L’onglet Headers permet entre autres d’ajouter les entêtes d’authentification à notre requête, ce qui n’est pas nécessaire sur l’explorateur comme les requêtes sont automatiquement authentifiées avec l’utilisateur courant.

La requête par défaut récupère via profile (profil de l’utilisateur courant) des informations précises (id, nickname, schoolYear, isFipa).

Le bouton rose ▶ (ou Ctrl+Enter) exécute la requête :

On reçoit alors la réponse en JSON à droite, de la forme demandée.

L’avantage majeur de GraphQL est son système de schéma, qui décrit l’entièreté des requêtes possibles ainsi que leur attributs. Le tout documenté avec des commentaires. En cliquant sur le libre à gauche vous pourrez parcourir le schéma.

D’autres requêtes sont possibles, par exemple sur groups en récupérant les données de façon paginée.