Inhalt
- Einleitung
- REQUEST URL
- Wie schalte ich die API für mich frei?
- Permission Denied
- Sandbox
Routen
- Autorisierung - Anmeldung an der API
Service Routen - Alle Service Endpunkte
- POST /service/{serviceid}/start
- POST /service/{serviceid}/stop
- POST /service/{serviceid}/reset
- GET /service/{serviceid}/status
- POST /service/{serviceid}/rescue
- GET /service/{serviceid}/console
Order Routen - Alle Order Endpunkte
Protection Routen - Alle Protection Endpunkte
DNS Routen - Alle DNS Endpunkte
- GET /dns/zones
- GET /dns/zones/{domain}
- GET /dns/zones/{domain}/export
- PUT /dns/zones/{domain}/records
- DELETE /dns/zones/{domain}/records
- PUT /dns/zones/{domain}/dnssec
Einleitung
Unsere API ermöglicht es unseren Kunden ihre Produkt zu verwalten. Ohne dabei mit unseren Kundenbereich vorlieb nehmen zu müssen. Es können Aktionen auf der eigenen Website eingebunden werden oder man nutzt sie für eine Mobile App um auch unterwegs die eigenen Produkte zu steuern.
Unsere APIv2 ist noch eine BETA. Bitte beachtet das es hier noch zu Fehlern kommen kann. Bitte meldet diese Fehler unter Issues https://git.dsh.gg/Conan_Doyl/API/issues
REQUEST URL
Alle Requests müssen an die folgende URL gesendet werden:
https://api.dsh.gg/api/v2/
Wie schalte ich die API für mich frei?
Um die API nutzen zu können muss ein Konto angelegt werden, mit diesem Konto werden ebenfalls IP-Adressen eingetragen die auf unsere API zugreifen dürfen. Generell ist der Zugriff auf die API ohne Whitelist nicht möglich.
Um ein Konto zu erhalten muss aktuell in der BETA ein Ticket unter https://deinserverhost.de/store/submitticket.php erstellt werden. Für die Nutzung der API fallen keine Gebühren an.
Permission Denied
Ich erhalte bei der API bei einigen Requests die Meldung Permission Denied. Was muss ich tun?
Einige API Endpunkte sind noch nicht freigeschaltet oder in deiner Rolle schlichtweg nicht erlaubt.
Es können später, unterkonten auch auf die API zugreifen, weswegen wir hier ein großes Berechtigungssystem implementiert haben. Aktuell lassen sich noch keine dieser Unterkonten einrichten. Jedoch wird dies in naher Zukunft möglich sein.
Sandbox
Gibt man den GET-Parameter ?sandbox=true mit an, so wird jeder Request simuliert.
Die Ausgabe wird ebenfalls simuliert und kann daher vom LIVE-Request leicht abweichen. In der Regel ist die Ausgabe identisch, jedoch mit Beispieldaten.
.png)
DeinServerHost APIv2
- Startseite - Startseite
- Autorisierung - Anmeldung an der API
Service Routen - Alle Service Endpunkte
- POST /service/{serviceid}/start
- POST /service/{serviceid}/stop
- POST /service/{serviceid}/reset
- GET /service/{serviceid}/status
- POST /service/{serviceid}/rescue
- GET /service/{serviceid}/console
