INDICE
Documentazione API
Le API di Setera OneCloud possono interagire sia lato Admin che lato End User.
Puoi consultare l'elenco delle API End User dal seguente link:
Puoi consultare l'elenco delle API Admin dal seguente link:
Per l'abilitazione delle API Admin, ti preghiamo di contattare il tuo referente tecnico di Setera.
Abilitazione API
Per l'abilitazione delle API OneCloud è necessario apportare le configurazioni previste accedendo come Admin su OneCloud.
Consulta il seguente articolo su come abilitare gli utenti all'uso delle API dal portale Admin di OneCloud: [Admin] Configurazione External API Authorization
API Tickets
OneCloud utilizza un sistema di ticket per permettere l'accesso alle API. Alla creazione di un ticket verrà generato un token univoco da utilizzare come autenticazione all'uso delle API per la quale il ticket è stato concesso. I ticket vengono generati accedendo al portale utente OneCloud e avranno una durata standard di 365 giorni.
I ticket possono essere revocati se necessario.
Un ticket può essere concesso per una o molteplici API.
Autenticazione Bearer Token
L'autenticazione avviene attraverlo l'utilizzo del Token (Bearer) generato alla creazione dei Ticket.
| Security Scheme Type | HTTP |
| HTTP Authorization Scheme | Bearer |
Metodi HTTP
Le API di OneCloud utilizzano i seguenti metodi HTTP per la manipolazione dei dati:
- GET - ottiene il dato
- POST - inserisce/crea il dato
- PUT - aggiorna il dato
- DELETE - rimuove il dato
I client HTTP che non sono in grado di utilizzare le operazioni HTTP PUT o DELETE devono tradurre le operazioni PUT e DELETE in operazioni POST con l'intestazione aggiuntiva X-HTTP-Method-Override, ad esempio:
POST /... HTTP/1.1 X-HTTP-Method-Override:PUT
Setera OneCloud risponde alla richiesta POST+X-HTTP-Method-Override come se il contenuto dell'intestazione X-HTTP-Method-Override fosse l'effettiva operazione HTTP richiesta.
Tutte le richieste al server devono avere gli header HTTP Content-Type e Accept impostati su un valore applicabile in base alla rispettiva operazione, ad esempio application/json o application/xml.
Risposta HTTP
HTTP Status Codes
Setera OneCloud restituisce i seguenti codici di risposta agli errori HTTP quando si verificano problemi:
| Codice | Descrizione |
|---|---|
400 | Bad Request - Quando si riceve un URI di richiesta non valido, un'intestazione HTTP non valida o un corpo del messaggio non valido. Di solito include un corpo costituito dal risultato della validazione. |
401 | Not Authorized - Quando mancano le credenziali di autorizzazione o non si è autorizzati ad accedere alla risorsa richiesta. |
403 | Not Authorized - Il server ha compreso la richiesta ma si rifiuta di soddisfarla. L'autorizzazione non è utile. Il contesto di autorizzazione corrente non consente la richiesta. |
404 | Not Found - Il server non trova la risorsa che corrisponde all'URI richiesto. |
405 | Method Not Allowed - Il metodo specificato nella richiesta non è consentito per la risorsa identificata dalla richiesta. |
409 | Conflict - La richiesta non può essere completata a causa di un conflitto con lo stato attuale della risorsa. Questo codice è consentito solo in situazioni in cui si prevede che l'utente possa risolvere il conflitto e inviare nuovamente la richiesta. |
500 | Internal Server Error - È il codice predefinito utilizzato per tutti gli errori non riconosciuti. |
501 | Not Implemented - La richiesta era valida ma non è ancora stata implementata da Setera OneCloud. |
Setera OneCloud può aggiungere un'intestazione Warning con codice 703 alla risposta in caso di errori. Il testo dell'intestazione conterrà un token di log nella forma "Error occurred, see {token}".