Die DomainStudio Suche erzeugt aus mehreren ausgewählten Quellen eine Liste von Domain-Namen und ergänzt die Suchergebnisse mit weiteren Daten.

Inhalt

Request / Response (JSON)

Schnittstelle: POST /domainstudio

Optional kann für eine leichtere Zuordnung der Ergebnisse zu den Anfragen mit dem Query-Parameter ctid eine eigene ID (myRequestID) mitgeschickt werden.

POST /domainstudio?ctid=myRequestID

Suchanfrage (Request)

Request

{
  "currency": "USD",
  "searchToken": "house",
  "sources": {
    "recommended": {
      "services": ["WHOIS"],
      ...
    },
    ...
  }
}

Für die Erzeugung der Domain-Namen können pro Anfrage mehrere Quellen (sources) angegeben werden.

Bei jeder Quelle kann eine Liste von Services angegeben werden, die für die Ergänzung mit weiteren Domain-Daten verwendet werden sollen.

Antwort (Response)

Response

{
  "stid": "20190702-stid",
  "ctid": "myRequestID",
  "data": [
    {
      "domain": "house.com",
      "source": "RECOMMENDED",
      "services": {
        "whois": ...
      }
    },
    ...
  ]
}

Limit

Standardmäßig können maximal 500 Anfragen pro Tag an die Route POST /domainstudio geschickt werden.

Ist das Limit erreicht, so erscheint folgende Antwort vom System :

{
    "stid": "20200604-app1",
    "messages": [
        {
            "text": "Task limit was reached.",
            "objects": [
                {
                    "type": "string",
                    "value": "domainstudio"
                }
            ],
            "code": "EF00025",
            "status": "ERROR"
        }
    ],
    "status": {
        "type": "ERROR"
    }
}

Quellen

Die Quellen können beliebiig miteinander kombiniert werden.

Initial

Es wird eine Liste von Domain-Namen erstellt, die aus Kombinationen des $searchToken und der $tlds besteht.

Konfiguration

services = Liste der gewünschten Services
tlds = Liste der TLDs für die Erzeugung der Domain-Namen
onlyAvailable = Liefert nur Domains zurück, wenn der Service WHOIS ausgewählt wurde und die Domain als frei markiert ist. Default ist false.

Beispiel

"initial": {
	"services": ["WHOIS", "PRICE", "ESTIMATION"],
	"tlds": ["cz","de","com"],
    "onlyAvailable": false
}

Request

curl -X POST https://api.autodns.com/v1/domainstudio --user 'myuser:mysecretpassword' -H "Content-type: application/json" -H "X-Domainrobot-Context:4" -d  '{
  "searchToken": "hotel",
  "sources": {
    "initial": {
      "services": [
        "WHOIS",
        "ESTIMATION"
      ],
      "tlds": [
        "de",
        "com",
        "net"
      ],
      "max": 3
    }
  }
}'

Response

{
   "stid":"20201027-app1-77194",
   "data":[
      {
         "domain":"hotel.com",
         "idn":"hotel.com",
         "source":"INITIAL",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":292368.56
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotel.net",
         "idn":"hotel.net",
         "source":"INITIAL",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":65084.63
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotel.de",
         "idn":"hotel.de",
         "source":"INITIAL",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":13282.56
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      }
   ]
}

Suggestion

Es wird eine Liste von Domain-Namen über die API eingeholt.

Konfiguration

language = Sprache der Vorschläge
max = maximale Anzahl der Treffer
maxSldLength = maximale Länge der SLD für Ergebnisse
services = Liste der gewünschten Services
useDash = Bindestriche in Domain-Namen erlauben
useIdn = IDN-Vorschläge erlauben
useNumber = Zahlen in Domain-Namen erlauben
tlds = Liste der TLDs, die für Vorschläge verwendet werden soll
onlyAvailable = Liefert nur Domains zurück, falls der Service WHOIS ausgewählt wurde und die Domain als frei markiert ist. Default ist false.

Für das Feld language werden folgende Sprachen unterstützt :

Englisch (eng)
Deutsch (ger)
Spanisch (spa)
Italienisch (ita)
Japanisch (jpn)
Türkisch (tur)
Chinesisch (chi)
Portugiesisch (por)
Französisch (fre)
Koreanisch (kor)

Da die Namensvorschläge unter anderem basierend auf der geographischen Lage der Anfrage generiert werden wird die IP-Adresse der Suchanfrage verwendet. Sollte die IP-Adresse der Suchanfrage nicht der des Endbenutzers entsprechen, so kann diese über den Parameter clientIp angegeben werden.

Beispiel

"suggestion": {
	"language": "ger",
	"max": 5,
	"maxSldLength": 10,
	"services": ["WHOIS", "PRICE", "ESTIMATION"],
	"useDash": true,
	"useIdn": true,
	"useNumber": true,
	"tlds": ["de","com"],
    "onlyAvailable": false
}

Request

curl -X POST https://api.autodns.com/v1/domainstudio --user 'myuser:mysecretpassword' -H "Content-type: application/json" -H "X-Domainrobot-Context:4" -d  '{
  "searchToken": "hotel",
  "sources": {
    "suggestion": {
      "services": [
        "WHOIS",
        "ESTIMATION"
      ],
      "language": "ger",
      "max": 3,
      "maxSldLength": 16,
      "tlds": [
        "de",
        "com",
        "net"
      ],
      "useDash": true,
      "useIdn": true,
      "useNumber": true
    }
  }
}'

Response

{
   "stid":"20201027-app3-98180",
   "data":[
      {
         "domain":"hotelsinzing.com",
         "idn":"hotelsinzing.com",
         "source":"SUGGESTION",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":79.69
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotelreinhausen.com",
         "idn":"hotelreinhausen.com",
         "source":"SUGGESTION",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":65.47
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotelpentling.com",
         "idn":"hotelpentling.com",
         "source":"SUGGESTION",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":25.95
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      }
   ]
}

Premium

Passend zum $searchToken werden Domains aus dem Premiummarket vorgeschlagen.

Konfiguration

max = maximale Anzahl Treffer
services = Liste der gewünschten Services
promoTlds = Liste der TLDs mit der höchsten Priorität
topTlds = Liste der TLDs mit einer höheren Priorität
onlyAvailable = Liefert nur Domains zurück, wenn der Service WHOIS ausgewählt wurde und die Domain als frei markiert ist. Default ist false.

Beispiel

"premium": {
	"max": 5,
	"promoTlds": ["rocks", "shop"],
	"services": ["WHOIS", "PRICE", "ESTIMATION"],
	"topTlds": ["de", "com", "net"],
    "onlyAvailable": false
}

Request

curl -X POST https://api.autodns.com/v1/domainstudio --user 'myuser:mysecretpassword' -H "Content-type: application/json" -H "X-Domainrobot-Context:4" -d  '{
  "searchToken": "hotel",
  "sources": {
    "premium": {
      "services": [
        "WHOIS",
        "ESTIMATION"
      ],
      "max": 3,
      "promoTlds": [
        "rocks",
        "shop"
      ]
    }
  }
}'

Response

{
   "stid":"20201027-app1-77543",
   "data":[
      {
         "domain":"hoteles.shop",
         "idn":"hoteles.shop",
         "source":"PREMIUM",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"PREMIUM"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":1284.99
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hoteljapan.shop",
         "idn":"hoteljapan.shop",
         "source":"PREMIUM",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"PREMIUM"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":467.57
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotelbook.shop",
         "idn":"hotelbook.shop",
         "source":"PREMIUM",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"PREMIUM"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":892.54
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      }
   ]
}

Geo

Für das Land, das durch die IP-Adresse der Suchanfrage ermittelt wurde, werden weitere TLDs generiert. Es wird eine Liste von Domains erstellt, die aus Kombinationen des $searchToken und der ermittelten TLDs bestehen.

Standortabhängige Suchtreffer

Abhängig von der IP-Adresse der Suchanfrage werden weitere landesspezifische TLDs für das "$searchToken" ermittelt. Sollte die IP-Adresse der Suchanfrage nicht der des Endbenutzers entsprechen, so kann diese über den Parameter clientIp angegeben werden. Das System verwendet diese IP-Adresse für die Ermittlung des Landes.

Request

{
  "currency": "USD",
  "searchToken": "house",
  "clientIp": "55.23.87.49",
  "sources": {
    "geo": {
      "services": ["WHOIS"],
      ...
    },
    ...
  }
}

Konfiguration

max = maximale Anzahl Treffer
services = Liste der gewünschten Services
onlyAvailable = Liefert nur Domains zurück, wenn der Service WHOIS ausgewählt wurde und die Domain als frei markiert ist. Default ist false.

Beispiel

"geo": {
	"max": 5,
	"services": ["WHOIS", "PRICE", "ESTIMATION"],
    "onlyAvailable": false
}

Request

curl -X POST https://api.autodns.com/v1/domainstudio --user 'myuser:mysecretpassword' -H "Content-type: application/json" -H "X-Domainrobot-Context:4" -d  '{
  "searchToken": "hotel",
  "sources": {
    "geo": {
      "services": [
        "WHOIS",
        "ESTIMATION"
      ],
      "max": 3
    }
  }
}'

Response

 {
   "stid":"20201027-app2-70645",
   "data":[
      {
         "domain":"hotel.bayern",
         "idn":"hotel.bayern",
         "source":"GEO",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":2454.22
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotel.berlin",
         "idn":"hotel.berlin",
         "source":"GEO",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":3384.17
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotel.hamburg",
         "idn":"hotel.hamburg",
         "source":"GEO",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":42.38
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      }
   ]
}

Similar

Anhand des $searchToken werden ähnlich klingende Domain-Namen generiert.

Konfiguration

max = maximale Anzahl Treffer
services = Liste der gewünschten Services
onlyAvailable = Liefert nur Domains zurück, wenn der Service WHOIS ausgewählt wurde und die Domain als frei markiert ist. Default ist false.

Beispiel

"similar": {
	"max": 5,
	"services": ["WHOIS", "PRICE", "ESTIMATION"],
    "onlyAvailable": false
}

Request

curl -X POST https://api.autodns.com/v1/domainstudio --user 'myuser:mysecretpassword' -H "Content-type: application/json" -H "X-Domainrobot-Context:4" -d  '{
  "searchToken": "hotel",
  "sources": {
    "similar": {
      "services": [
        "WHOIS",
        "ESTIMATION"
      ],
      "max": 3
    }
  }
}'

Response

{
   "stid":"20201026-app3-105361",
   "data":[
      {
         "domain":"ho.tel",
         "idn":"ho.tel",
         "source":"SIMILAR",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":433.07
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      }
   ]
}

{
   "stid":"20201027-app1-78213",
   "data":[
      {
         "domain":"hotel.com",
         "idn":"hotel.com",
         "source":"RECOMMENDED",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":292368.56
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotel.net",
         "idn":"hotel.net",
         "source":"RECOMMENDED",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":65084.63
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotel.shop",
         "idn":"hotel.shop",
         "source":"RECOMMENDED",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"RESERVED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":2795.52
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      }
   ]
}

Custom

Eine selbst definierte Liste von Domain-Namen.

Konfiguration

services = Liste der gewünschten Services
domains = Liste der Domains
onlyAvailable = Liefert nur Domains zurück, wenn der Service WHOIS ausgewählt wurde und die Domain als frei markiert ist. Default ist false.

Beispiel

"custom": {
	"domains": ["domain.de","domain.com"],
	"services": ["WHOIS", "PRICE", "ESTIMATION"],
    "onlyAvailable": false
}

Request

curl --user 'myuser:mysecretpassword' -H "Content-type: application/json" -H "X-Domainrobot-Context:4" -d '{
  "searchToken": "hotel",
  "sources": {
    "custom": {
      "domains": [
        "domain.de",
        "domain.com"
      ],
      "services": [
        "WHOIS",
        "ESTIMATION"
      ]
 		"max": 3
    }
  }
}' 'https://api.autodns.com/v1/domainstudio'

Response

{
   "stid":"20201027-app2-70752",
   "data":[
      {
         "domain":"domain.com",
         "idn":"domain.com",
         "source":"CUSTOM",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":133900.1
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"domain.de",
         "idn":"domain.de",
         "source":"CUSTOM",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":21230.75
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      }
   ]
}

Online Presence

Erstellt eine Liste von Domain-Namen basierend auf Daten einer Online-Präsenz.

Konfiguration

max = maximale Anzahl Treffer
services = Liste der gewünschten Services
maxSldLength = Maximale Länge der Sld.
useDash = Bindestrich im Namen.
tlds = Die gewünschten Tlds.
onlinePresenceUrl = Die Url der Webseite.
onlinePresenceTitle = Der Titel der Webseite.
relatedUrls = Eine Liste dazugehöriger Urls
category = Die Geschäftskategorie. Siehe Liste gültiger Kategorien.
onlinePresenceDescription = Die Beschreibung der Webseite
preferredName = Bevorzugter Name
location = Der Unternehmenssitz
business = Privatperson oder Unternehmen
shortName = Der Spitzname (Nur bei Privatperson)
fullName = Der komplette Name (Nur bei Privatperson)
firstName = Der Vorname (Nur bei Privatperson)
middleNames = Liste von Beinamen (Nur bei Privatperson)
lastName = Der Nachnahme (Nur bei Privatperson)
email = Die Email (Nur bei Privatperson)
hometown = Die Heimatstadt (Nur bei Privatperson)
skills = Eine Liste von Fähigkeiten (Nur bei Privatperson).
onlyAvailable = Liefert nur Domains zurück, wenn der Service WHOIS ausgewählt wurde und die Domain als frei markiert ist. Default ist false.

Beispiel

"onlinePresence": {
	"max": 10,
	"services": ["WHOIS", "PRICE", "ESTIMATION"],
    "maxSldLength": 25,
    "useDash": false,
    "tlds": ["de","com","net"],
    "onlinePresenceUrl": "mybusiness.com",
    "onlinePresenceTitle": "This is my business",
    "relatedUrls": ["mybusiness.de"],
    "category": "Science Technology & Engineering",
    "onlinePresenceDescription": "This is my super important business, founded in 1998, where I do some science and engineering.",
    "location": "Berlin",
    "business": true,
    "onlyAvailable": false
}

Request

curl -X POST https://api.autodns.com/v1/domainstudio --user 'myuser:mysecretpassword' -H "Content-type: application/json" -H "X-Domainrobot-Context:4" -d  '{
  "searchToken": "hotel",
  "sources": {
    "onlinePresence": {
    "max": 3,
    "services": ["WHOIS", "ESTIMATION"],
    "maxSldLength": 25,
    "useDash": false,
    "tlds": ["de","com","net"],
    "onlinePresenceUrl": "mybusiness.com",
    "onlinePresenceTitle": "This is my business",
    "relatedUrls": ["mybusiness.de"],
    "category": "Science Technology & Engineering",
    "onlinePresenceDescription": "This is my super important business, founded in 1998, where I do some science and engineering.",
    "location": "Berlin",
    "business": true
}
  }
}

Response

{
   "stid":"20201027-app4-76625",
   "data":[
      {
         "domain":"sciencethisismybusiness.com",
         "idn":"sciencethisismybusiness.com",
         "source":"SUGGESTION",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":44.73
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"thisismybusiness.de",
         "idn":"thisismybusiness.de",
         "source":"SUGGESTION",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":71.02
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"thisismybusinessscience.com",
         "idn":"thisismybusinessscience.com",
         "source":"SUGGESTION",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":42.08
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      }
   ]
}

Personal Names

Erstellt eine Liste von Domain-Namen basierend auf Namen einer Person.

Konfiguration

max = maximale Anzahl Treffer.
services = Liste der gewünschten Services.
maxSldLength = Maximale Länge der Sld.
useDash = Bindestrich im Namen.
tlds = Die gewünschten Tlds.
useIdn = IDN-Vorschläge erlauben.
firstName = Vorname.
middleNames = Liste von Beinamen.
lastName = Nachname.
useNumber = Zahlen in Domain-Namen erlauben.
spinFirstName = Vornamen durch bekannte Spitznamen tauschen.
onlyAvailable = Liefert nur Domains zurück, falls der Service WHOIS ausgewählt wurde und die Domain als frei markiert ist. Default ist false.

Beispiel

"personalNames": {
    "max": 5,
    "services": ["WHOIS", "PRICE", "ESTIMATION"],
    "maxSldLength": 20,
    "tlds": ["de", "com"],
    "useDash": true,
    "spinFirstName": true,
    "useIdn": true,
    "firstName": "Jon",
    "middleNames": ["Theodor"],
    "lastName": "Doe",
    "useNumber": true,
    "onlyAvailable": false
}

Request

curl -X POST https://api.autodns.com/v1/domainstudio --user 'myuser:mysecretpassword' -H "Content-type: application/json" -H "X-Domainrobot-Context:4" -d  '{
  "sources": {
   "personalNames": {
    "max": 3,
    "services": ["WHOIS", "ESTIMATION"],
    "maxSldLength": 20,
    "tlds": ["de", "com"],
    "useDash": true,
    "spinFirstName": true,
    "useIdn": true,
    "firstName": "Jon",
    "middleNames": ["Theodor"],
    "lastName": "Doe",
    "useNumber": true
}
  }
}'

Response

{
   "stid":"20201027-app1-78499",
   "data":[
      {
         "domain":"jon.de",
         "idn":"jon.de",
         "source":"PERSONAL_NAMES",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"ASSIGNED"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":1676.12
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"doejon.com",
         "idn":"doejon.com",
         "source":"PERSONAL_NAMES",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":143.57
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"jontheodordoe.com",
         "idn":"jontheodordoe.com",
         "source":"PERSONAL_NAMES",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":71.97
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      }
   ]
}

Spinword

Erstellt eine Liste von Domain-Namen indem Wörter innerhalb des Suchbegriffes durch andere Wörter ersetzt werden.

Konfiguration

max = maximale Anzahl Treffer.
services = Liste der gewünschten Services.
maxSldLength = Maximale Länge der Sld.
tlds = Die gewünschten Tlds.
useIdn = IDN-Vorschläge erlauben.
similarity = Gibt an wie ähnlich das getauschte Wort sein soll. Werte zwischen 0.00 und 1.00 möglich. Je höher desto ähnlicher.
language = Sprache der Vorschläge.
position = Die Position des Wortes das getauscht werden soll. Angabe als Integer, angefangen von 0.
onlyAvailable = Liefert nur Domains zurück, wenn der Service WHOIS ausgewählt wurde und die Domain als frei markiert ist. Default ist false.

Für das Feld language werden folgende Sprachen unterstützt :

Englisch (eng)
Deutsch (ger)
Spanisch (spa)
Italienisch (ita)
Japanisch (jpn)
Türkisch (tur)
Chinesisch (chi)
Portugiesisch (por)
Französisch (fre)
Koreanisch (kor)

Beispiel

"spinWord": {
    "max": 5,
    "services": ["WHOIS", "PRICE", "ESTIMATION"],
    "maxSldLength": 20,
    "tlds": ["de","com"],
    "useIdn": true,
    "similarity": 0.5,
    "position": 1,
    "onlyAvailable": false,
    "language": "en",
    "onlyAvailable": false
}

Request

curl -X POST https://api.autodns.com/v1/domainstudio --user 'myuser:mysecretpassword' -H "Content-type: application/json" -H "X-Domainrobot-Context:4" -d  '{
  "searchToken": "hotel,car,apple",
  "sources": {
    "spinWord": {
    "max": 3,
    "services": ["WHOIS", "ESTIMATION"],
    "maxSldLength": 20,
    "tlds": ["de","com"],
    "useIdn": true,
    "similarity": 0.5,
    "position": 1,
    "onlyAvailable": false,
    "language": "en"
}
  }
}'

Response

{
   "stid":"20201027-app2-71007",
   "data":[
      {
         "domain":"hotelvanapple.com",
         "idn":"hotelvanapple.com",
         "source":"SPIN_WORD",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":46.75
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotelcartapple.com",
         "idn":"hotelcartapple.com",
         "source":"SPIN_WORD",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":47.67
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      },
      {
         "domain":"hotelcartapple.de",
         "idn":"hotelcartapple.de",
         "source":"SPIN_WORD",
         "services":{
            "whois":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "status":"FREE"
               }
            },
            "estimation":{
               "debugTime":0,
               "status":"SUCCESS",
               "data":{
                  "currency":"EUR",
                  "amount":48.07
               }
            }
         },
         "forceDnsCheck":false,
         "onlyAvailable":false,
         "isPrereg":false
      }
   ]
}

Services

Die DomainStudio Suche bietet eine Reihe von Services an, mit deren Hilfe weitere Daten zu den Suchergebnissen ermittelt werden können. Die Liste der gewünschten Services kann pro Quelle separat konfiguriert werden.
Die Daten können synchron oder asynchron zugestellt werden, im letzteren Fall wird WebSocket genutzt.
Der Status der Serviceprozesse und die zur Verfügung gestellten Daten werden in folgender Basisstruktur zurückgeliefert:

{
	"status": "SUCCESS",
	"data": {...},
	"message": "Fehlermeldung"
}

Der Status kann die Werte RUNNING, SUCCESS oder FAILED annehmen.

RUNNING = Vearbeitung läuft noch
SUCCESS = Abfrage erfolgreich
FAILED = message enthält eine Fehlermeldung

Zusätzliche Daten werden unter data zur Verfügung gestellt, wobei der Aufbau des Data-Objekte durch die konkreten Services definiert wird.

WhoisService

Führt eine Whois-Abfrage für jede Domain aus.

Der ermittelte Whois-Status kann folgende Werte annehmen: FREE, ASSIGNED, MARKET, PREMIUM, INVALID, ERROR, TIMEOUT

FREE = Die Domain ist frei
ASSIGNED = Die Domain ist zugewiesen
MARKET = Market Domain
PREMIUM = Premium-Domain
INVALID = Ungültiger Domain-Name
ERROR = Whois-Abfrage nicht möglich
TIMEOUT = Timeout

Beispiel für SUCCESS

"whois": {
  "status": "SUCCESS",
  "data": {
    "status": "PREMIUM"
  }
}

Prüfung per DNS

Möchte man die Whois Prüfung anhang einer DNS Prüfung vollziehen so muss der Parameter forceDnsCheck mitgeschickt werden. Standardmäßig werden normale Whois-Abfragen durchgeführt.

{
  "currency": "USD",
  "searchToken": "house",
  "forceDnsCheck": true,
  "sources": {
    "recommended": {
      "services": ["WHOIS"],
      ...
    },
    ...
  }
}

PriceService

Für jede Domain wird der Preis für CREATE / TRANSFER / ORDER und RENEW ermittelt.

Beispiel bei SUCCESS

"price": {
  "status": "SUCCESS",
  "data": {
    "prices": [
      {
        "price": {
          "amount": 35,
          "type": "NET",
          "currency": "EUR"
        },
        "businessCase": "create"
      },
      {
        "price": {
          "amount": 35,
          "type": "NET",
          "currency": "EUR"
        },
        "businessCase": "transfer"
      },
      {
        "price": {
          "amount": 35,
          "type": "NET",
          "currency": "EUR"
        },
        "businessCase": "renew"
      }
    ]
  }
}

PriceEstimationService

Für jede Domain wird eine Preisbewertung erstellt.

Beispiel bei SUCCESS

"estimation": {
  "status": "SUCCESS",
  "data": {
    "amount": 1171.07,
    "currency": "USD"
  }
}

Beispiel für eine vollständige Anfrage und Antwort

Die Sources (Quellen) werden im Abschnitt Quellen erläutert.
Die von den Services bereitgestellten Daten werden im Abschnitt Services erläutert.

Request

{
  "currency": "USD",                                   
  "searchToken": "house",
  "clientIp": "1.2.3.4",
  "sources": {
    "initial": {
      "services": ["WHOIS", "PRICE", "ESTIMATION"],
      "tlds": ["cz","de","com"]
    },
    "suggestion": {
      "language": "ger",                                
      "max": 5,
      "maxSldLength": 10,
      "services": ["WHOIS", "PRICE", "ESTIMATION"],
      "useDash": true,                               
      "useIdn": true,
      "useNumber": true,
      "tlds": ["de","com"]
    },
    "premium": {
      "max": 5,
      "promoTlds": ["rocks", "shop"],               
      "services": ["WHOIS", "PRICE", "ESTIMATION"],
      "topTlds": ["de", "com", "net"]
    },
    "geo": {
      "max": 5,
      "services": ["WHOIS", "PRICE", "ESTIMATION"]
    },
    "similar": {
      "max": 5,
      "services": ["WHOIS", "PRICE", "ESTIMATION"]
    },
    "recommended": { 
      "max": 5, 
      "services": ["WHOIS", "PRICE", "ESTIMATION"] 
    }
  }
}

Response

{
  "stid": "20190702-stid",
  "data": [
    {
      "domain": "ebike.com",
      "source": "RECOMMENDED",
      "services": {
        "whois": {
          "status": "SUCCESS",
          "data": {
            "status": "ASSIGNED"
          }
        },
        "price": {
          "status": "SUCCESS",
          "data": {
            "prices": [
              {
                "price": {
                  "amount": 12.59,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "create"
              },
              {
                "price": {
                  "amount": 12.59,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "transfer"
              },
              {
                "price": {
                  "amount": 12.59,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "renew"
              }
            ]
          }
        }
      }
    },
    {
      "domain": "ebike.de",
      "idn": "ebike.de",
      "source": "INITIAL",
      "services": {
        "whois": {
          "status": "SUCCESS",
          "data": {
            "status": "ASSIGNED"
          }
        },
        "price": {
          "status": "SUCCESS",
          "data": {
            "prices": [
              {
                "price": {
                  "amount": 6.6,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "create"
              },
              {
                "price": {
                  "amount": 6.6,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "transfer"
              },
              {
                "price": {
                  "amount": 6.84,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "order"
              },
              {
                "price": {
                  "amount": 6.6,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "renew"
              }
            ]
          }
        },
        "estimation": {
          "status": "SUCCESS",
          "data": {
            "currency": "USD",
            "amount": 618
          }
        }
      }
    },
    {
      "domain": "e.bike",
      "source": "SIMILAR",
      "services": {
        "whois": {
          "status": "SUCCESS",
          "data": {
            "status": "ASSIGNED"
          }
        },
        "price": {
          "status": "SUCCESS",
          "data": {
            "prices": [
              {
                "price": {
                  "amount": 23,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "create"
              },
              {
                "price": {
                  "amount": 23,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "transfer"
              },
              {
                "price": {
                  "amount": 23,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "renew"
              }
            ]
          }
        }
      }
    },
    {
      "domain": "RadioEBike.com",
      "idn": "radioebike.com",
      "source": "SUGGESTION",
      "services": {
        "whois": {
          "status": "SUCCESS",
          "data": {
            "status": "FREE"
          }
        },
        "price": {
          "status": "SUCCESS",
          "data": {
            "prices": [
              {
                "price": {
                  "amount": 12.59,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "create"
              },
              {
                "price": {
                  "amount": 12.59,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "transfer"
              },
              {
                "price": {
                  "amount": 12.59,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "renew"
              }
            ]
          }
        }
      }
    },
    {
      "domain": "ebike.tickets",
      "source": "PREMIUM",
      "services": {
        "whois": {
          "status": "SUCCESS",
          "data": {
            "status": "PREMIUM"
          }
        },
        "price": {
          "status": "SUCCESS",
          "data": {
            "prices": [
              {
                "price": {
                  "amount": 519,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "create"
              },
              {
                "price": {
                  "amount": 519,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "transfer"
              },
              {
                "price": {
                  "amount": 519,
                  "type": "NET",
                  "currency": "EUR"
                },
                "businessCase": "renew"
              }
            ]
          }
        },
        "estimation": {
          "status": "SUCCESS",
          "data": {
            "currency": "USD",
            "amount": 295
          }
        }
      }
    }
  ]
}

Synchrone und asynchrone Antwort

Synchrone Antworten als Standard

Standardmäßig werden Suchergebnisse synchron zur Verfügung gestellt: die Antwort der Suchanfrage enthält alle ergänzenden Daten zu jedem erzeugten Domain-Namen.

Dauert eine Anfrage länger als der vorgebene Timeout (Vorgabewert 10 Sek.) werden alle noch laufenden Services auf den Status TIMEOUT gesetzt.

Aktivieren der asynchronen Antwort

Mit folgendem Header kann der asynchrone Modus aktiviert werden:

X-Domainrobot-WS : ASYNC

Die initiale Antwort enthält zunächst nur die Liste der generierten Domain-Namen. Sobald die ergänzenden Daten für die einzelnen Domain-Objekte vollständig zur Verfügung stehen, werden sie asynchron einzeln über WebSocket augeliefert. Dies ermöglicht eine rasche Bereitstellung der Domain-Liste, die dann dynamisch mit zusätzlichen Daten befüllt wird.

Im asynchronen Modus ist zwingend die Angabe eine Anfrage-ID mittels Query-Parameter ctid notwendig, um die Antworten den Anfragen zuordnen zu können.

Asynchroner Modus: WebSocket

Im asynchronen Modus werden fertige Ergebnisobjekte über WebSocket verschickt.

Die WebSocket-Verbindung muss zwingend vor dem Abschicken der Suchanfrage vollständig eingerichtet werden.

WebSocket-Verbindung

Voraussetzungen: WebSocket-Unterstützung, STOMP-Client (1.0 oder höher)

URL: wss://api.autodns.com:8443/ws/

Authentifizierung: Hier wird der Cookie verwendet, der über POST /login erstellt wird.

Die Verbindung wird über einen STOMP-Client aufgebaut. Erforderlicher STOMP-Header:

heartbeatIncoming: 0
heartbeatOutgoing: 10000

Nach dem erfolgreichen Verbindungsaufbau wird das Ziel /topic/user abonniert.

Erforderlicher Header:

ack: 'client-individual'
prefetch-count: 100

WebSocket-Nachrichten

Die über WebSocket zugestellten Nachrichten beinhalten dieselben Domain-Objekte, die auch von der synchronen Anfrage zurückgeliefert werden, werden aber nicht in einer vollständigen Liste, sondern einzeln verschickt. Sie befinden sich in einem zusätzlichen Objekt, einem "Umschlag", der die Zuordnung der asynchron ankommenden Nachrichten zur jeweiligen Anfrage ermöglicht.

Beispiel:

Websocket Notification

{
  "type": "DomainStudio",
  "group": "domain",
  "data": {
    "domain": "hello.hamburg",
    "source": "PREMIUM",
    "services": {
      "whois": {
        "debugTime": 0,
        "status": "SUCCESS",
        "data": {
          "status": "PREMIUM"
        }
      },
      "price": {
        "debugTime": 527,
        "status": "SUCCESS",
        "data": {
          "prices": [
            {
              "price": {
                "amount": 35,
                "type": "NET",
                "currency": "EUR"
              },
              "businessCase": "create"
            },
            {
              "price": {
                "amount": 35,
                "type": "NET",
                "currency": "EUR"
              },
              "businessCase": "transfer"
            },
            {
              "price": {
                "amount": 35,
                "type": "NET",
                "currency": "EUR"
              },
              "businessCase": "renew"
            }
          ]
        }
      },
      "estimation": {
        "debugTime": 4906,
        "status": "SUCCESS",
		"data": {
		  "amount": 1171.07,
		  "currency": "USD"
		}
      }
    },
    "debugTime": 4919
  },
  "ctid": "meine-anfrage-03",
  "stid": "20190701-test"
}

Das Suchergebnis befindet sich unter data. Die Werte der Keys stid und ctid sind für alle WebSocket-Nachrichten einer Suchanfrage identisch.

Software Development Kit

Für die Implementierung der DomainStudio Suche stehen verschiedene Software Development Kits (SDKs) zur Verfügung.

Beispiel der Implementierung der DomainStudio Suche mit Java :

DomainStudio Guide

Request / Response (JSON)

Suchanfrage (Request)

Antwort (Response)

Limit

Quellen

Initial

Konfiguration

Beispiel

Suggestion

Konfiguration

Beispiel

Premium

Konfiguration

Beispiel

Geo

Standortabhängige Suchtreffer

Konfiguration

Beispiel

Similar

Konfiguration

Beispiel

Recommended

Konfiguration

Beispiel

Custom

Konfiguration

Beispiel

Online Presence

Konfiguration

Beispiel

Personal Names

Konfiguration

Beispiel

Spinword

Konfiguration

Beispiel

Services

WhoisService

Beispiel für SUCCESS

Prüfung per DNS

PriceService

Beispiel bei SUCCESS

PriceEstimationService

Beispiel bei SUCCESS

Beispiel für eine vollständige Anfrage und Antwort

Synchrone und asynchrone Antwort

Synchrone Antworten als Standard

Aktivieren der asynchronen Antwort

Asynchroner Modus: WebSocket

WebSocket-Verbindung

WebSocket-Nachrichten

Software Development Kit