Get Started

Check Domain ^*

Is domain you want to register is available or not?

GET

/domain/available/{{data.domain_name}}.{{data.domain_tld}}/

{
    "domain_name": "{{data.domain_name}}.{{data.domain_tld}}",
    "available":   false
}

Download example

// Require ODR API demo class
require_once 'Api/Odr.php';

// Configuration array, with user API Keys
$config = array(
    'api_key'    => '{{data.user.api_key}}',
    'api_secret' => '{{data.user.api_secret}}',
);

// Create new instance of API demo class
$demo = new Api_Odr($config);

// Login into API
$demo->login();

// Check if target domain is available for registration or not
$demo->checkDomain('{{data.domain_name}}.{{data.domain_tld}}');

// Get result of request
$result = $demo->getResult();

if ($result['status'] !== 'success') {
    echo 'Following error occured: '. $result['response'];

    exit();
}

$result = $result['response'];

if ($result['available'] === true) {
    // Domain is available for registration
    echo 'Domain "{{data.domain_name}}.{{data.domain_tld}}" is available';

    // Do something with available domain

    exit();
}

// D'oh, someone already took this domain!
echo 'Domain "{{data.domain_name}}.{{data.domain_tld}}" is not available';

Information about Register Domain

View list of fields required for domain registration.

Different TLDs might require different set of fields. You can use either 'Settings' in top right corner to change TLD or select box right near heading.

/info/ operation can be applied to almost any available operation, like user login, delete one nameserver or even get operation status.

Be aware, that this field set and/or code example is supposed for "{{#uppercase}}{{data.domain_tld}}{{/uppercase}}" TLD. For different TLD, there might be different field set or example code.

POST

/info/domain/{{data.domain_name}}.{{data.domain_tld}}/

{
    "fields": [
        {
            "min_length": 1,
            "max_length": 255,
            "required":   true,
            "example":    "{{data.domain_name}}",
            "type":       "String_EUToken_DomainName",
            "name":       "domain_name"
        },
        {
            "required": true,
            "regexp":   "/^(3|(?:12))$/",
            "example":  "Number of month to register the name",
            "type":     "Select_NLNumberMonth",
            "name":     "number_months"
        },
        {
            "required": true,
            "role_id":  "odr.contact_role.nl_registrant",
            "type":     "Select_UnifiedContact",
            "name":     "handle_registrant"
        },
        {
            "required": true,
            "role_id":  "odr.contact_role.nl_admin",
            "type":     "Select_UnifiedContact",
            "name":     "handle_onsite"
        },
        {
            "required": true,
            "role_id":  "odr.contact_role.nl_tech",
            "type":     "Select_UnifiedContact",
            "name":     "handle_tech"
        },
        {
            "required": true,
            "role_id":  "odr.nameserver_role.nl_common",
            "type":     "String_Nameserver",
            "name":     "handle_ns1"
        },
        {
            "role_id": "odr.nameserver_role.nl_common",
            "type":    "String_Nameserver",
            "name":    "handle_ns2"
        },
        {
            "role_id": "odr.nameserver_role.nl_common",
            "type":    "String_Nameserver",
            "name":    "handle_ns3"
        },
        {
            "role_id": "odr.nameserver_role.nl_common",
            "type":    "String_Nameserver",
            "name":    "handle_ns4"
        },
        {
            "role_id": "odr.nameserver_role.nl_common",
            "type":    "String_Nameserver",
            "name":    "handle_ns5"
        },
        {
            "role_id": "odr.nameserver_role.nl_common",
            "type":    "String_Nameserver",
            "name":    "handle_ns6"
        },
        {
            "type": "Checkbox",
            "name": "check_nameservers"
        }
    ],
    "prices": {
        "amount": 10,
        "tax":    0,
        "total":  10
    },
    "description": "Create new domain"
}

{
    "fields": [
        {
            "min_length": 1,
            "max_length": 255,
            "required":   true,
            "example":    "{{data.domain_name}}",
            "type":       "String_EUToken_DomainName_Unicode",
            "name":       "domain_name"
        },
        {
            "required": true,
            "type":     "Select_UnifiedContact",
            "name":     "handle_registrant"
        },
        {
            "required": true,
            "type":     "Select_UnifiedContact",
            "name":     "handle_onsite"
        },
        {
            "type": "Checkbox",
            "name": "use_tech_handle"
        },
        {
            "required": true,
            "type":     "String_Nameserver",
            "name":     "handle_ns1"
        },
        {
            "type": "String_Nameserver",
            "name": "handle_ns2"
        },
        {
            "type": "String_Nameserver",
            "name": "handle_ns3"
        },
        {
            "type": "String_Nameserver",
            "name": "handle_ns4"
        }
    ],
    "prices": {
        "amount": 10,
        "tax":    0,
        "total":  10
    },
    "description": "Create new domain"
}

{
    "fields": [
        {
            "min_length": 1,
            "max_length": 255,
            "required":   true,
            "example":    "{{data.domain_name}}",
            "type":       "String_EUToken_DomainName_Unicode",
            "name":       "domain_name"
        },
        {
            "required": true,
            "role_id":  "odr.contact_role.eu_registrant",
            "type":     "Select_UnifiedContact",
            "name":     "handle_registrant"
        },
        {
            "required": true,
            "role_id":  "odr.contact_role.eu_onsite",
            "type":     "Select_UnifiedContact",
            "name":     "handle_onsite"
        },
        {
            "required": true,
            "role_id":  "odr.nameserver_role.eu_common",
            "type":     "String_Nameserver",
            "name":     "handle_ns1"
        },
        {
            "role_id": "odr.nameserver_role.eu_common",
            "type":    "String_Nameserver",
            "name":    "handle_ns2"
        },
        {
            "role_id": "odr.nameserver_role.eu_common",
            "type":    "String_Nameserver",
            "name":    "handle_ns3"
        },
        {
            "role_id": "odr.nameserver_role.eu_common",
            "type":    "String_Nameserver",
            "name":    "handle_ns4"
        }
    ],
    "prices": {
        "amount": 10,
        "tax":    0,
        "total":  10
    },
    "description": "Create new domain"
}

{
    "fields": [
        {
            "min_length": 1,
            "max_length": 255,
            "required":   true,
            "example":    "{{data.domain_name}}",
            "type":       "String_EUToken_DomainName_Unicode",
            "name":       "domain_name"
        },
        {
            "required": false,
            "readonly": true,
            "example":  "years",
            "type":     "String_UNIVERSALPeriod",
            "name":     "domain_period"
        },
        {
            "required": true,
            "example":  "some secret phrase",
            "type":     "String_EUToken",
            "name":     "domain_password"
        },
        {
            "required": true,
            "type":     "Select_UnifiedContact",
            "name":     "handle_registrant"
        },
        {
            "required": true,
            "type":     "Select_UnifiedContact",
            "name":     "handle_onsite"
        },
        {
            "required": true,
            "type":     "String_Nameserver",
            "name":     "handle_ns1"
        },
        {
            "required": true,
            "type":     "String_Nameserver",
            "name":     "handle_ns2"
        },
        {
            "type": "String_Nameserver",
            "name": "handle_ns3"
        },
        {
            "type": "String_Nameserver",
            "name": "handle_ns4"
        },
        {
            "type": "String_Nameserver",
            "name": "handle_ns5"
        }
    ],
    "prices": {
        "amount": 10,
        "tax":    0,
        "total":  10
    },
    "description": "Create new domain"
}

{
    "fields": [
        {
            "min_length": 1,
            "max_length": 255,
            "required":   true,
            "example":    "{{data.domain_name}}",
            "type":       "String_EUToken_DomainName",
            "name":       "domain_name"
        },
        {
            "required": true,
            "readonly": true,
            "regexp":   "/^\d+$/",
            "example":  "2",
            "type":     "String_UNIVERSAL2Period",
            "name":     "domain_period"
        },
        {
            "required": true,
            "example":  "DoMa!NPa$sw0rD",
            "type":     "String",
            "name":     "domain_password"
        },
        {
            "required": true,
            "type":     "Select_UnifiedContact",
            "name":     "handle_registrant"
        },
        {
            "required": true,
            "type":     "Select_UnifiedContact",
            "name":     "handle_onsite"
        },
        {
            "required": true,
            "type":     "Select_UnifiedContact",
            "name":     "handle_tech"
        },
        {
            "required": true,
            "type":     "String_Nameserver",
            "name":     "handle_ns1"
        },
        {
            "required": true,
            "type":     "String_Nameserver",
            "name":     "handle_ns2"
        },
        {
            "type": "String_Nameserver",
            "name": "handle_ns3"
        },
        {
            "type": "String_Nameserver",
            "name": "handle_ns4"
        }
    ],
    "prices": {
        "amount": 10,
        "tax":    0,
        "total":  10
    },
    "description": "Create new domain"
}

Download example

// Require ODR API demo class
require_once 'Api/Odr.php';

// Configuration array, with user API Keys
$config = array(
    'api_key'    => '{{data.user.api_key}}',
    'api_secret' => '{{data.user.api_secret}}',
);

// Create new instance of API demo class
$demo = new Api_Odr($config);

// Login into API
$demo->login();

// Request information about domain registration
$demo->infoRegisterDomain('{{data.domain_name}}.{{data.domain_tld}}');

// Get result of request
$result = $demo->getResult();

if ($result['status'] !== 'success') {
    echo 'Following error occured: '. $result['response'];

    exit();
}

$result = $result['response'];

// Output what we get
print_r($result);

Register Domain ^*

Add a new domain to your personal belongings

POST

/domain/{{data.domain_name}}.{{data.domain_tld}}/

{
    "number_months":     12,
    "handle_registrant": 1,
    "handle_onsite":     1,
    "handle_tech":       1,
    "handle_ns1":        "ns1.test.nl",
    "handle_ns2":        "ns2.test.nl"
}

{
    "handle_registrant": 2,
    "handle_onsite":     2,
    "handle_ns1":        "ns1.test.be",
    "handle_ns2":        "ns2.test.be"
}

{
    "handle_registrant": 5,
    "handle_onsite":     5,
    "handle_ns1":        "ns1.test.eu",
    "handle_ns2":        "ns2.test.eu"
}

{
    "handle_registrant": 6,
    "handle_onsite":     6,
    "handle_tech":       6,
    "handle_ns1":        "ns1.test.ru",
    "handle_ns2":        "ns2.test.ru",
    "domain_period":     1
}

{
    "domain_password":   "test_pass",
    "handle_registrant": 7,
    "handle_onsite":     7,
    "handle_ns1":        "ns1.test.com",
    "handle_ns2":        "ns2.test.com",
    "domain_password":   "DoMa!nPa$sw0rD",
    "domain_period":     1
}

{
    "domain_name":       "{{data.domain_name}}",
    "number_months":     12,
    "handle_registrant": 1,
    "handle_onsite":     1,
    "handle_tech":       1,
    "handle_ns1":        "ns1.test.nl",
    "handle_ns2":        "ns2.test.nl",
    "handle_ns3":        null,
    "handle_ns4":        null,
    "handle_ns5":        null,
    "handle_ns6":        null,
    "handle_ns7":        null,
    "handle_ns8":        null,
    "check_nameservers": null,
    "api_contacts":      {
        "registrant": "ANT000001-INTSU",
        "admin":      "ANT000001-INTSU",
        "tech":       "ANT000001-INTSU"
    },
    "api_nameservers":   [
        {
            "ns": "ns1.test.nl",
            "ip": ""
        },
        {
            "ns": "ns2.test.nl",
            "ip": ""
        }
    ],
    "created_domain_id": 1
}

{
    "domain_name":       "{{data.domain_name}}",
    "handle_registrant": 2,
    "handle_onsite":     3,
    "handle_ns1":        "ns1.test.be",
    "use_tech_handle":   null,
    "handle_ns2":        "ns2.test.be",
    "handle_ns3":        null,
    "handle_ns4":        null,
    "handle_ns5":        null,
    "handle_ns6":        null,
    "handle_ns7":        null,
    "handle_ns8":        null,
    "odr_contact_role_be_registrant": "c1",
    "odr_contact_role_be_onsite":     "c2",
    "odr_contact_role_be_tech":       "c0",
    "odr_contact_role_be_billing":    "c0",
    "api_nameservers":   [
        {
            "ns": "ns1.test.be",
            "ip": ""
        },
        {
            "ns": "ns2.test.be",
            "ip": ""
        }
    ],
    "created_domain_id": 2
}

{
    "domain_name":       "{{data.domain_name}}",
    "handle_registrant": 4,
    "handle_onsite":     5,
    "handle_ns1":        "ns1.test.eu",
    "handle_ns2":        null,
    "handle_ns3":        null,
    "handle_ns4":        null,
    "handle_ns5":        null,
    "handle_ns6":        null,
    "handle_ns7":        null,
    "handle_ns8":        null,
    "odr_contact_role_eu_onsite":     "c15000001",
    "odr_contact_role_eu_registrant": "c15000002",
    "odr_contact_role_eu_tech":       "c15000000",
    "odr_contact_role_eu_billing":    "c15000000",
    "api_nameservers":   [
        {
            "ns": "ns1.test.eu",
            "ip": ""
        },
        {
            "ns": "ns2.test.eu",
            "ip": ""
        }
    ],
    "domain_period":     1,
    "created_domain_id": 3
}

{
    "domain_name":       "{{data.domain_name}}",
    "handle_registrant": 6,
    "handle_onsite":     6,
    "handle_tech":       6,
    "handle_ns1":        "ns1.test.ru",
    "handle_ns2":        "ns2.test.ru",
    "use_tech_handle":   null,
    "handle_ns3":        null,
    "handle_ns4":        null,
    "handle_ns5":        null,
    "handle_ns6":        null,
    "handle_ns7":        null,
    "handle_ns8":        null,
    "api_nameservers":   [
        {
            "ns": "ns1.test.ru",
            "ip": ""
        },
        {
            "ns": "ns2.test.ru",
            "ip": ""
        }
    ],
    "created_domain_id": 4
}

{
    "domain_name":       "{{data.domain_name}}",
    "handle_registrant": 7,
    "handle_onsite":     7,
    "handle_ns1":        "ns1.test.com",
    "handle_ns2":        "ns2.test.com",
    "use_tech_handle":   null,
    "handle_ns3":        null,
    "handle_ns4":        null,
    "handle_ns5":        null,
    "handle_ns6":        null,
    "handle_ns7":        null,
    "handle_ns8":        null,
    "api_nameservers":   [
        {
            "ns": "ns1.test.com",
            "ip": ""
        },
        {
            "ns": "ns2.test.com",
            "ip": ""
        }
    ],
    "created_domain_id": 5
}

Download example

// Require ODR API demo class
require_once 'Api/Odr.php';

// Configuration array, with user API Keys
$config = array(
    'api_key'    => '{{data.user.api_key}}',
    'api_secret' => '{{data.user.api_secret}}',
);

// We assume that user already sent all the data to us through request
$data = $_REQUEST;

// Create new instance of API demo class
$demo = new Api_Odr($config);

// Login into API
$demo->login();

// Create new domain, by passing request data
$demo->registerDomain('{{data.domain_name}}.{{data.domain_tld}}', $data);

// Get result of request
$result = $demo->getResult();

if ($result['status'] !== 'success') {
    echo 'Following error occured: '. $result['response'];

    exit();
}

$result = $result['response'];

// Domain successfully created, sploosh!
echo 'Domain "'. $result['domain_name'] .'" created';