API: Produkt: Unterschied zwischen den Versionen

Aktuelle Version vom 13. Januar 2019, 17:30 Uhr

Die Produkt-API ermöglicht es Kunden, Hosting-Produkte programmgesteuert zu bestellen und zu verwalten.

Bestellung

Um eine Bestellung aufzugeben, muss das API-Kommando hosting/order genutzt werden. Gleichzeitig muss die ID des gewünschten Produkts als id übergeben werden.

Optional kann eine Notiz für das anzulegende Produkt als note übergeben werden.

Wenn der Parameter async auf 1 gesetzt wird, wird das Produkt nicht sofort eingerichtet. Sobald es eingerichtet wurde, erhalten Sie die Produkt-Zugangsdaten per E-Mail. Wird der Parameter hingegen nicht gesetzt, erfolgt die Produkt-Einrichtung in Echtzeit und Sie erhalten die Zugangsdaten sofort über die API.

Die Rückgabe dieser Funktion enthält im JSON-Array das verschachtelte Array "data". Darin finden Sie das Element "id", das die ID des neuen Vertrages enthält. Wurde der Vertrag bereits eingerichtet, finden Sie in "data" eventuell Zugangsdaten.

Vertrags-Info abrufen

Details zu einem Vertrag können Sie über das API-Kommando hosting/info abrufen. Hierbei müssen Sie die ID des Vertrages als id angeben.

Das zurückgegebene JSON-Array enthält mit dem verschachtelten "data"-Array diverse Informationen zum Vertrag:

• status = true|false
• description
• order_date
• product
• price
• period
• next_invoice
• contract_time
• notification_period
• cancellation_date
• login_data[]
• tasks[]

Aktion ausführen

Für bestimmte Produkte sind diverse Aktionen verfügbar (siehe tasks[] aus vorherigem Abschnitt). Diese können Sie über das API-Kommando hosting/task ausführen. Hierbei müssen Sie die ID des Vertrages als id angeben. Die auszuführende Aktion müssen Sie als task übergeben.

Für die Aktion AssignDomain (falls verfügbar) müssen Sie den Parameter domain übergeben.

Notiz setzen

Sie können die Notiz für einen bestehenden Vertrag setzen. Dazu müssen Sie das API-Kommando hosting/set nutzen. Hierbei müssen Sie die ID des Vertrages als id angeben. Die neue Notiz müssen Sie als note übergeben.

Kündigung eintragen

Um die Kündigung für einen Vertrag zu verwalten, müssen Sie das API-Kommando hosting/set nutzen. Hierbei müssen Sie die ID des Vertrages als id angeben.

Der normale Aufruf führt dazu, dass Ihnen im "date"-Array der JSON-Rückgabe die verfügbaren Kündigungsdaten als "dates"-Array vorgeschlagen werden. Eine Kündigung reichen Sie ein, indem Sie ein valides Datum als Parameter cancel übermitteln. Eine bestehende Kündigung heben Sie auf, indem Sie 0000-00-00 als Parameter cancel übergeben.