So legst du per API einen Kontakt an und bereitest ihn vor

Jeder Domainname hat einen Domaininhaber: die Person oder das Unternehmen, dem er gehört. In deinem Konto ist der Domaininhaber einer deiner Kontakte. Mit der Site.de-API kannst du diesen Kontakt mit deinem eigenen Skript anlegen.

Manche Endungen brauchen außerdem zusätzliche Angaben zum Domaininhaber. Für .es ist das zum Beispiel eine Identifikationsnummer. Sobald der Kontakt diese Angaben hat, ist er für diese Endung vorbereitet. Dann kannst du sofort Domainnamen auf diesen Kontakt registrieren.

Du machst das lieber in deinem Dashboard? Lies nach, wie du einen Kontakt für eine Domainendung vorbereitest. Du bist neu bei unserer API? Dann lies zuerst, wie du mit der API startest.

Was du brauchst

Einen API-Schlüssel. Erstelle ihn in deinem Dashboard unter Einstellungen im Tab API-Schlüssel. Setz unter API-Endpunkte einen Haken bei:

• contacts.create: Kontakte anlegen.
• contacts.required_info: die zusätzlichen Angaben für eine Endung prüfen und hinzufügen.
• contacts.view: deine Kontakte sehen und die Endungen, für die sie vorbereitet sind.

Setz deinen API-Schlüssel bei jeder Anfrage in den Header X-API-Key. Schick die Felder als JSON im Body.

Schritt 1: Kontakt anlegen

POST https://backend.site.de/v2/contacts

Schick diese Felder mit:

• first_name und last_name (Pflichtfelder).
• email (Pflichtfeld).
• phone_number (Pflichtfeld): nur Ziffern, ohne + oder 00. Schick die nationale Nummer oder die Ländervorwahl mit der Nummer dahinter, zum Beispiel 31201234567 für eine niederländische Nummer.
• address (Pflichtfeld): mit address_line_first, city, postal_code und country_id. Lass postal_code nur weg, wenn das Land keine Postleitzahlen hat.
• company_name: nur, wenn ein Unternehmen Domaininhaber ist.
• vat_number: optional. Bei EU-Ländern prüfen wir die USt-IdNr. in der VIES-Datenbank der EU.

Die country_id findest du mit GET /v2/countries. Dafür brauchst du keinen API-Schlüssel.

Die Antwort ist der neue Kontakt mit seiner id. Diese ID brauchst du in den nächsten Schritten. Stimmt etwas nicht? Dann bekommst du INPUT_001, mit dem Feld und dem Problem unter fields. Zum Beispiel eine Telefonnummer, die nicht zum Land passt.

Schritt 2: Prüfen, was die Endung braucht

GET https://backend.site.de/v2/tlds/required_info?contact_id=3101&tld=.es

Hier ist 3101 die ID deines Kontakts und .es die Endung. Wir prüfen den Kontakt bei der Registrierungsstelle. Dann bekommst du eine von zwei Antworten:

• Eine leere Liste: Der Kontakt ist für diese Endung vorbereitet. Du musst nichts weiter tun.
• Eine Liste mit required_info: die Angaben, die die Registrierungsstelle noch braucht. Jedes Feld hat seinen Namen, und mandatory sagt, ob du es ausfüllen musst. Manche Felder zeigen auch die Werte, aus denen du wählen kannst (values), oder das Format (regex). Auch eine Nachricht der Registrierungsstelle kann dabei sein.

Die Feldnamen beginnen mit dem Namen der Registrierungsstelle, zum Beispiel Esnic.identificationNumber für .es. Diesen Namen brauchst du im nächsten Schritt: Es ist der Teil vor dem Punkt.

Schritt 3: Angaben hinzufügen

PATCH https://backend.site.de/v2/contacts/3101/required_info

Schick diese Felder mit:

• registry: der Name der Registrierungsstelle, zum Beispiel Esnic.
• tld: die Endung, zum Beispiel .es.
• properties: jedes Feld aus Schritt 2 mit seinem Wert. Verwende die vollständigen Feldnamen, zum Beispiel Esnic.identificationNumber.

Wir prüfen die Angaben bei der Registrierungsstelle. Akzeptiert sie die Angaben? Dann speichern wir sie, und der Kontakt ist vorbereitet. Lehnt sie die Angaben ab? Dann wird nichts gespeichert, und du bekommst INPUT_002 mit den Feldern, die du korrigieren musst.

Manche Endungen brauchen für einige Rollen eine Privatperson als Kontakt, auch wenn ein Unternehmen Domaininhaber ist. Dann enthält die Antwort aus Schritt 2 contact_roles mit person. Schick person zusammen mit den Angaben: "contact_person" nutzt die Kontaktperson des Unternehmens. Oder du schickst die ID eines deiner Kontakte, der eine Privatperson ist.

Schritt 4: Prüfen, ob der Kontakt vorbereitet ist

Mach Schritt 2 noch einmal. Ist die Liste leer? Dann ist der Kontakt vorbereitet. Du siehst es auch mit GET /v2/contacts: ready_tlds listet jede Endung auf, für die der Kontakt vorbereitet ist.

Jetzt kannst du einen Domainnamen mit diesem Kontakt als Domaininhaber registrieren. Schick dazu seine ID als contact_id mit. Lies nach, wie du Domainnamen mit der API bestellst.

Gut zu wissen

• Du kannst die Angaben auch mit einer Bestellung mitschicken. Registriere oder übertrage einen Domainnamen und füge die Angaben als required_info hinzu. Wir prüfen sie und speichern sie beim Kontakt.
• Passt der Kontakt nicht zur Endung? Manche Endungen akzeptieren nur ein Unternehmen oder nur eine Privatperson. Dann bekommst du REG_006. Nimm einen anderen Kontakt.
• Du bekommst REG_005? Dann hat der Kontakt schon alle Angaben für diese Endung.
• Nicht jede Endung braucht zusätzliche Angaben. Bei .com zum Beispiel liefert die Prüfung aus Schritt 2 meistens sofort eine leere Liste.

Brauchst du Hilfe? Melde dich bei uns per WhatsApp, Telegram oder E-Mail.