Server ed URLs

Tutti gli endpoint delle APIs sono relativi all’URL di base https://api.auroravision.net/api/rest.
In base all’API che vuoi chiamare, avrai una concatenazione tra l’URL di base ed i parametri di percorso degli endpoint dedicati a risorse e servizi specifici.
Ad esempio: supponendo che tu voglia autenticarti, l’API sarà composta dall’URL di base https://api.auroravision.net/api/rest concatenato all’endpoint espresso con il parametro path /authenticate.

In generale è sempre importante tenere presente che qualsiasi API sarà sempre composta da parametri diversi:

• Path: parti variabili di un percorso URL utilizzato per puntare a una risorsa specifica all’interno di una raccolta;
• Header: parametri di guida per le richieste HTTP necessarie per ottenere una risposta lato server;
• Query:parametri utilizzati per filtrare e personalizzare la chiamata API concatenandoli con sintassi specifica, possono essere obbligatori o facoltativi;

Qualsiasi chiamata effettuata tramite il servizio API ha l’ X-AuroraVision-Token come header.
Per ottenere il token, è necessario utilizzare l’API di autenticazione inserendo le credenziali dell’account Aurora Vision insieme alla X-AuroraVision-ApiKey come header della chiamata.

E’ possibile visualizzare tutte le APIs, con la descrizione di tutti i parametri, attraverso l’apposita documentazione (OpenAPIs Swagger).