API: Produkt: Unterschied zwischen den Versionen
(Die Seite wurde neu angelegt: „Die Produkt-API ermöglicht es Kunden, Hosting-Produkte programmgesteuert zu bestellen und zu verwalten. == Bestellung == ... == Produkt-Info abrufen == ...…“) |
|||
| (Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| + | <html> | ||
| + | <div style="border: 1px solid red; padding: 10px; color: red; font-weight: bold;">Diese Dokumentation ist veraltet. Bitte nutzen Sie <a href="https://client-api.sourcedesk.de" target="_blank">die dedizierte API-Dokumentation</a>.</div> | ||
| + | </html> | ||
| + | |||
Die Produkt-API ermöglicht es Kunden, Hosting-Produkte programmgesteuert zu bestellen und zu verwalten. | Die Produkt-API ermöglicht es Kunden, Hosting-Produkte programmgesteuert zu bestellen und zu verwalten. | ||
== Bestellung == | == Bestellung == | ||
| − | . | + | Um eine Bestellung aufzugeben, muss das API-Kommando <code>hosting/order</code> genutzt werden. Gleichzeitig muss die ID des gewünschten Produkts als <code>id</code> übergeben werden. |
| − | == | + | Optional kann eine Notiz für das anzulegende Produkt als <code>note</code> übergeben werden. |
| − | .. | + | |
| + | Wenn der Parameter <code>async</code> auf <code>1</code> 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 <code>hosting/info</code> abrufen. Hierbei müssen Sie die ID des Vertrages als <code>id</code> 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 == | == 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 <code>hosting/task</code> ausführen. Hierbei müssen Sie die ID des Vertrages als <code>id</code> angeben. Die auszuführende Aktion müssen Sie als <code>task</code> übergeben. |
| + | |||
| + | Für die Aktion <code>AssignDomain</code> (falls verfügbar) müssen Sie den Parameter <code>domain</code> übergeben. | ||
== Notiz setzen == | == Notiz setzen == | ||
| − | ... | + | Sie können die Notiz für einen bestehenden Vertrag setzen. Dazu müssen Sie das API-Kommando <code>hosting/set</code> nutzen. Hierbei müssen Sie die ID des Vertrages als <code>id</code> angeben. Die neue Notiz müssen Sie als <code>note</code> übergeben. |
== Kündigung eintragen == | == Kündigung eintragen == | ||
| − | ... | + | Um die Kündigung für einen Vertrag zu verwalten, müssen Sie das API-Kommando <code>hosting/set</code> nutzen. Hierbei müssen Sie die ID des Vertrages als <code>id</code> 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 <code>cancel</code> übermitteln. Eine bestehende Kündigung heben Sie auf, indem Sie <code>0000-00-00</code> als Parameter <code>cancel</code> übergeben. | ||
Aktuelle Version vom 13. Januar 2019, 17:30 Uhr
Die Produkt-API ermöglicht es Kunden, Hosting-Produkte programmgesteuert zu bestellen und zu verwalten.
Inhaltsverzeichnis
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.
