API Module Domain createDomainRequest

From Openprovider API documentation

Jump to: navigation, search


Module Domain > Create

Fields marked in bold are mandatory. Prior to use this API method make sure if the domain TLD requires additional data for domain owner to be filled in.

Module domain
Command name createDomainRequest
Use Registers a domain name with the attributes provided
  • status (ACT - active or REQ - requested)
  • authCode (only in case if TLD supports it)
  • activationDate (available only in case of a succeeded realtime domain registration)
  • expirationDate (available only in case of a succeeded realtime domain registration)
  • expirationDateOpenprovider (available only in case of a succeeded realtime domain registration)


Using PHP class

$request = new OP_Request;
  ->setAuth(array('username' => 'username', 'password' => 'password'))
    'ownerHandle' => 'SR003891-NL',
    'adminHandle' => 'SR003891-NL',
    'techHandle' => 'SR003891-NL',
    'billingHandle' => 'SR003891-NL',
    'domain' => array(
      'name' => 'this-domain-is-registered',
      'extension' => 'com'
    'period' => '1',
    'nsGroup' => 'dns-openprovider',
    'nsTemplateName' => 'Shared hosting server Apollo',


Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.

<?xml version="1.0" encoding="UTF-8"?>
    <nsTemplateName>Shared hosting server Apollo</nsTemplateName>
<?xml version="1.0" encoding="UTF-8"?>
    < code>0</code>
      <activationDate>2011-04-22 14:14:32</activationDate>
      <expirationDate>2012-04-22 14:41:32</expirationDate>
      <expirationDateOpenprovider>2012-04-22 14:41:32</expirationDateOpenprovider>

Output example for the attempt to register premium domain without parameter acceptPremiumFee:

<?xml version="1.0" encoding="UTF-8"?>
    < code>379</code>
    <desc>You are about to register the premium domain. If you accept this registration fee, re-send the createDomainRequest and add the parameters "acceptPremiumFee" with the value of a premium fee, which can be found in the `data` block of this command output.</desc>
Personal tools