L' API Greenspector Studio

Owned by Guillaume SUSSELIN
Oct 18, 2024
2 min read

L’API de Greenspector Studio est désormais disponible via une page swagger ou via l’usage des jetons d’API en combinaison avec des outils comme curl ou postman …

Usage de swagger

Lorsque vous êtes connecté à l’interface web Studio, la page swagger est disponible en allant dans le menu menu Aide / Documentation page et en cliquant sur le lien L’API de Greenspector Studio.

doc_fr.png
swaggerapi.png

Usage d’un jeton d’API avec curl ou postman

Prérequis

Vous avez besoin de générer un nouveau jeton d’API ou d’utiliser un jeton d’API existant partagé par un administrateur de votre organisation. Pour cela, allez dans le menu Compte / Jetons d’API et copiez le jeton d’API dans votre presse papier en cliquant sur le premier bouton d’action disponible.

Ensuite, si vous voulez utiliser une API qui concerne une analyse (ou application) en particulier vous devez ajouter votre jeton d’API comme un membre de l’analyse. Le jeton est vue comme un utilisateur sur l’interface.

 

Profitez pour récupérer l’identifiant “applicationId” de votre analyse. Vous pouvez le trouver dans la barre d’url quand vous ouvrez une analyse. For example:

https://saas.greenspector.com/applications/670777777777/versions/6710fb777777/synthesis

Exemple avec curl

curl -X 'GET' \ 'http://saas.greenspector.com/applications/{applicationId}/evolution' \ -H 'accept: application/json' \ -H 'Authorization: Bearer {XXXX}'

  • Remplacez {applicationId} avec l' applicationId de votre analyse.

  • Remplacez {XXXX} avec le jeton d’API.

Attention ne garder pas {} quand vous faites le remplacement

Exemple avec postman

  • Ajoutez une nouvelle requête dans postman

  • Choisissez une requête de type GET et renseignez l’url http://saas.greenspector.com/applications/{applicationId}/evolution

  • Remplacez {applicationId} avec l’identifiant “applicationId” de votre analysefb777777/synthesis

  • Ajoutez dans l’onglet “authorisation” une authorization de type “Bearer Token” et renseignez le champ token avec votre jeton d’API

  • Appuyez sur le bouton “Send”

  • Vous pouvez voir le résultat au format JSON