Erste Schritte mit der OVHcloud API

Letzte Aktualisierung am 30.05.2022

Ziel

Die unter https://api.ovh.com/ verfügbare API erlauben es Ihnen, OVHcloud Produkte zu bestellen, zu verwalten, zu aktualisieren und zu konfigurieren, ohne ein grafisches Interface wie das Kundencenter zu verwenden.

Hier erfahren Sie, wie Sie die OVHcloud APIs verwenden und mit Ihren Anwendungen verbinden.

Voraussetzungen

• Sie verfügen über einen aktiven OVHcloud Kunden-Account und kennen dessen Zugangsdaten.
• Sie sind auf der Webseite der OVHcloud APIs.

In der praktischen Anwendung

Grundlegende Funktionen

Verbindung mit der OVHcloud API

Klicken Sie auf der OVHcloud API Seite auf Explore the OVH API, um die Liste der API-Funktionen anzuzeigen.

Um die API für Ihre Dienste zu verwenden, loggen Sie sich mit Ihren OVHcloud Zugangsdaten ein:

• Klicken Sie auf oben rechts Login.
• Geben Sie Ihre OVHcloud Zugangsdaten ein.
• Legen Sie unter der Bezeichnung Validity einen Zeitraum fest, währenddessen Aktionen über die OVHcloud API erlaubt sein sollen.

Die mit API verfügbaren Dienste analysieren

Wenn Sie eingeloggt sind, werden alle OVHcloud Dienste, die über API-Zugang verfügen, angezeigt. Diese Liste ist alphabetisch geordnet.

Um zum Beispiel die zu Domainnamen gehörenden API-Aufrufe anzuzeigen, klicken Sie auf /domain in der Liste.

Nachdem Sie auf die Dienstbezeichnung geklickt haben, wird die Liste der verfügbaren API-Funktionen angezeigt.

API-Aufrufe ausführen

Es sind 4 HTTP-Methoden für die API verfügbar:

GET

Die GET-Methode dient dem Abruf von Daten aus einer Ressource.

Um zum Beispiel die Liste Ihrer Domainnamen abzurufen, verwenden Sie folgenden Aufruf:

POST

Die POST-Methode wird verwendet, um zusätzliche Daten an die Ressource zu senden.

Um zum Beispiel einen Eintrag zu Ihrer DNS Zone hinzuzufügen, verwenden Sie folgenden Aufruf:

PUT

Die PUT-Methode dient dazu, die aktuellen Ressourcen-Daten durch die Daten der Abfrage zu ersetzen.

Um beispielsweise einen Eintrag in Ihrer DNS Zone zu korrigieren, verwenden Sie folgenden Aufruf:

DELETE

Die DELETE-Methode wird verwendet, um die Ressource zu löschen.

Um beispielsweise einen Eintrag in Ihrer DNS Zone zu löschen, verwenden Sie folgenden Aufruf:

Parameter der API

Nachdem Sie auf den Endpunkt Ihrer Wahl geklickt haben, können Sie im Bereich Parameters Ausführungsvariablen eingeben.

Um zum Beispiel einen TXT Eintrag in Ihrer DNS Zone hinzuzufügen, editieren Sie die folgenden Einstellungen:

Wenn Sie die Parameter festgelegt haben, können Sie die Ausführung des Aufrufs starten, indem Sie auf Execute klicken.

Der Tab Result zeigt den Bericht zur Durchführung des API-Aufrufs.

Die Tabs PHP und Python enthalten die Elemente, die entsprechend der Anwendungssprache in Ihrem Skript hinzugefügt werden müssen.

Fortgeschrittene Nutzung: OVHcloud API mit einer Anwendung verbinden

Schlüssel für Ihre Anwendung erstellen

Jede Anwendung, die mit der OVHcloud API kommunizieren möchte, muss zuerst freigegeben werden.

Klicken Sie hierzu auf folgenden Link: https://eu.api.ovh.com/createToken/.

Geben Sie Ihre Kundenkennung, Ihr Passwort und den Namen Ihrer Anwendung ein. Der Name kann nützlich sein, um anderen Personen Zugriff zu gewähren.

Sie können auch eine Beschreibung der Anwendung und eine Zeitangabe hinzufügen.

Der Eintrag Rights erlaubt es, die Verwendung der Anwendung auf bestimmte Funktionen zu beschränken.
Um eine HTTP-Methode für alle Endpunkte zu erlauben, geben Sie im Feld einen Stern (*) ein. Im folgenden Beispiel werden alle GET-Abfragen erlaubt:

Wenn Sie auf Create Keys klicken, erhalten Sie drei Schlüssel:

• Den Anwendungsschlüssel AK. Zum Beispiel:

7kbG7Bk7S9Nt7ZSV

• Den geheimen, nicht zur Veröffentlichung bestimmten Anwendungsschlüssel AS. Zum Beispiel:

EXEgWIz07P0HYwtQDs7cNIqCiQaWSuHF

• Den geheimen, nicht zur Veröffentlichung bestimmten "Consumer Key" oder CK. Zum Beispiel:

MtSwSrPpNjqfVSmJhLbPyr2i45lSwPU1

In diesem Fall ist der Schlüssel vom Typ CK an Ihren Account gebunden.

Der CK-Token kann für die Übertragung von Rechten verwendet werden. Weitere Informationen finden Sie in dieser Anleitung: How to manage a customer’s account via OVHcloud API (EN).

Erste Verwendung der API

Sobald Ihre drei Schlüssel (AK, AS, CK) verfügbar sind, können Sie die API Anfragen signieren. Die Signatur wird wie folgt berechnet:

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

Um die Entwicklung Ihrer Anwendungen zu vereinfachen, stellt OVHcloud API-Wrapper in mehreren Sprachen bereit. Wenn Sie diese verwenden, müssen Sie sich nicht um die Berechnung der Signatur kümmern und können sich auf die Programmierung Ihrer Anwendung konzentrieren.

• Perl: https://eu.api.ovh.com/wrappers/OvhApi-perl-1.1.zip
• Python: https://github.com/ovh/python-ovh
• PHP: https://github.com/ovh/php-ovh
• Node.js: https://github.com/ovh/node-ovh
• Swift: https://github.com/ovh/swift-ovh
• C#: https://github.com/ovh/csharp-ovh

Hier ein Beispiel für die Nutzung der Rubrik /me zur Verwaltung Ihres OVHcloud Kunden-Accounts:

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'])

Weiterführende Informationen

Domainnamen über die API verwalten (EN)

OVHcloud Kunden-Account über die API verwalten (EN)

Für den Austausch mit unserer User Community gehen Sie auf https://community.ovh.com/en/.