REST API – Domain-Kontakte

GET /contacts/check

Prüft, ob ein Kontakt-Handle frei verwendbar ist und welchen Status es bei der Registry hat.

Parameter:

• tld – erforderlich, Query, String – TLD, für die der Kontakt geprüft wird
• cname – erforderlich, Query, String – Handle (Kennung) des Kontakts
• reg_key – optional, Query, String – Kennung einer konkreten Registry (wenn die TLD mehrere Registries/Modi unterstützt)

Rückgabecodes:

• 1000 – der Kontakt ist frei und verwendbar
• 2201 – ungültige TLD
• 2216 – ungültiges Format der Kontaktkennung
• 2218 – Kontakte werden bei dieser Registry automatisch erzeugt (Sie können das Handle nicht wählen)
• 3228 – die Registry unterstützt keine Kontakte
• 3231 – der Kontakt existiert bereits
• 3233 – der Kontakt kann nicht verwendet werden
• 3234 – der Kontakt kann nicht verwendet werden – Quarantäne
• 3235 – der Kontakt kann nicht verwendet werden – reserviert
• 3236 – der Kontakt kann nicht verwendet werden – gesperrt
• 3237 – der Kontakt ist bereits bei uns registriert
• 4211 – Prüfung des Kontakts fehlgeschlagen – Verbindungsfehler

Antwortdaten: Keine – das Ergebnis liefert direkt die Antwort in den Feldern code/msg.

Beispiel:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/contacts/check?tld=eu&cname=CONTACT'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f1"
}

GET /contacts/{cname}

Gibt detaillierte Informationen zu einem Kontakt zurück.

Parameter:

• cname – erforderlich, Pfad – Handle des Kontakts
• tld – erforderlich, Query, String – TLD, unter der der Kontakt gesucht wird
• auth_info – optional, Query, String – Autorisierungscode des Kontakts (wird er angegeben, muss er mit dem am Objekt gesetzten Code übereinstimmen, sonst wird ein Fehler zurückgegeben)
• reg_key – optional, Query, String – Kennung einer konkreten Registry

Rückgabecodes:

• 1000 – OK
• 2201 – falsch angegebene TLD
• 2216 – Syntaxfehler der Kontaktkennung
• 3215 – ungültiger Autorisierungscode (angegeben und stimmt nicht überein)
• 3228 – die Registry unterstützt keine Kontakte
• 3229 – Fehler beim Laden des Kontakts
• 3236 – der Kontakt ist gesperrt
• 4212 – Verbindungsfehler
• 5001 – es ist niemand angemeldet

Antwortdaten:

• contact – Objekt mit den Kontaktdaten:
  • contact_id, roid, status – Kennung, ROID und Status des Kontakts bei der Registry
  • name, fname, lname, company – Name/Vorname/Nachname bzw. Firmenname
  • addr_street, addr_city, addr_zip, addr_state, addr_country – Adresse
  • phone, fax, email, email2 – Kontaktangaben
  • ic, dic, taxpayer – Firmenidentifikationsnummer (IČ), Steuernummer (DIČ), Status als Umsatzsteuerzahler
  • reg_owner, reg_creator, reg_update – Kennungen des Registrars
  • created_date, updated_date, transfer_date – Datum der Erstellung/Aktualisierung/des Transfers
  • disclose – Einstellung der Veröffentlichung von Daten (je Registry)
  • other – weitere registryspezifische Daten

Beispiel:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/contacts/CONTACT?tld=eu'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f2",
  "data": {
    "contact": {
      "contact_id": "CONTACT",
      "status": "ok",
      "fname": "Esmeralda",
      "lname": "Excavadora",
      "company": null,
      "addr_street": "Street 123",
      "addr_city": "City",
      "addr_zip": "11000",
      "addr_country": "CZ",
      "phone": "+420.777123456",
      "email": "esmeralda@wedos.com",
      "created_date": "2024-01-10",
      "updated_date": null
    }
  }
}

POST /contacts/create

Legt einen neuen Domain-Kontakt für die angegebene TLD an.

Parameter:

• tld – erforderlich, String – TLD, für die der Kontakt angelegt wird
• reg_key – optional, String – Kennung einer konkreten Registry
• contact – erforderlich, Objekt – Kontaktdaten; die verfügbaren Felder unterscheiden sich je nach Registry, typischerweise:
  • cname (optional) – gewünschtes Handle des Kontakts; lassen Sie es bei Registries weg, die Handles automatisch erzeugen
  • fname, lname – Vor- und Nachname (bei einer natürlichen Person)
  • company – Firmenname (bei einer juristischen Person)
  • addr_street, addr_city, addr_zip, addr_state, addr_country – Adresse
  • phone, fax, email, email2 – Kontaktangaben
  • ic, dic, taxpayer – Firmenidentifikationsnummer (IČ), Steuernummer (DIČ), Status als Umsatzsteuerzahler
  • weitere Elemente je nach konkreter Registry

Rückgabecodes:

• 1000 – Kontakt angelegt
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültige Eingabeparameter
• 2201 – ungültige TLD
• 2216 – ungültiger Name des Kontakts
• 2218 – Kontaktnamen werden bei dieser Registry automatisch erzeugt (Sie können keinen eigenen angeben)
• 2219–2242 – einzelne Elemente des Kontakts fehlen oder haben ein ungültiges Format (Firma, Vorname, Nachname, E-Mail, Telefon, Fax, Firmenidentifikationsnummer, Steuernummer, Adresse, Region, weitere Daten)
• 3228 – die Registry unterstützt keine Kontakte
• 3230 – Anlegen des Kontakts fehlgeschlagen
• 3231 – der Name des Kontakts wird bereits verwendet
• 3233 – der Kontakt kann nicht verwendet werden
• 3234 – der Kontakt kann nicht verwendet werden – Quarantäne
• 3236 – der Kontakt kann nicht verwendet werden – gesperrt
• 3237 – der Kontakt ist bereits bei uns registriert
• 4211 – Prüfung fehlgeschlagen – Kommunikationsfehler
• 4213 – Anlegen des Kontakts fehlgeschlagen – Kommunikationsfehler

Antwortdaten:

• cname – Handle des angelegten Kontakts

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/create' \
  --data '{
    "tld": "eu",
    "contact": {
      "fname": "Esmeralda",
      "lname": "Excavadora",
      "addr_street": "Street 123",
      "addr_city": "City",
      "addr_zip": "11000",
      "addr_country": "CZ",
      "email": "esmeralda@wedos.com",
      "phone": "+420.777123456"
    }
  }'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f3",
  "data": {
    "cname": "CONTACT"
  }
}

POST /contacts/{cname}/transfer

Transferiert einen Kontakt von einem anderen Registrar zu uns (nur bei Registries, die den Transfer von Kontakten unterstützen, z. B. CZ.NIC).

Parameter:

• cname – erforderlich, Pfad – Handle des Kontakts
• tld – erforderlich, String – TLD
• auth_info – erforderlich, String – Autorisierungscode des Kontakts
• reg_key – optional, String – Kennung einer konkreten Registry

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültige Eingabeparameter
• 2201 – ungültige TLD
• 2215 – Parameter auth_info fehlt
• 2216 – ungültige Kennung des Kontakts
• 2244 – diese Domain/Registry unterstützt den Transfer von Kontakten nicht
• 3229 – der Kontakt ist nicht verfügbar
• 3237 – der Kontakt ist bereits bei uns registriert
• 3240 – Autorisierungsfehler
• 3241 – Transfer fehlgeschlagen
• 4216 – Transfer fehlgeschlagen – Verbindungsfehler

Antwortdaten: Keine – das Ergebnis liefert direkt die Antwort in den Feldern code/msg.

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/CONTACT/transfer' \
  --data '{"tld": "cz", "auth_info": "AUTHCODE123"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f4"
}

POST /contacts/{cname}/auth-info/send

Sendet den Autorisierungscode des Kontakts an dessen Kontakt-E-Mail-Adresse.

Parameter:

• cname – erforderlich, Pfad – Handle des Kontakts
• tld – erforderlich, String – TLD
• reg_key – optional, String – Kennung einer konkreten Registry

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültige Eingabeparameter
• 2201 – ungültige TLD
• 2216 – ungültiger Name des Kontakts
• 2243 – das Senden des Autorisierungscodes ist für diesen Kontakt nicht erlaubt
• 3213 – der Kontakt ist nicht verfügbar
• 3215 – das Senden des Codes ist fehlgeschlagen
• 3228 – die Registry unterstützt keine Kontakte
• 4217 – Senden fehlgeschlagen – Kommunikationsfehler
• 5001 – Authentifizierungsfehler

Antwortdaten: Keine – das Ergebnis liefert direkt die Antwort in den Feldern code/msg.

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/CONTACT/auth-info/send' \
  --data '{"tld": "eu"}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f5"
}

PATCH /contacts/{cname}

Ändert die Daten eines bestehenden Kontakts. Kann bei Registries, bei denen Kontakte nicht bearbeitbar sind (z. B. Ascio), nicht verwendet werden.

Parameter:

• cname – erforderlich, Pfad – Handle des Kontakts
• tld – erforderlich, String – TLD
• auth_info – optional, String – Autorisierungscode des Kontakts
• contact – erforderlich, Objekt – zu ändernde Kontaktdaten (dieselben Felder wie bei POST /contacts/create; geändert werden nur die angegebenen Felder)
• reg_key – optional, String – Kennung einer konkreten Registry

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültige Eingabeparameter
• 2201 – ungültige TLD
• 2207 – Syntaxfehler
• 2216 – ungültiger Name des Kontakts
• 2219–2241 – einzelne geänderte Elemente fehlen oder haben ein ungültiges Format (gleicher Umfang wie beim Anlegen eines Kontakts)
• 3211 – der Kontakt konnte nicht geladen werden
• 3238 – Autorisierungsfehler
• 3239 – Änderung fehlgeschlagen
• 4202 – Kontakt nicht verfügbar – Verbindungsfehler
• 4215 – Ausführung fehlgeschlagen – Verbindungsfehler

Antwortdaten: Keine – das Ergebnis liefert direkt die Antwort in den Feldern code/msg.

Beispiel:

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/contacts/CONTACT' \
  --data '{"tld": "eu", "contact": {"email": "esmeralda-new@wedos.com"}}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3f6"
}