Skip to main content
La versione in lingua italiana fornita proviene da una traduzione automatica. Per eventuali incoerenze, fare riferimento alla versione in lingua inglese.

Invio di richieste API

Collaboratori
PDF

L'interfaccia utente di Swagger fornisce dettagli completi e documentazione per ogni operazione API.

Di cosa hai bisogno

  • È necessario accedere a Grid Manager utilizzando un browser supportato.

  • È necessario disporre di autorizzazioni di accesso specifiche.

Importante Tutte le operazioni API eseguite utilizzando la pagina web API Docs sono operazioni live. Fare attenzione a non creare, aggiornare o eliminare per errore i dati di configurazione o altri dati.
Fasi

  1. Selezionare Help API Documentation dall'intestazione Grid Manager.

  2. Selezionare l'operazione desiderata.

    Quando si espande un'operazione API, è possibile visualizzare le azioni HTTP disponibili, ad esempio GET, PUT, UPDATE ed DELETE.

  3. Selezionare un'azione HTTP per visualizzare i dettagli della richiesta, tra cui l'URL dell'endpoint, un elenco di eventuali parametri obbligatori o facoltativi, un esempio del corpo della richiesta (se necessario) e le possibili risposte.

    Esempio dall'interfaccia utente di Swagger

  4. Determinare se la richiesta richiede parametri aggiuntivi, ad esempio un ID utente o un gruppo. Quindi, ottenere questi valori. Potrebbe essere necessario emettere prima una richiesta API diversa per ottenere le informazioni necessarie.

  5. Determinare se è necessario modificare il corpo della richiesta di esempio. In tal caso, fare clic su Model per conoscere i requisiti di ciascun campo.

  6. Fare clic su Provalo.

  7. Fornire i parametri richiesti o modificare il corpo della richiesta secondo necessità.

  8. Fare clic su Execute (Esegui).

  9. Esaminare il codice di risposta per determinare se la richiesta ha avuto esito positivo.