- Previous: X-Api-Key
- Up: Getting Started
- Next:
Try it out
The [**Interactive Documentation**](/io-docs) page is intended as a sandbox where you can experiment with our APIs. First, however, you need to have a key and optionally a secret (you can find out how to get them [**here**](/docs/Register_your_Application)), then you will be able to authorize your calls.
Select the API that you would like to test from the drop-down menu.
If the API is authenticated you will see an *Authorize* button and an open lock symbol next to each endpoint.
Refer to the [**Authorize your API calls**](docs/Authorize_your_API_calls) page for instructions on how to manage the authorization step. Once you are done with that choose the endpoint you want to test and expand it.
The details available for each endpoint are:
- PARAMETERS: the list of input parameters available
- RESPONSES: the list of possible responses with example payloads
At the bottom of the page you will find the list of the MODELS, one for each definition included in the swagger. Each model can be expanded to inspect its internal structure.
Once you are ready click on the *Try it out* button and fill the required input parameters, then click *Execute* to execute the call.
Once the call has been executed the page will show the following new sections:
- CURL: the Interactive Documentation will generate a cUrl command with the input you provided and the authorization data, ready to be copy-pasted into a shell if needed
- REQUEST URL: the complete URL that the call is invoking
- SERVER RESPONSE: this area will be populated with
- Response body
- Response headers
[//]: # (La seguente riga abilita le anchors automatiche ma nasconde la barra dei better docs)
- Previous: X-Api-Key
- Up: Getting Started
- Next: