API Module Domain createDomainRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Module Domain > Create)
m (→Raw XML)
(39 intermediate revisions not shown)
Line 1: Line 1:
==Module Domain > Create==
==Module Domain > Create==
 +
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 9: Line 10:
|-
|-
|'''Use'''
|'''Use'''
-
|Registers a domain with the provided data
+
|Registers a domain name with the attributes provided
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
|
|
*'''[[API Format Domain|domain]]'''
*'''[[API Format Domain|domain]]'''
-
*'''period'''
+
*'''[[API Format Period|period]]'''
-
*'''ownerHandle''' (customer unique identifier or handle, can be created via [[API Module Customer createCustomerRequest|createCustomerRequest]] API method)
+
*'''[[API Format Handle|ownerHandle]]''' (customer unique identifier or [[API Format Handle|handle]])
-
*'''adminHandle''' (customer unique identifier or handle, can be created via [[API Module Customer createCustomerRequest|createCustomerRequest]] API method)
+
*'''[[API Format Handle|adminHandle]]''' (customer unique identifier or [[API Format Handle|handle]])
-
*'''techHandle''' (customer unique identifier or handle, can be created via [[API Module Customer createCustomerRequest|createCustomerRequest]] API method)
+
*'''[[API Format Handle|techHandle]]''' (customer unique identifier or [[API Format Handle|handle]])
-
*billingHandle (customer unique identifier or handle, can be created via [[API Module Customer createCustomerRequest|createCustomerRequest]] API method)
+
*[[API Format Handle|billingHandle]] (customer unique identifier or [[API Format Handle|handle]])
-
*resellerHandle (customer unique identifier or handle, can be created via [[API Module Customer createCustomerRequest|createCustomerRequest]] API method)
+
*[[API Format Handle|resellerHandle]] (customer unique identifier or [[API Format Handle|handle]])
-
*nsGroup (mandatory field if nameServers field is empty)
+
*'''[[API Format nsGroup|nsGroup]]''' ('nameserver group', use ''dns-openprovider'' if you want to use our nameservers. Mandatory field only if nameServers field is empty)
-
*nsTemplateName
+
*[[API Format nsTemplateName|nsTemplateName]] (name of the template to use to automatically create DNS zone on the domain; only applicable if nsGroup is ''dns-openprovider'')
-
*[[API Format Nameservers|nameServers]] (mandatory field if nsGroup field is empty)
+
*'''[[API Format Nameservers|nameServers]]''' (mandatory field only if nsGroup field is empty)
-
*isDnssecEnabled (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used)
+
*[[API Format isDnssecEnabled|isDnssecEnabled]] (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used)
-
*useDomicile (''0'' (default) or ''1'')
+
*[[API Format DNSSEC Keys|dnssecKeys]] (when using your own nameservers)
-
*isPrivateWhoisEnabled (''0'' (default) or ''1'')
+
*[[API Format useDomicile|useDomicile]] (''0'' (default) or ''1'')
 +
*acceptPremiumFee (required in case when domain is premium, value is the price returned in the response for createDomainRequest without acceptPremiumFee)
 +
*[[API Format isPrivateWhoisEnabled|isPrivateWhoisEnabled]] (''0'' or ''1'', default value is ''0'')
*promoCode
*promoCode
-
*autorenew (''default'' (default), ''on'' or ''off'')
+
*[[API Format autorenew|autorenew]] ''( on | off | default )''
*comments
*comments
-
*[[API Format DNSSEC Keys|dnssecKeys]]
+
*[[API Format Additional Data|additionalData]] (mandatory for some TLDs)
-
*[[API Format Additional Data|additionalData]]
+
*[[API Format applicationMode|applicationMode]] (required for new gTLDs)
-
*applicationMode (''required for new gTLDs; allowed values:
+
-
** ''sunrise'' (during the Sunrise of a new gTLD launch only; special fees may apply; it's required to submit an SMD file in the ''applicationSmd'' parameter)
+
-
** ''landrush'' (during the Landrush of a new gTLD launch only; special fees may apply)
+
-
** ''preregistration'' (during the period in which Openprovider accepts pre-registrations for the TLD)
+
-
** ''claims'' (during the Trademark Claims period for the TLD; details can be found on the TLD details pages via the [https://www.openprovider.co.uk/new-gtlds/overview-new-gtlds/ overview page])
+
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
|
|
-
*status
+
*[[API Format Domain status|status]] ''(ACT - active or REQ - requested)''
-
*authCode
+
*[[API Format authCode|authCode]] ''(only in case if TLD supports it)''
-
*activationDate ''(only in case of a succeeded realtime domain registration)''
+
*[[API Format activationDate|activationDate]] ''(available only in case of a succeeded realtime domain registration)''
-
*expirationDate ''(only in case of a succeeded realtime domain registration)''
+
*[[API Format expirationDate|expirationDate]] ''(available only in case of a succeeded realtime domain registration)''
-
*expirationDateOpenprovider ''(only in case of a succeeded realtime domain registration)''
+
*[[API Format expirationDateOpenprovider|expirationDateOpenprovider]] ''(available only in case of a succeeded realtime domain registration)''
|}
|}
Line 62: Line 60:
     '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 84: Line 84:
     <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 100: Line 99:
       <authCode>123456</authCode>
       <authCode>123456</authCode>
     </data>
     </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>
   </reply>
  </openXML>
  </openXML>

Revision as of 10:23, 2 June 2020

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 (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