API Module Domain createDomainRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Raw XML)
 
(8 intermediate revisions not shown)
Line 1: Line 1:
==Module Domain > Create==
==Module Domain > Create==
-
Fields marked in bold are mandatory
+
Fields marked in bold are mandatory. Prior to use this API method make sure if the domain TLD requires [[API Format Extensions Additional Data Customer|additional data]] for domain owner to be filled in. 
{| border="1" cellpadding="4"
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
Line 41: Line 41:
*[[API Format activationDate|activationDate]] ''(available only in case of a succeeded realtime domain registration)''
*[[API Format activationDate|activationDate]] ''(available only in case of a succeeded realtime domain registration)''
*[[API Format expirationDate|expirationDate]] ''(available only in case of a succeeded realtime domain registration)''
*[[API Format expirationDate|expirationDate]] ''(available only in case of a succeeded realtime domain registration)''
-
*[[API Format expirationDateOpenprovider|expirationDateOpenprovider]] ''(available only in case of a succeeded realtime domain registration)''
+
*[[API Format expirationDateOpenprovider|expirationDateOpenprovider]] ''(Same as renewalDate. Available only in case of a succeeded realtime domain registration)''
 +
*[[API Format renewalDate|renewalDate]] ''(Date when a domain expires at Openprovider. This date should be referred for domain expiration and renewals.available only in case of a succeeded realtime domain registration)''
|}
|}
Line 60: Line 61:
     'period' => '1',
     'period' => '1',
     'nsGroup' => 'dns-openprovider',
     'nsGroup' => 'dns-openprovider',
-
    'nsTemplateName' => 'Shared hosting server Apollo',
 
   ));
   ));
===Raw XML===
===Raw XML===
''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.''
''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.''
 +
 +
'''NB''': When submitting multiple domain names in an array, the <domain'''s'''> (plural) XML field should be used instead of <domain>.
 +
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
  <openXML>
  <openXML>
Line 82: Line 85:
     <period>1</period>
     <period>1</period>
     <nsGroup>dns-openprovider</nsGroup>
     <nsGroup>dns-openprovider</nsGroup>
-
    <nsTemplateName>Shared hosting server Apollo</nsTemplateName>
 
   </createDomainRequest>
   </createDomainRequest>
  </openXML>
  </openXML>
Line 101: Line 103:
  </openXML>
  </openXML>
-
Output example for the attempt to register *premium* domain without parameter acceptPremiumFee:
+
''Output example for the attempt to register premium domain without parameter acceptPremiumFee:''
-
 
+
<?xml version="1.0" encoding="UTF-8"?>
-
<?xml version="1.0" encoding="UTF-8"?>
+
<openXML>
-
<openXML>
+
   <reply>
   <reply>
     < code>379</code>
     < code>379</code>
Line 110: Line 111:
     <data>33</data>
     <data>33</data>
   </reply>
   </reply>
-
</openXML>
+
</openXML>

Current revision as of 09:00, 19 August 2025

Contents

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
Input
Output
  • 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 (Same as renewalDate. Available only in case of a succeeded realtime domain registration)
  • renewalDate (Date when a domain expires at Openprovider. This date should be referred for domain expiration and renewals.available only in case of a succeeded realtime domain registration)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('createDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    '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',
  ));

Raw XML

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.

NB: When submitting multiple domain names in an array, the <domains> (plural) XML field should be used instead of <domain>. 

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <createDomainRequest>
    <ownerHandle>SR003891-NL</ownerHandle>
    <adminHandle>SR003891-NL</adminHandle>
    <techHandle>SR003891-NL</techHandle>
    <billingHandle>SR003891-NL</billingHandle>
    <domain>
      <name>this-domain-is-registered</name>
      <extension>com</extension>
    </domain>
    <period>1</period>
    <nsGroup>dns-openprovider</nsGroup>
  </createDomainRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
    <data>
      <status>ACT</status>
      <activationDate>2011-04-22 14:14:32</activationDate>
      <expirationDate>2012-04-22 14:41:32</expirationDate>
      <expirationDateOpenprovider>2012-04-22 14:41:32</expirationDateOpenprovider>
      <authCode>123456</authCode>
    </data>
  </reply>
</openXML>

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

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < 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>
    <data>33</data>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_Domain_createDomainRequest"
Views
Personal tools