| ... | ... | @@ -16,7 +16,7 @@ The token must be set to the "X-API-Key" parameter in the HTTP header. |
|
|
|
|
|
|
|
# How to use the API UI page ?
|
|
|
|
|
|
|
|
If you have a valid token, you can request the API from anywhere, including it's [start page]( https://operations-portal.egi.eu/api-documentation), which provides an user interface, and demo features.
|
|
|
|
If you have a valid token, you can request the API from anywhere, including it's [start page]( https://operations-portal.egi.eu/api-documentation), which comes with an user interface implementing [Swagger UI](https://swagger.io/tools/swagger-ui/).
|
|
|
|
|
|
|
|
To do this, click the  button, and set your token value in the prompt. In this way your token will be automatically set in the header (X-API-Key) for all your requests on this page.
|
|
|
|
You can now request every endpoint of the API with a friendly user interface.
|
| ... | ... | @@ -25,10 +25,10 @@ The image below shows an example of one endpoint. |
|
|
|
|
|
|
|

|
|
|
|
|
|
|
|
Send your request by clicking "Try it" on the route you want to request, set the appropriate parameters, and click "Execute".
|
|
|
|
Send your request by clicking  on the route you want to request, set the appropriate parameters, and click "Execute".
|
|
|
|
|
|
|
|
As soon as the response is back, the API user interface will display :
|
|
|
|
- The response's HTTP status and content (in case of error the API usually returns a helper message specifying whether it's a request problem or a server failure).
|
|
|
|
- TODO img
|
|
|
|
- 
|
|
|
|
- The request URL matching your parameters and an re-usable Curl command line to request this URL from anywhere (see below).
|
|
|
|
-  |
|
|
\ No newline at end of file |