Le API consentono l'integrazione di cloudflow con applicazioni di terze parti. È possibile gestire ogni aspetto del vostro cloud tramite l'API. Questa guida è un riferimento completo per tutte le chiamate API e include informazioni dettagliate, codici ed esempi di output.
- Le API CloudFlow sono di tipo RESTful
- Tutte le chiamate di funzioni rispondono in XML e JSON
- Tutte le chiamate di funzioni necessintano di autorizzazione (Basic HTTP o API key)
Autentificazione API
Per l' autentificazione tramite HTTP, utilizzate la combinanzione di username/password. Esempio chiamata Curl:
curl –u user:userpass |
Per autentificarsi tramite API key, inserite l'email del vostro account come login e la chiave del server come password.
HTTP Methods
Le API utilizzano i seguenti metodi HTTP:
GET - utilizzati per recuperare informazioni da particolari URI
POST - usato per creare un nuovo oggetto e aggiungere nuove transazioni in coda
PUT - usati per alterare le proprietà di un oggetto
DELETE - usato per cancellare un oggetto
Risposte HTTP
Le API ritornano codici specifici in base alla richiesta:
|
200 OK |
La richiesta è stata completata con successo |
|
204 No content |
La richiesta è stata completata con successo. Il codice 204 viene restituito con le richieste DELETE e PUT |
|
201 Scheduled |
La richiesta è stata accettata e programmata per l' esecuzione |
|
403 Forbidden |
La richiesta è corretta, ma non può essere processata. |
|
404 Not Found |
L' URL richiesto non è corretto o la risorsa non esiste. Per esempio, se richiedi di cancellare l' user con ID {5}, ma l' utente non esiste nel cloud, otterrai un 404. |
|
422 Unprocessable Entity |
I parametri inviati non sono corretti. |
|
500 Internal Server Error |
Errore generale, contattare il supporto tecnico. |
Formatting e naming conventions
La seguente tabella mostra i criteri di formattazione utilizzati nella guida sulle API:
|
Convenzione |
Descrizione |
Esempio |
|
combinazione di username:password |
Admin:123456 |
|
|
onapp.test |
Indica l' indirizzo del pannello ( cp.domflow.eu) |
cp.domflow.eu |
|
:id |
Indica l' ID della risorsa |
23 |
|
italics |
Tutti i parametri sono nel formato Italico |
currency_code |
|
* (asterisk) |
Indica un parametro necessario |
label * |
preformatted |
Indica esempi di chiamate in XML o JSON |
GET /roles.xml |
Potete trovare l' intera guida all' uso delle API al seguente link.
