Instructions for the complete automation of the registration of a domain, using the example of the domain example.com.
.com is a generic top-level domain, which is well suited for the first implementation due to the lack of restrictions.

Panel

titleColor	#FFFFFF
titleBGColor	#E44313
title	Table of contents

Table of Contents

maxLevel	4
outline	true
style	none

Basics of the JSON and XML API

All important information for the use of the JSON and XML API you can find in the General API Basics and the XML API Basics and JSON API Basics.

Process overview

Flow chart

Task names, codes and routes

Task	Code	Route
ContactCreate	0301	POST /contact
DomainCreate	0101	POST /domain
PollInfo	0905	GET /poll
PollConfirm	0906	PUT /poll/$id
DomainInfo	0105	GET / domain/$name

Requirements

Domain contacts

To order a .com domain you need a domain owner (OwnerC), an administrative contact (AdminC) and a technical contact (TechC). You can use existing contacts or create new ones.

Info

icon	false

Which data a contact must contain for the registration of a domain depends on the TLD. Each registry has its own guidelines. Some TLDs require so-called contact extensions. Detailed information about all TLDs we offer can be found in the TLD Knowledge Baseknowledge base

Contact create - example

SP Tabs group

disposition	horizontal

SP Tab pane

anchor	2286824
name	JSON

Code Block

language	js
title	Request
linenumbers	true
collapse	true

POST /contact
{
  "type": "PERSON",
  "fname": "John",
  "lname": "Doe",
  "organization": "Company",
  "address": [
      "123 Main Street"
  ],
  "pcode": "12345",
  "city": "Anytown",
  "country": "DE",
  "state": "BY",
  "phone": "+49-0-0",
  "email": "john.doe@domain.com"
}

Code Block

language	js
title	Response
linenumbers	true
collapse	true

{
    "stid": "20180926-app3-dev-4889",
    "status": {
        "code": "S0301",
        "text": "Domain contact has been successfully created.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "handle",
        "value": "23102255"
    },
    "data": [
        {
            "created": "2018-09-26T15:18:53.000+0200",
            "updated": "2018-09-26T15:18:53.000+0200",
            "id": 23102255,
            "owner": {
                "user": "USER",
                "context": CONTEXT
            },
            "updater": {
                "user": "USER",
                "context": CONTEXT
            },
            "alias": "John-Doe",
            "type": "PERSON",
            "fname": "John",
            "lname": "Doe",
            "organization": "Company",
            "address": [
                "123 Main Street"
            ],
            "pcode": "12345",
            "city": "Anytown",
            "country": "DE",
            "state": "BY",
            "phone": "+49-0-0",
            "email": "john.doe@domain.com",
            "protection": "SHOW_NONE"
        }
    ]
}

SP Tab pane

anchor	87031
name	XML

Code Block

language	xml
title	Request
linenumbers	true
collapse	true

<request>
  <auth>
    <user>USER</user>
    <password>PASSWORD</password>
    <context>CONTEXT</context>
  </auth>
  <task>
    <code>0301</code>
    <handle>
      <type>PERSON</type>
      <fname>John</fname>
      <lname>Doe</lname>
      <organization>Anycorp</organization>
      <address>Anystreet</address>
      <pcode>12345</pcode>
      <city>Anytown</city>
      <country>DE</country>
      <state />
      <phone>+49-0-0</phone>
      <fax>+49-0-0</fax>
      <email>john.doe@domain.com</email>
    </handle>
  </task>
</request>

Code Block

language	xml
title	Response
linenumbers	true
collapse	true

<response>
  <result>
    <data />
    <status>
      <code>S0301</code>
      <text>Domain contact has been successfully created.</text>
      <type>success</type>
      <object>
        <type>handle</type>
        <value>100</value>
      </object>
    </status>
  </result>
 <stid>20180926-stid</stid>
</response>

Process

Registering domains is an asynchronous process because the registry is involved in the processing of the order. The system notifications are provided in the system upon receipt and can be retrieved by polling.

Info
For more details on asynchronous notifications, see page Asynchronous Notifications.

Starting a domain create request

With the request type DomainCreate you start the registration of the domain. The following values are required:

Contacts: The contact ID of the required contacts. For .com domains, a domain owner, an administrative contact and a technical contact are required.
Domain: The name of the domain
Name server: The desired name servers. The number of name servers required depends on the TLD.

Info
Which additional data is required for a domain depends on the TLD. Each registry has its own guidelines. Further information can be found in the TLD Knowledge Base.

Domain create - Example

SP Tabs group

disposition	horizontal

SP Tab pane

anchor	2286824
name	JSON

Code Block

language	js
title	Request
linenumbers	true
collapse	true

POST /domain
{
    "name": "example.com",
    "ownerc": {
        "id": 100
    },
    "adminc": {
        "id": 100
    },
    "techc": {
        "id": 100
    },
    "nameServers": [
        {
          "name": "a.ns14.net"
        },
        {
          "name": "b.ns14.net"
        },
        {
          "name": "c.ns14.net"
        },
        {
          "name": "d.ns14.net"
        }
    ]
}

Code Block

language	js
title	Response
linenumbers	true
collapse	true

{
    "stid": "20180926-stid",
    "status": {
        "code": "N0101",
        "text": "Domain registration was started successfully.",
        "type": "NOTIFY"
    },
    "object": {
        "type": "domain",
        "value": "example.com"
    }
}

SP Tab pane

anchor	87031
name	XML

Code Block

language	xml
title	Request
linenumbers	true
collapse	true

<request>
  <auth>
    <user>USER</user>
    <password>PASSWORD</password>
    <context>CONTEXT</context>
  </auth>
  <task>
    <code>0101</code>
    <domain>
      <name>example.com</name>
      <ownerc>100</ownerc>
      <adminc>100</adminc>
      <techc>100</techc>
      <nserver>
        <name>a.ns14.net</name>
      </nserver>
      <nserver>
        <name>b.ns14.net</name>
      </nserver>
      <nserver>
        <name>c.ns14.net</name>
      </nserver>
      <nserver>
        <name>d.ns14.net</name>
      </nserver>
      <confirm_order>1</confirm_order>
      <period>1</period>
    </domain>
  </task>
</request>

Code Block

language	xml
title	Response
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <result>
    <data>
      <domain_job>
        <job>
          <id>123456</id>
          <status>RUNNING</status>
        </job>
      </domain_job>
    </data>
    <status>
      <code>N0101</code>
      <text>Domain registration was started successfully.</text>
      <type>notify</type>
      <object>
        <type>domain</type>
        <value>example.com</value>
      </object>
    </status>
  </result>
 <stid>20180926-stid</stid>
</response>

Receiving notifications

The DomainCancelationCreate task creates a cancelation request. This triggers the creation of a second cancelation request, which is processed later at the time defined in the request (=asynchronous processing).
Once this second request has been processed, a system notification is generated, indicating whether the deletion was successful or not. The notification can be retrieved using the Polling and Push methods.

Inquiring domain data

After successful registration, you can query the registration data stored in the system with the DomainInfo task. This enables you to determine whether the domain has been registered with the desired data.

SP Tabs group

disposition	horizontal

SP Tab pane

anchor	2286824
name	JSON

Code Block

language	js
title	Request
linenumbers	true
collapse	true

GET /domain/example.com

Code Block

language	js
title	Response
linenumbers	true
collapse	true

{
    "stid": "20180926-stid",
    "status": {
        "code": "S0105",
        "text": "Domain data has been inquired successfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "domain",
        "value": "example.com"
    },
    "data": [
        {
            "created": "2018-09-26T14:54:03.000+0200",
            "updated": "2018-09-26T14:54:10.000+0200",
            "owner": {
                "user": "USER",
                "context": CONTEXT
            },
            "updater": {
                "user": "USER",
                "context": CONTEXT
            },
            "name": "example.com",
            "payable": "2021-12-31T00:00:00.000+0200",
            "ownerc": {
                "id": 100
            },
            "adminc": {
                "id": 100
            },
            "techc": {
                "id": 100
            },
            "registryStatus": "LOCK",
            "nameServers": [
                {
                    "name": "a.ns14.net"
                },
                {
                    "name": "b.ns14.net"
                },
                {
                    "name": "c.ns14.net"
                },
                {
                    "name": "d.ns14.net"
                }
            ],
            "trustee": false,
            "privacy": false,
            "authinfo": "J/w0Xpn66I87YVty",
            "domainsafe": false,
            "validCertificate": false,
            "autoRenewStatus": "TRUE",
            "registrarStatus": "ACTIVE",
            "rddsOptIn": "NOT_SET"
        }
    ]
}

SP Tab pane

anchor	87031
name	XML

Code Block

language	xml
title	Request
linenumbers	true
collapse	true

<request>
  <auth>
    <user>USER</user>
    <password>PASSWORD</password>
    <context>CONTEXT</context>
  </auth>
  <task>
    <code>0105</code>
    <domain>
      <name>example.com</name>
    </domain>
  </task>
</request>

Code Block

language	xml
title	Response
linenumbers	true
collapse	true

<response>
  <result>
    <data>
      <domain>
        <name>example.com</name>
        <payable>2021-12-31 00:00:00</payable>
        <ownerc>100</ownerc>
        <adminc>100</adminc>
        <techc>100</techc>
        <registry_status>LOCK</registry_status>
        <nserver>
          <name>a.ns14.net</name>
        </nserver>
        <nserver>
          <name>b.ns14.net</name>
        </nserver>
        <nserver>
          <name>c.ns14.net</name>
        </nserver>
        <nserver>
          <name>d.ns14.net</name>
        </nserver>
        <period>1</period>
        <status>SUCCESS</status>
        <use_trustee>false</use_trustee>
        <use_privacy>false</use_privacy>
        <authinfo>J/w0Xpn66I87YVty</authinfo>
        <domainsafe>false</domainsafe>
        <certificate>false</certificate>
        <autorenew>true</autorenew>
        <registrar_status>ACTIVE</registrar_status>
        <rdds_opt_in>NOT_SET</rdds_opt_in>
        <owner>
          <user>USER</user>
          <context>CONTEXT</context>
        </owner>
        <updater>
          <user>USER</user>
          <context>CONTEXT</context>
        </updater>
        <created>2018-09-26 14:54:03</created>
        <updated>2018-09-26 14:54:10</updated>
      </domain>
    </data>
    <status>
      <code>S0105</code>
      <text>Domain data has been inquired successfully.</text>
      <type>success</type>
      <object>
        <type>domain</type>
        <value>example.com</value>
      </object>
    </status>
  </result>
 <stid>20180926-stid</stid>
</response>

Versions Compared

Old Version 35

New Version Current

Key

Basics of the JSON and XML API

Process overview

Flow chart

Task names, codes and routes

Requirements

Domain contacts

Contact create - example

Process

Starting a domain create request

Domain create - Example

Receiving notifications

Inquiring domain data

Page History

Versions Compared

Old Version 35

New Version Current

Key

Basics of the JSON and XML API

Process overview

Flow chart

Task names, codes and routes

Requirements

Domain contacts

Contact create - example

Process

Starting a domain create request

Domain create - Example

Receiving notifications

Inquiring domain data