Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Greenspector Studio API is available by using the swagger page or by using an API token with tools like curl, postman …

Use swagger

When you are connected to the Studio Web Interface, the swagger is available by going to the menu Help (question) / Documentation and by clicking on Greenspector Studio API link.

...

swaggerapi.png

Use API Token with curl or postman

Prerequisites

You need to generate a new API token or use an existing API token shared by an admin. You can go to menu Account / API Tokens and then copy to your clipboard the API token by clicking on the first action button.

...

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

Example with curl

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

...

Note

Be careful, do not keep {} when replacing.

Example with postman

  • Add a new request in postman

  • Set a new GET request with url http://saas.greenspector.com/applications/{applicationId}/evolution

  • Replace {applicationId} with the applicationId of your analysis.

  • Add an authorization of type Bearer Token and put your API Token.

...