Domain-API - Liste der API-Befehle

Dynadot API

Einstieg in unsere RESTful API

Die Dynadot API ist für eine nahtlose Integration mit Ihren Systemen konzipiert. Unsere API bietet vorhersehbare, ressourcenorientierte URLs, unterstützt JSON-kodierte Anforderungsinhalte, gibt JSON-kodierte und XML-kodierte Antworten zurück und hält sich an die gängigen HTTP-Methoden, Authentifizierung und Antwortcodes.Sie können die Dynadot API sowohl im Test- als auch im Live-Modus verwenden. Der Modus wird durch den API-Schlüssel bestimmt, der zur Authentifizierung Ihrer Anfragen verwendet wird. Der Testmodus ermöglicht es Ihnen, Ihre API-Integration zu simulieren und zu validieren, ohne live Daten oder Transaktionen zu beeinträchtigen.Die Dynadot API konzentriert sich hauptsächlich auf die Verwaltung von Domains, die Auftragsbearbeitung und verwandte Dienstleistungen. Sie können Aktionen wie das Registrieren, Übertragen und Erneuern von Domains durchführen, DNS-Einstellungen verwalten und Kontobestellungen einsehen oder aktualisieren.Bitte beachten Sie: Massenanforderungen für Erstellungen, Aktualisierungen und Löschungen werden nicht unterstützt, und jede dieser Anforderungsarten ist auf ein Objekt oder eine Aktion beschränkt.

API-Schlüssel generierenBevor Sie mit der Durchführung von API-Anfragen beginnen, ist es wichtig, Ihren API-Schlüssel und Ihr API-Geheimnis zu generieren.Diese Schlüssel sind erforderlich für die Authentifizierung und um die Sicherheit Ihrer Aktionen bei der Interaktion mit unserer API zu gewährleisten.Sie können sowohl den API-Schlüssel als auch das API-Geheimnis im API-Bereich Ihrer Kontoeinstellungen generieren.1. Melden Sie sich bei Ihrem Konto bei Dynadot an.2. Navigieren Sie zu Tools > API.3. Generieren Sie Ihren API-Schlüssel und API-Geheimnis auf dieser Seite.

Treten Sie unserer Community beiHaben Sie Ideen oder Vorschläge? Sprechen Sie direkt mit unseren professionellen Ingenieuren.Discord

HTTP-MethodeDie API verwendet standardisierte HTTP-Methoden, um Operationen an Ressourcen durchzuführen:

Method	Description
GET	GET Request: Retrieve detailed information about a specified resource
POST	POST Request: Create a new resource
PUT	PUT Request: Fully update the specified resource
DELETE	DELETE Request: Remove the specified resource

URL

Die Basis-URL für alle API-Anfragen lautet:https://api.dynadot.com/

Das vollständige URL-Format:Sure! Please provide the text you would like me to translate into German.

https://api.dynadot.com/restful/v1/domains/{domain_name}/search

Sure! Please provide the text you would like me to translate into German.

Die aktuelle Version der API istv

Beim Erstellen der API-Anforderungs-URL ist es nur erforderlich, die Hauptversion anzugeben. Kleinere und Patch-Updates sind so konzipiert, dass sie rückwärtskompatibel sind und keine Änderungen einführen, die Ihren bestehenden Code beeinträchtigen. Dies gewährleistet Stabilität, während Sie von schrittweisen Verbesserungen und Fehlerbehebungen profitieren können, ohne Ihre Implementierung ändern zu müssen.Bei der Veröffentlichung zukünftiger Versionen werden wir die Abwärtskompatibilität für ältere Versionen für einen bestimmten Zeitraum aufrechterhalten. Neue Funktionen und grundlegende Änderungen werden in größeren Versionsinkrementen eingeführt.

HeaderDer Header einer API-Anfrage enthält Metadaten über die Anfrage. Diese Metadaten bieten dem Server den notwendigen Kontext, um die Anfrage korrekt zu verarbeiten. Häufig verwendete Header sind:

Content-TypeGibt das Format der Daten an, die im Anfragekörper gesendet werden. Der Server verwendet diese Informationen, um die Anfrage korrekt zu analysieren. Derzeit ist der einzige akzeptable Wert: application/json

Content-Type: application/json

AkzeptierenInformiert den Server über das Antwortformat, das vom Client erwartet wird.Mögliche Werte: application/json, application/xml

Accept: application/json

AutorisierungAlle API-Anfragen müssen einen API-Schlüssel zur Authentifizierung enthalten. Sie können Ihren API-Schlüssel in Ihrem Kontodashboard abrufen.You can generate an API key in API setting page

Authorization: Bearer YOUR_API_KEY

X-Request-IDDer X-Request-ID-Header ist ein optionaler Header, der verwendet wird, um jede API-Anfrage eindeutig zu identifizieren. Wenn er enthalten ist, hilft dieser Header dabei, Anfragen über Systeme und Protokolle hinweg zu verfolgen und zu korrelieren, was das Debuggen und Überwachen der API-Aktivität erleichtert.Der Wert der X-Request-ID muss eine gültige UUID (Universally Unique Identifier) sein, die dem Standardformat folgt: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (z.B. 123e4567-e89b-12d3-a456-426614174000).

X-Request-ID: 550e8400-e29b-41d4-a716-446655440000

X-SignaturDer X-Signature-Header ist ein obligatorischer Sicherheitsmechanismus für transaktionale Anfragen, einschließlich solcher, die sensible Informationen abrufen oder Daten aktualisieren. Er gewährleistet die Authentizität, Integrität und Nichtabstreitbarkeit von API-Anfragen, indem er von den Clients verlangt, die Anfrageinhalte mit HMAC-SHA256 zu signieren.

Um die Signatur zu generieren, benötigen Sie die folgenden Werte1. API-Schlüssel: Ihr einzigartiger API-Schlüssel.2. Vollständiger Pfad und Abfrage: Der vollständige Pfad des API-Endpunkts zusammen mit den Abfrageparametern.3. X-Request-Id: Die Anforderungs-ID. Wenn sie nicht verfügbar ist, können Sie einen leeren String eingeben.4. Anforderungsinhalt: Der Inhalt der Anfrage. Wenn er leer oder null ist, können Sie einen leeren String eingeben.

Der zu signierende String ist eine Kombination der oben genannten Werte, die in folgender Reihenfolge zusammengefügt werden:

apiKey + "\n" + fullPathAndQuery + "\n" + (xRequestId or empty String) + "\n" + (requestBody or empty String)

apiKey = "your_api_key"
fullPathAndQuery = "/v1/some/endpoint?param=value"
xRequestId = "unique-request-id"
requestBody = "{\"key\":\"value\"}"


stringToSign = "your_api_key\n/v1/some/endpoint?param=value\nunique-request-id\n{\"key\":\"value\"}"

Generieren Sie die HMAC-SHA256-SignaturNachdem Sie die zu signierende Zeichenfolge erstellt haben, müssen Sie die HMAC-SHA256-Verschlüsselung mit Ihrem geheimen Schlüssel anwenden. Dieser Prozess erstellt die Signatur.Die Signatur wird mit den folgenden Schritten erstellt:1. Verwenden Sie den HMAC-SHA256-Algorithmus.Sure! Please provide the text you would like me to translate into German.3. Verwenden Sie das Geheimnis als Schlüssel.
Wenden Sie die generierte signature als Wert von X-Signature im Anfrage-Header an.

X-Signature: {HMAC-SHA256 Signature}

BodyDer Body einer API-Anfrage wird verwendet, um Daten an den Server zu senden. Er wird häufig in POST-, PUT- oder PATCH-Anfragen verwendet (normalerweise nicht bei GET- oder DELETE-Anfragen).

Sure! Please provide the text you would like me to translate into German.Das Format der Bodendaten wird durch den Content-Type-Header bestimmt. Einige gängige Formate sind:

{
    "domainName": "domain.com",
    "showPrice": "yes",
    "currency": "USD"
}

Typische AnwendungsfällePOST-Anfragen: Die POST-Methode wird verwendet, um eine neue Ressource auf dem Server zu erstellen. Der Anfrageinhalt enthält normalerweise die Details der Ressource.PUT-Anfragen: Die PUT-Methode wird verwendet, um eine vorhandene Ressource vollständig zu aktualisieren, indem sie ersetzt wird. Der Anfrageinhalt enthält die vollständig aktualisierte Ressource.GET-Anfragen: Die DELETE-Methode wird verwendet, um eine vorhandene Ressource vom Server zu entfernen. Sie hat keinen Anfragekörper.DELETE-Anfragen: Die GET-Methode wird verwendet, um eine vorhandene Ressource vom Server abzurufen. Sie hat keinen Anfragekörper

Response FormatAlle API-Antworten werden entweder im JSON- oder im XML-Format zurückgegeben, wobei das Format der Bodendaten durch den Accept-Header bestimmt wird. Dies liefert die angeforderten Daten oder, falls zutreffend, eine Fehlermeldung.

Sure! Please provide the text you would like me to translate into German.Sure! Please provide the text you would like me to translate into German.

Code: Der Status der AnfrageNachricht: Weitere Beschreibung des StatusDaten: Der Hauptteil der Antwort

{
    "Code": "200",
    "Message": "Success",
    "Data": {}
}

FehlerbehandlungHTTP-Statuscodes sind standardisierte dreistellige Zahlen, die von einem Server zurückgegeben werden, um das Ergebnis einer Anfrage des Clients anzuzeigen. Sie bieten wichtige Informationen darüber, ob die Anfrage erfolgreich verarbeitet wurde, weitere Maßnahmen erforderlich sind oder ein Fehler aufgetreten ist. Diese Codes sind in fünf Kategorien unterteilt, die jeweils einen bestimmten Antworttyp repräsentieren.Die Statuscodes unserer API entsprechen dem HTTP/1.1-Protokoll, einem weit verbreiteten Standard, der eine konsistente und zuverlässige Kommunikation gewährleistet. Durch die Verwendung von HTTP/1.1 nutzen wir Funktionen wie persistente Verbindungen und verbessertes Caching, um die Interaktionen zwischen Client und Server zu optimieren.

2xx (Erfolgreich): Zeigt an, dass der Befehl empfangen und akzeptiert wurde.

200Der Statuscode zeigt an, dass die Anfrage erfolgreich war.

201Der Statuscode zeigt an, dass die Anfrage erfüllt wurde und zur Erstellung von einem oder mehreren neuen Ressourcen geführt hat.

202Der Statuscode zeigt an, dass die Anfrage zur Bearbeitung angenommen wurde, die Bearbeitung jedoch noch nicht abgeschlossen ist.

249Der Benutzer hat in einem bestimmten Zeitraum zu viele Anfragen gesendet.

4xx (Client-Fehler): Signalisiert, dass der Client einen Fehler in der Anfrage gemacht hat, wie zum Beispiel ungültige Eingaben zu liefern oder die erforderliche Autorisierung zu fehlen.

400Der Statuscode zeigt an, dass der Server die Anfrage aufgrund eines als Clientfehler wahrgenommenen Problems nicht verarbeiten kann oder will.

401Der Statuscode zeigt an, dass die Anfrage nicht ausgeführt wurde, da gültige Authentifizierungsdaten für die Zielressource fehlen.

402Der Statuscode zeigt an, dass die Anfrage aufgrund eines Zahlungsproblems nicht bearbeitet wurde.

403Der Statuscode zeigt an, dass der Server die Anfrage verstanden hat, aber sich weigert, sie auszuführen.

404Der Statuscode zeigt an, dass der Ursprungsserver keine aktuelle Darstellung der Zielressource gefunden hat oder nicht bereit ist, offenzulegen, dass eine solche existiert.

409Die Anfrage konnte aufgrund eines Konflikts mit dem aktuellen Zustand der Ressource nicht abgeschlossen werden.

5xx (Serverfehler): Zeigt an, dass der Server auf einen Fehler gestoßen ist oder die Anfrage nicht erfüllen kann.

500Der Statuscode zeigt an, dass der Server auf eine unerwartete Bedingung gestoßen ist, die ihn daran gehindert hat, die Anfrage zu erfüllen.

501Der Statuscode zeigt an, dass der Server die erforderliche Funktionalität zur Erfüllung der Anfrage nicht unterstützt.

502Der Statuscode zeigt an, dass der Server, während er als Gateway oder Proxy fungierte, eine ungültige Antwort von einem eingehenden Server erhalten hat, auf den er zugegriffen hat, während er versuchte, die Anfrage zu erfüllen.

503Der Statuscode zeigt an, dass der Server derzeit die Anfrage aufgrund einer vorübergehenden Überlastung oder geplanter Wartungsarbeiten nicht bearbeiten kann, was voraussichtlich nach einer gewissen Verzögerung behoben wird.

504Der Statuscode zeigt an, dass der Server, während er als Gateway oder Proxy fungiert, keine rechtzeitige Antwort von einem übergeordneten Server erhalten hat, auf den er zugreifen musste, um die Anfrage abzuschließen.

: Bitte geben Sie den Code ein.Statusname

200Erfolg

201Erstellt

202Akzeptiert

249Zu viele Anfragen

400Ungültige Anfrage

401Unbefugt

402Zahlung erforderlich

403Verboten

404Nicht gefunden

409Konflikt

500Interner Serverfehler

501Nicht implementiert

502Schlechtes Gateway

503Dienst nicht verfügbar

504Gateway-Zeitüberschreitung

RatenbegrenzungAnfragen sollten über https (sichere Verbindung) zur Sicherheit gesendet werden. Es kann jeweils nur 1 Anfrage bearbeitet werden, daher warten Sie bitte, bis Ihre aktuelle Anfrage abgeschlossen ist, bevor Sie eine weitere Anfrage senden.

Sie erhalten unterschiedliche Fadenzahlen basierend auf dem Preisniveau Ihres Kontos:

Price level	Account
Regular	1 thread
Bulk	5 threads
Super Bulk	25 threads

<Response>
  <status>
    <code>429</code>
    <message>Too Many Requests</message>
  </status>
  <error>
    <description>You have reached the maximum allowed requests within the concurrent limit of your account. Please try again later.</description>
  </error>
</Response>

{
  "code": 429,
  "message": "Too Many Requests",
  "error": {
    "description": "You have reached the maximum allowed requests within the concurrent limit of your account. Please try again later."
  }
}

Änderungsprotokoll Übersicht

Ein Änderungsprotokoll ist ein detailliertes Verzeichnis von Änderungen, Verbesserungen, Fehlerbehebungen und neuen Funktionen, die in jeder Version der API eingeführt werden. Es bietet Transparenz für Benutzer und Entwickler, indem es die Auswirkungen jedes Updates dokumentiert. Es besteht aus zwei wesentlichen Teilen:

API-VersionDieser Abschnitt hebt das Versionssystem der API hervor, das Entwicklern hilft, die Entwicklung von Funktionen nachzuvollziehen und die Kompatibilität sicherzustellen. Jede API-Version wird durch eine eindeutige Versionsnummer identifiziert (z. B. v1.0.1, v2.2.3) und stellt einen bedeutenden Meilenstein oder eine Veröffentlichung dar. Die Versionierung ermöglicht es den Nutzern, Integrationen mit minimalen Unterbrechungen aufrechtzuerhalten, indem sie Updates wählen, wenn sie bereit sind.

Änderungsprotokoll VerlaufDer Änderungsprotokollverlauf bietet detaillierte Informationen über Updates, Fehlerbehebungen, Abkündigungen und Verbesserungen, die in jeder Version eingeführt wurden. Er beschreibt spezifische Änderungen an Endpunkten, Parametern, Authentifizierungsmechanismen oder Antwortformaten. Dieser Abschnitt stellt sicher, dass Entwickler vollständige Transparenz darüber haben, was sich geändert hat, und ihre Implementierungen entsprechend anpassen können. Durch die Pflege eines klaren und detaillierten Änderungsprotokolls möchten wir Entwicklern die Werkzeuge und Informationen bereitstellen, die sie benötigen, um Integrationen effektiv und mit Zuversicht zu verwalten.

API-Version

Unsere API befindet sich derzeit in der Versionv

Versionscodes werden verwendet, um API-Updates systematisch zu identifizieren und zu verwalten. Sie folgen dem Format der Semantischen Versionierung (SemVer):

Sure! Please provide the text you would like me to translate into German.Sure! Please provide the text you would like me to translate into German.Sure! Please provide the text you would like me to translate into German.

Jede Komponente des Versionscodes hat einen spezifischen Zweck und hilft Entwicklern, den Umfang und die Art der Änderungen effektiv zu kommunizieren.

HauptversionDefinition: Stellt wesentliche Änderungen dar, die die Abwärtskompatibilität beeinträchtigen können.Of course! Please provide the text you would like me to translate into German.<Major>.x.x

Beispiele:v1.0.0->v2.0.0Eine vollständige API-Neugestaltung oder inkompatible Schemaänderungen.

Kleinere VersionDefinition: Bezeichnet rückwärtskompatible Funktionserweiterungen.Of course! Please provide the text you would like me to translate into German.x.<Minor>.x

Beispiele:v1.0.0->v1.1.0Neue Endpunkte oder Methoden hinzufügen und dabei die Abwärtskompatibilität wahren.

Patch-VersionDefinition: Bezieht sich auf rückwärtskompatible Fehlerbehebungen oder kleinere Verbesserungen.Of course! Please provide the text you would like me to translate into German.x.x.<Patch>

Beispiele:v1.0.0->v1.1.0Einen kleinen Fehler in einem API-Endpunkt beheben.

API Änderungsprotokoll

Ein Änderungsprotokoll ist ein detailliertes Verzeichnis von Änderungen, Verbesserungen, Fehlerbehebungen und neuen Funktionen, die in jeder Version von Software oder einer API eingeführt werden. Es bietet Transparenz für Benutzer und Entwickler, indem es die Auswirkungen jedes Updates dokumentiert.

Ein typischer Eintrag in einem Änderungsprotokoll umfasst:Beschreibung: Eine kurze Erklärung, was geändert wurde.Betroffene Komponenten: Bestimmte Module, Endpunkte oder Funktionen, die von der Änderung betroffen sind.

Beispiel: Unterstützung für diesen neuen API-Befehl hinzugefügtSure! Please provide the text you would like me to translate into German.

Änderungsprotokoll VerlaufVerfolgen Sie jede Änderung an der Dynadot API.