Iniziare a utilizzare le API OVHcloud

Obiettivo

Le API disponibili su https://api.ovh.com/ ti permettono di acquistare, gestire, aggiornare e configurare prodotti OVHcloud senza utilizzare un'interfaccia grafica come lo Spazio Cliente.

Scopri come utilizzare le API OVHcloud e come associarle alle tue applicazioni

Prerequisiti

• Disporre di un account OVHcloud attivo e conoscere le proprie credenziali
• Essere sulla pagina Web delle API OVHcloud.

Procedura

Utilizzo semplice

Accedi alle API OVHcloud

Nella pagina delle API OVHcloud clicca su Explore the OVH API per visualizzare la lista delle API.

Per utilizzare le API sui tuoi prodotti, accedi al sito utilizzando le credenziali OVHcloud.

• Clicca su Autentication in alto a sinistra.
• Clicca su Login with OVHcloud SSO.
• Inserisci le tue credenziali OVHcloud.
• Clicca sul pulsante Authorize per autorizzare le chiamate alle API da questo sito.

Esplora i prodotti disponibili sulle API

Nel menu a sinistra è disponibile la lista dei prodotti OVHcloud che possono essere gestiti tramite API.

Per visualizzare, ad esempio, le API associate ai domini, clicca su /domain nella lista.

Dopo aver cliccato sul prodotto, visualizzi la lista delle API del prodotto.

Hai anche a disposizione un selettore a sinistra della lista dei prodotti che ti permette di scegliere tra i rami /v1 e /v2 dell'API. Se non si ha familiarità con il principio delle diramazioni API, è possibile consultare la documentazione seguente relativa all'API v2.

Esegui un'API

Esistono 4 tipi di API disponibili che utilizzano i cosiddetti metodi HTTP:

GET

La modalità GET ha lo scopo di recuperare i dati di una risorsa.

Ad esempio, per recuperare la lista dei tuoi domini, utilizza questa API:

POST

Il metodo POST è utilizzato per inviare dati aggiuntivi alla risorsa.

Ad esempio, per aggiungere un record alla tua zona DNS, utilizza questa API:

PUT

Il metodo PUT serve a sostituire i dati attuali della risorsa con i dati della richiesta.

Ad esempio, in caso di errore nel record della tua zona DNS, utilizza questa API:

DELETE

Il metodo DELETE è utilizzato per eliminare la risorsa chiamata.

Ad esempio, se non vuoi conservare il record DNS che hai aggiunto alla tua zona DNS, utilizza questa API:

Impostazioni dell'API

Dopo aver cliccato sull'API di tua scelta, la sezione Request permette di attribuire le variabili relative alla sua applicazione.

Ad esempio, per aggiungere un record TXT nella tua zona DNS, ottieni questi parametri:

Una volta definiti i parametri, puoi avviare l'API cliccando su EXECUTE.

La scheda Response mostrata fornirà il report di esecuzione dell'API.

Le schede PHP e Python contengono gli elementi da aggiungere al tuo script in base al linguaggio utilizzato.

Utilizzo avanzato: associare le API OVHcloud con un'applicazione

Crea le chiavi della tua applicazione

Qualsiasi applicazione che desideri comunicare con l'API OVHcloud deve essere dichiarata in anticipo.

Clicca su questo link: https://eu.api.ovh.com/createToken/.

Inserisci il tuo identificativo cliente, la password e il nome della tua applicazione. Il nome sarà utile più tardi se volete autorizzare altre persone a usarlo.

È inoltre possibile aggiungere una descrizione dell'applicazione e una temporalità.

Il campo Rights ti permette di limitare l'utilizzo dell'applicazione a certe API.
Per autorizzare tutte le API OVHcloud per un metodo HTTP, inserisci una stella * nel campo, come nell'esempio qui sotto, dove il metodo GET è autorizzato per tutte le API:

Dopo aver cliccato su Create keys, ottieni tre chiavi:

• la chiave di applicazione, chiamata AK. Ad esempio:

7kbG7Bk7S9Nt7ZSV

• la chiave segreta da non divulgare, chiamata AS. Ad esempio:

EXEgWIz07P0HYwtQDs7cNIqCiQaWSuHF

• una segreta "consumer key" da non divulgare, chiamata CK. Ad esempio:

MtSwSrPpNjqfVSmJhLbPyr2i45lSwPU1

In questo caso, la chiave CK è associata al tuo account.

Il token CK può essere utilizzato per la delega dei diritti. Per saperne di più, consulta questa guida: Come gestire l'account di un cliente OVHcloud tramite le API (guida in inglese).

Primo utilizzo dell'API

Una volta ottenute le tre chiavi (AK, AS, CK), puoi firmare le richieste di API. La firma è calcolata come segue:

"$1$" + SHA1_HEX(AS+"+" + CK+"+"+METHOD+"+"+QUERY+"+"+BODY+"+"+TSTAMP

Per semplificare lo sviluppo delle tue applicazioni, OVHcloud mette a disposizione wrappers API in diversi linguaggi. Utilizzarli ti permette di non preoccuparti del calcolo della firma e di concentrarti sullo sviluppo della tua applicazione.

• Go : https://github.com/ovh/go-ovh
• Perl : https://github.com/ovh/perl-ovh
• Python : https://github.com/ovh/python-ovh
• PHP : https://github.com/ovh/php-ovh
• Node.js : https://github.com/ovh/node-ovh
• C# : https://github.com/ovh/csharp-ovh

Ecco un esempio di utilizzo della sezione /me che permette di gestire il tuo account OVHcloud:

import ovh

# Instantiate. Visit https://api.ovh.com/createToken/?GET=/me
# to get your credentials
client = ovh.Client(
    endpoint='ovh-eu',
    application_key='<application key>',
    application_secret='<application secret>',
    consumer_key='<consumer key>',
)

# Print nice welcome message
print("Welcome", client.get('/me')['firstname'])

Elenca e revoca le chiavi

Per visualizzare e rimuovere le chiavi è possibile utilizzare il portale API o lo Spazio Cliente OVHcloud:

Per saperne di più

Gestire un dominio tramite le API OVHcloud (guida in inglese)

Come gestire l'account di un cliente OVHcloud tramite le API (guida in inglese)

Contatta la nostra Community di utenti all’indirizzo https://community.ovh.com/en