API: Domain: Unterschied zwischen den Versionen
(Die Seite wurde neu angelegt: „Die Domain-API ermöglicht es Ihnen, von externen Systemen die Domain-Verwaltung anzusprechen. So sind alle gängigen Aktionen möglich - teilweise sogar in Ec…“) |
|||
| (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 Domain-API ermöglicht es Ihnen, von externen Systemen die Domain-Verwaltung anzusprechen. So sind alle gängigen Aktionen möglich - teilweise sogar in Echtzeit bei der Registrierungsstelle. | Die Domain-API ermöglicht es Ihnen, von externen Systemen die Domain-Verwaltung anzusprechen. So sind alle gängigen Aktionen möglich - teilweise sogar in Echtzeit bei der Registrierungsstelle. | ||
== Auflisten == | == Auflisten == | ||
| − | ... | + | Sie können die Domains Ihres Kontos mit dem API-Kommando domain/list auflisten. Hierbei kann optional ein Parameter "domain" per GET oder POST übergeben werden, der nach einer Domain oder einem Teil von einer Domain sucht bzw. filtert. |
| + | |||
| + | Das zurückgegebene data-Array enthält für jede Domain ein Array mit detaillierten Domain-Informationen. | ||
== Registrieren == | == Registrieren == | ||
| − | .. | + | Für das Registrieren einer neuen Domain ist das Kommando domain/register zuständig. '''Diese Aktion ist kostenpflichtig.''' Es erwartet folgende Parameter: |
| − | == | + | * domain - vollständige Domain |
| − | ... | + | |
| + | * owner_firstname - Vorname des Domaininhabers | ||
| + | * owner_lastname - Nachname des Domaininhabers | ||
| + | * owner_company - Firma des Domaininhabers (optional) | ||
| + | * owner_street - Anschrift des Domaininhabers | ||
| + | * owner_country - Land des Domaininhabers (als zweistelliger Ländercode, zum Beispiel DE) | ||
| + | * owner_postcode - Postleitzahl des Domaininhabers | ||
| + | * owner_city - Stadt des Domaininhabers | ||
| + | * owner_telephone - Telefonnummer des Domaininhabers | ||
| + | * owner_telefax - Faxnummer des Domaininhabers (optional) | ||
| + | * owner_email - E-Mailadresse des Domaininhabers | ||
| + | |||
| + | * ns1 - Nameserver #1 | ||
| + | * ns2 - Nameserver #2 | ||
| + | * ns3 - Nameserver #3 (optional) | ||
| + | * ns4 - Nameserver #4 (optional) | ||
| + | * ns5 - Nameserver #5 (optional) | ||
| + | * ip - IPv4-Adresse für DNS-Zone (nur erforderlich, wenn DNS-Server vom Anbieter verwendet sollen und ns1 sowie ns2 diesen entsprechen) | ||
| + | |||
| + | * async - Nur setzen (Wert: 1), wenn Aktion im Hintergrund asynchron ausgeführt werden soll (kürzere Antwortzeiten) | ||
| + | |||
| + | Die Parameter für den Owner-C müssen auch für den Admin-C (admin_*) gesetzt werden. Sofern Ihr Konto für die Verwendung von eigenen Tech-C und Zone-C Handles zugelassen ist, können Sie auch zone_* und tech_* setzen. Werden diese nicht gesetzt, werden die Werte vom Anbieter genommen. | ||
| + | |||
| + | == Transferieren == | ||
| + | Für das Transferieren einer bestehenden Domain ist das Kommando domain/transfer zuständig. '''Diese Aktion ist kostenpflichtig, sofern kein interner Transfer vorgenommen wird.''' Es erwartet folgende Parameter: | ||
| + | |||
| + | * domain - vollständige Domain | ||
| + | |||
| + | * owner_firstname - Vorname des Domaininhabers | ||
| + | * owner_lastname - Nachname des Domaininhabers | ||
| + | * owner_company - Firma des Domaininhabers (optional) | ||
| + | * owner_street - Anschrift des Domaininhabers | ||
| + | * owner_country - Land des Domaininhabers (als zweistelliger Ländercode, zum Beispiel DE) | ||
| + | * owner_postcode - Postleitzahl des Domaininhabers | ||
| + | * owner_city - Stadt des Domaininhabers | ||
| + | * owner_telephone - Telefonnummer des Domaininhabers | ||
| + | * owner_telefax - Faxnummer des Domaininhabers (optional) | ||
| + | * owner_email - E-Mailadresse des Domaininhabers | ||
| + | |||
| + | * ns1 - Nameserver #1 | ||
| + | * ns2 - Nameserver #2 | ||
| + | * ns3 - Nameserver #3 (optional) | ||
| + | * ns4 - Nameserver #4 (optional) | ||
| + | * ns5 - Nameserver #5 (optional) | ||
| + | * ip - IPv4-Adresse für DNS-Zone (nur erforderlich, wenn DNS-Server vom Anbieter verwendet sollen und ns1 sowie ns2 diesen entsprechen) | ||
| + | |||
| + | * password - Authcode für den Domain-Umzug | ||
| + | |||
| + | * async - Nur setzen (Wert: 1), wenn Aktion im Hintergrund asynchron ausgeführt werden soll (kürzere Antwortzeiten) | ||
| + | |||
| + | Die Parameter für den Owner-C müssen auch für den Admin-C (admin_*) gesetzt werden. Sofern Ihr Konto für die Verwendung von eigenen Tech-C und Zone-C Handles zugelassen ist, können Sie auch zone_* und tech_* setzen. Werden diese nicht gesetzt, werden die Werte vom Anbieter genommen. | ||
== Bearbeiten == | == Bearbeiten == | ||
| − | ... | + | Über das Kommando domain/modify lassen sich bereits bei uns bestehende Domains bearbeiten. Es erwartet folgende Parameter: |
| + | |||
| + | * domain - vollständige Domain | ||
| + | |||
| + | * owner_firstname - Vorname des Domaininhabers | ||
| + | * owner_lastname - Nachname des Domaininhabers | ||
| + | * owner_company - Firma des Domaininhabers (optional) | ||
| + | * owner_street - Anschrift des Domaininhabers | ||
| + | * owner_country - Land des Domaininhabers (als zweistelliger Ländercode, zum Beispiel DE) | ||
| + | * owner_postcode - Postleitzahl des Domaininhabers | ||
| + | * owner_city - Stadt des Domaininhabers | ||
| + | * owner_telephone - Telefonnummer des Domaininhabers | ||
| + | * owner_telefax - Faxnummer des Domaininhabers (optional) | ||
| + | * owner_email - E-Mailadresse des Domaininhabers | ||
| + | |||
| + | * ns1 - Nameserver #1 | ||
| + | * ns2 - Nameserver #2 | ||
| + | * ns3 - Nameserver #3 (optional) | ||
| + | * ns4 - Nameserver #4 (optional) | ||
| + | * ns5 - Nameserver #5 (optional) | ||
| + | * ip - IPv4-Adresse für DNS-Zone (nur erforderlich, wenn DNS-Server vom Anbieter verwendet sollen und ns1 sowie ns2 diesen entsprechen) | ||
| + | |||
| + | * transfer_lock - Gibt an, ob die Domain wegtransferiert werden kann (0 = ja, 1 = nein) | ||
| + | * auto_renew - Gibt an, ob die Domain automatisch verlängert wird (0 = nein, 1 = ja - setzt ausreichendes Guthaben zum Zeitpunkt der anstehenden Verlängerung voraus) | ||
| + | |||
| + | * async - Nur setzen (Wert: 1), wenn Aktion im Hintergrund asynchron ausgeführt werden soll (kürzere Antwortzeiten) | ||
| + | |||
| + | Die Parameter für den Owner-C müssen auch für den Admin-C (admin_*) gesetzt werden. Sofern Ihr Konto für die Verwendung von eigenen Tech-C und Zone-C Handles zugelassen ist, können Sie auch zone_* und tech_* setzen. Werden diese nicht gesetzt, werden die Werte vom Anbieter genommen. | ||
== Inhaberwechsel / Trade == | == Inhaberwechsel / Trade == | ||
| − | ... | + | Bei manchen Domain-Registrierungsstellen ist der Inhaberwechsel einer Domain kostenpflichtig. Mit dem Kommando domain/trade lassen sich die Domain-Daten dann ändern, nicht aber mit domain/modify. '''Diese Aktion ist kostenpflichtig.''' Erwartet werden folgende Parameter: |
| + | |||
| + | * domain - vollständige Domain | ||
| + | |||
| + | * owner_firstname - Vorname des Domaininhabers | ||
| + | * owner_lastname - Nachname des Domaininhabers | ||
| + | * owner_company - Firma des Domaininhabers (optional) | ||
| + | * owner_street - Anschrift des Domaininhabers | ||
| + | * owner_country - Land des Domaininhabers (als zweistelliger Ländercode, zum Beispiel DE) | ||
| + | * owner_postcode - Postleitzahl des Domaininhabers | ||
| + | * owner_city - Stadt des Domaininhabers | ||
| + | * owner_telephone - Telefonnummer des Domaininhabers | ||
| + | * owner_telefax - Faxnummer des Domaininhabers (optional) | ||
| + | * owner_email - E-Mailadresse des Domaininhabers | ||
| + | |||
| + | * async - Nur setzen (Wert: 1), wenn Aktion im Hintergrund asynchron ausgeführt werden soll (kürzere Antwortzeiten) | ||
| + | |||
| + | Die Parameter für den Owner-C müssen auch für den Admin-C (admin_*) gesetzt werden. Sofern Ihr Konto für die Verwendung von eigenen Tech-C und Zone-C Handles zugelassen ist, können Sie auch zone_* und tech_* setzen. Werden diese nicht gesetzt, werden die Werte vom Anbieter genommen. | ||
== Authcode anfordern == | == Authcode anfordern == | ||
| − | . | + | Die Aktion domain/password erwartet nur die Angabe des Parameters "domain" (vollständiger Domainname) und gibt im data-Array den Wert "code" zurück. Dies ist der Authcode Ihrer Domain. |
| − | == Rückgabe / Transit == | + | == Löschung / Rückgabe == |
| − | ... | + | Die Aktion domain/delete erwartet nur die Angabe der Parameter "domain" (vollständiger Domainname) und "type". Der "type"-Parameter beschreibt, ob die Domain gelöscht (type = 0) oder in den Transit (dekonnektiert: type = 2 / konnektiert: type = 1) gegeben werden soll. Bei einem Transit wird keine Haftung dafür übernommen, ob dieser wirklich wie gewünscht (de-)konnektiert vorgenommen werden kann. Diese Aktion ist nicht ohne Weiteres widerrufbar. |
Aktuelle Version vom 13. Januar 2019, 17:30 Uhr
Die Domain-API ermöglicht es Ihnen, von externen Systemen die Domain-Verwaltung anzusprechen. So sind alle gängigen Aktionen möglich - teilweise sogar in Echtzeit bei der Registrierungsstelle.
Inhaltsverzeichnis
Auflisten
Sie können die Domains Ihres Kontos mit dem API-Kommando domain/list auflisten. Hierbei kann optional ein Parameter "domain" per GET oder POST übergeben werden, der nach einer Domain oder einem Teil von einer Domain sucht bzw. filtert.
Das zurückgegebene data-Array enthält für jede Domain ein Array mit detaillierten Domain-Informationen.
Registrieren
Für das Registrieren einer neuen Domain ist das Kommando domain/register zuständig. Diese Aktion ist kostenpflichtig. Es erwartet folgende Parameter:
- domain - vollständige Domain
- owner_firstname - Vorname des Domaininhabers
- owner_lastname - Nachname des Domaininhabers
- owner_company - Firma des Domaininhabers (optional)
- owner_street - Anschrift des Domaininhabers
- owner_country - Land des Domaininhabers (als zweistelliger Ländercode, zum Beispiel DE)
- owner_postcode - Postleitzahl des Domaininhabers
- owner_city - Stadt des Domaininhabers
- owner_telephone - Telefonnummer des Domaininhabers
- owner_telefax - Faxnummer des Domaininhabers (optional)
- owner_email - E-Mailadresse des Domaininhabers
- ns1 - Nameserver #1
- ns2 - Nameserver #2
- ns3 - Nameserver #3 (optional)
- ns4 - Nameserver #4 (optional)
- ns5 - Nameserver #5 (optional)
- ip - IPv4-Adresse für DNS-Zone (nur erforderlich, wenn DNS-Server vom Anbieter verwendet sollen und ns1 sowie ns2 diesen entsprechen)
- async - Nur setzen (Wert: 1), wenn Aktion im Hintergrund asynchron ausgeführt werden soll (kürzere Antwortzeiten)
Die Parameter für den Owner-C müssen auch für den Admin-C (admin_*) gesetzt werden. Sofern Ihr Konto für die Verwendung von eigenen Tech-C und Zone-C Handles zugelassen ist, können Sie auch zone_* und tech_* setzen. Werden diese nicht gesetzt, werden die Werte vom Anbieter genommen.
Transferieren
Für das Transferieren einer bestehenden Domain ist das Kommando domain/transfer zuständig. Diese Aktion ist kostenpflichtig, sofern kein interner Transfer vorgenommen wird. Es erwartet folgende Parameter:
- domain - vollständige Domain
- owner_firstname - Vorname des Domaininhabers
- owner_lastname - Nachname des Domaininhabers
- owner_company - Firma des Domaininhabers (optional)
- owner_street - Anschrift des Domaininhabers
- owner_country - Land des Domaininhabers (als zweistelliger Ländercode, zum Beispiel DE)
- owner_postcode - Postleitzahl des Domaininhabers
- owner_city - Stadt des Domaininhabers
- owner_telephone - Telefonnummer des Domaininhabers
- owner_telefax - Faxnummer des Domaininhabers (optional)
- owner_email - E-Mailadresse des Domaininhabers
- ns1 - Nameserver #1
- ns2 - Nameserver #2
- ns3 - Nameserver #3 (optional)
- ns4 - Nameserver #4 (optional)
- ns5 - Nameserver #5 (optional)
- ip - IPv4-Adresse für DNS-Zone (nur erforderlich, wenn DNS-Server vom Anbieter verwendet sollen und ns1 sowie ns2 diesen entsprechen)
- password - Authcode für den Domain-Umzug
- async - Nur setzen (Wert: 1), wenn Aktion im Hintergrund asynchron ausgeführt werden soll (kürzere Antwortzeiten)
Die Parameter für den Owner-C müssen auch für den Admin-C (admin_*) gesetzt werden. Sofern Ihr Konto für die Verwendung von eigenen Tech-C und Zone-C Handles zugelassen ist, können Sie auch zone_* und tech_* setzen. Werden diese nicht gesetzt, werden die Werte vom Anbieter genommen.
Bearbeiten
Über das Kommando domain/modify lassen sich bereits bei uns bestehende Domains bearbeiten. Es erwartet folgende Parameter:
- domain - vollständige Domain
- owner_firstname - Vorname des Domaininhabers
- owner_lastname - Nachname des Domaininhabers
- owner_company - Firma des Domaininhabers (optional)
- owner_street - Anschrift des Domaininhabers
- owner_country - Land des Domaininhabers (als zweistelliger Ländercode, zum Beispiel DE)
- owner_postcode - Postleitzahl des Domaininhabers
- owner_city - Stadt des Domaininhabers
- owner_telephone - Telefonnummer des Domaininhabers
- owner_telefax - Faxnummer des Domaininhabers (optional)
- owner_email - E-Mailadresse des Domaininhabers
- ns1 - Nameserver #1
- ns2 - Nameserver #2
- ns3 - Nameserver #3 (optional)
- ns4 - Nameserver #4 (optional)
- ns5 - Nameserver #5 (optional)
- ip - IPv4-Adresse für DNS-Zone (nur erforderlich, wenn DNS-Server vom Anbieter verwendet sollen und ns1 sowie ns2 diesen entsprechen)
- transfer_lock - Gibt an, ob die Domain wegtransferiert werden kann (0 = ja, 1 = nein)
- auto_renew - Gibt an, ob die Domain automatisch verlängert wird (0 = nein, 1 = ja - setzt ausreichendes Guthaben zum Zeitpunkt der anstehenden Verlängerung voraus)
- async - Nur setzen (Wert: 1), wenn Aktion im Hintergrund asynchron ausgeführt werden soll (kürzere Antwortzeiten)
Die Parameter für den Owner-C müssen auch für den Admin-C (admin_*) gesetzt werden. Sofern Ihr Konto für die Verwendung von eigenen Tech-C und Zone-C Handles zugelassen ist, können Sie auch zone_* und tech_* setzen. Werden diese nicht gesetzt, werden die Werte vom Anbieter genommen.
Inhaberwechsel / Trade
Bei manchen Domain-Registrierungsstellen ist der Inhaberwechsel einer Domain kostenpflichtig. Mit dem Kommando domain/trade lassen sich die Domain-Daten dann ändern, nicht aber mit domain/modify. Diese Aktion ist kostenpflichtig. Erwartet werden folgende Parameter:
- domain - vollständige Domain
- owner_firstname - Vorname des Domaininhabers
- owner_lastname - Nachname des Domaininhabers
- owner_company - Firma des Domaininhabers (optional)
- owner_street - Anschrift des Domaininhabers
- owner_country - Land des Domaininhabers (als zweistelliger Ländercode, zum Beispiel DE)
- owner_postcode - Postleitzahl des Domaininhabers
- owner_city - Stadt des Domaininhabers
- owner_telephone - Telefonnummer des Domaininhabers
- owner_telefax - Faxnummer des Domaininhabers (optional)
- owner_email - E-Mailadresse des Domaininhabers
- async - Nur setzen (Wert: 1), wenn Aktion im Hintergrund asynchron ausgeführt werden soll (kürzere Antwortzeiten)
Die Parameter für den Owner-C müssen auch für den Admin-C (admin_*) gesetzt werden. Sofern Ihr Konto für die Verwendung von eigenen Tech-C und Zone-C Handles zugelassen ist, können Sie auch zone_* und tech_* setzen. Werden diese nicht gesetzt, werden die Werte vom Anbieter genommen.
Authcode anfordern
Die Aktion domain/password erwartet nur die Angabe des Parameters "domain" (vollständiger Domainname) und gibt im data-Array den Wert "code" zurück. Dies ist der Authcode Ihrer Domain.
Löschung / Rückgabe
Die Aktion domain/delete erwartet nur die Angabe der Parameter "domain" (vollständiger Domainname) und "type". Der "type"-Parameter beschreibt, ob die Domain gelöscht (type = 0) oder in den Transit (dekonnektiert: type = 2 / konnektiert: type = 1) gegeben werden soll. Bei einem Transit wird keine Haftung dafür übernommen, ob dieser wirklich wie gewünscht (de-)konnektiert vorgenommen werden kann. Diese Aktion ist nicht ohne Weiteres widerrufbar.
