Portfolio
Einführung
Mit der DNS API können Sie Ihre die DNS Konfiguration ihrer Domains technisch per Schnittstelle (d.h. ohne Aufruf des united-domains Portfolios) konfigurieren. Um die API nutzen zu können, sind einige Schritte erforderlich.
Buchen Sie die DNS API
Um Zugriff auf die DNS API zu erhalten, müssen Sie zuerst das Produkt DNS API buchen.
Sie können die DNS API auf der united-domains Webseite unter https://www.united-domains.de/domain-dnsapi/ buchen.
Klicken Sie dazu in der Produkttabelle auf „Jetzt bestellen“, um das Produkt in den Warenkorb zu legen und durchlaufen im Anschluss den Checkout-Prozess.
Sind Sie bereits Kunde, können Sie die DNS API alternativ auch in Ihrem Portfolio direkt hier buchen: https://united-domains.de/portfolio/a/dns-api
API-Schlüssel erstellen
Sobald die DNS API in Ihrem Konto aktiv ist, können Sie API-Zugangsdaten erstellen. Öffnen Sie dazu die DNS API Konfigurationsseite und klicken auf „Neuen API Key erstellen“.
Vergeben Sie einen sprechenden Namen für Ihren API Key und klicken Sie auf „Speichern“:
Es wird nun ein neuer API Key generiert. Die Informationen zu diesem API key werden nun einmalig angezeigt. Bitte kopieren Sie den API Key und bewahren ihn an einem sicheren Ort auf.
Bestätigen Sie mit dem Haken, dass sie den API Key kopiert und sicher verwahrt haben und klicken dann auf „Verstanden“.
Hinweis: Der API key besteht aus einem öffentlichen Präfix und einem geheimen Secret, die beide mit einem Punkt voneinander getrennt sind.
API-Schlüssel verwalten
In der Übersicht können Sie einen API Key also sowohl anhand seines öffentlichen Präfixes (= der grün markierte Wert vor dem Punkt) oder an dem von Ihnen vergebenen Namen erkennen.
Das geheime Secret (= der gelb markierte Anteil nach dem Punkt) ist nicht mehr einsehbar und wird aus Sicherheitsgründe auch von united-domains nicht gespeichert.
Haben Sie Ihren API Key verloren, gibt es keine Möglichkeit diesen wiederherzustellen. In diesem Fall müssen Sie den API Key löschen und neu anlegen.
API-Aufrufe durchführen
Für API-Aufrufe benötigen Sie Ihren API-Key in einem Authentifizierungsheader. Das Format lautet:
X-API-Key: publicprefix.secret
Beispiel: Für den oben erhaltenen API-Schlüssel lautet der Header:
X-API-Schlüssel: 014a58734f704b3fa254d3fb843ce371.nMiGBa0VK8EjbjImCvsQF9xPYKzlaHTKco9ix5j0InoBv8RxJpdlY_A3hEnk67ZiBrcVblNzeMdkLFTNiqjULg
Beispiel für einen API-Aufruf:
curl -X GET "https://dnsapi.united-domains.de/dns/v1/zones" -H "X-API-Key: 014a58734f704b3fa254d3fb843ce371.nMiGBa0VK8EjbjImCvsQF9xPYKzlaHTKco9ix5j0InoBv8RxJpdlY_A3hEnk67ZiBrcVblNzeMdkLFTNiqjULg"
Rate-Limits
Die API hat für jeden Kunden-API-Key ein Rate-Limit.
Das Rate-Limit eines API-Keys beträgt 1.200 Anfragen pro Stunde und wird stündlich zurückgesetzt. Alle API-Anfragen mit dem Header „X-API-Key“ werden gezählt.
Bei Erreichen des Rate-Limits wird die Anfrage nicht bearbeitet und die Anwendung erhält den Statuscode „HTTP 429 – Too Many Requests“ mit der folgenden Fehlermeldung:
{"message":"API rate limit exceeded"}
API Dokumentation
Eine vollständige API Dokumentation finden Sie hier: API Dokumentation
Support
Supportanfragen können in deutscher oder englischer Sprache an folgende E-Mail-Adresse gesendet werden: support@united-domains.de
Bei technischen Fragen oder zur Meldung eines Problems geben Sie uns bitte möglichst detaillierte Informationen. Dies hilft uns, Ihre Anfrage schneller zu bearbeiten. Relevante Informationen sind in diesem Fall vor allem:
- Verwendete Produkt-API (= DNS)
- Problembeschreibung
- Durchgeführte API-Aufrufe
- Erwartetes Ergebnis
- Tatsächliches Ergebnis
Gerne geben Sie uns auch allgemeines Feedback zu den über die API bereitgestellten Funktionen sowie zu Verbesserungsvorschlägen oder Funktionswünschen. Wir werden diese gerne für die Weiterentwicklung und zukünftige Releases berücksichtigen.