Utiliser la console

La console est une interface graphique simple mais efficace pour découvrir et requêter l'API Mobilic.

La console est accessible depuis le lien suivant :

https://mobilic.beta.gouv.fr/developers/playground

Présentation

La console est constituée de 4 parties :

• l'éditeur de requêtes qui occupe l'essentiel de la partie gauche. C'est ici que sont écrites les opérations.

• les réponses retournées par l'API sur la moitié droite

• le tiroir de documentation qui détaille les actions de l'API, ouvrable depuis le bouton situé tout à gauche

• l'éditeur d'en-têtes de requêtes + variables d'opération situé en bas à gauche

Authentification

La plupart des requêtes à l'API nécessitent d'être authentifié via un jeton d'accès.

Exemple de rajout d'un jeton lié à un rattachement :

{
  "X-CLIENT-ID": 156432124,
  "X-EMPLOYMENT-TOKEN": "06dd5a1a9f9552876c79251dcccd7bbdb7cd5c098b72"
}

Exemple de rajout d'un jeton lié à un utilisateur :

{
  "X-CLIENT-ID": 156432124,
  "Authorization" : "Bearer 1234-fefdsfds-1484-fsdfsd-489"
}

Exemple simple

Reprenons l'exemple de l'action de login détaillé ici.

Dans l'éditeur de requêtes il n'y a pas besoin de constituer le corps JSON de la requête HTTP, il suffit simplement d'y écrire l'opération GraphQL.

Opération de création d'activité dans la console

Puis il suffit de soumettre la requête en cliquant sur le bouton du milieu, en ayant préalablement renseigné les header HTTP d'authentification.

Editer les variables d'opération

Il est possible d'utiliser des variables d'opération à l'aide de l'éditeur de variables en bas à gauche.