This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

Go to the new documentation

API Module Domain transferDomainRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Module Domain > Transfer)
(36 intermediate revisions not shown)
Line 9: Line 9:
|-
|-
|'''Use'''
|'''Use'''
-
|Starts a domain transfer
+
|Used to start or schedule domain transfer
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
|
|
*'''[[API Format Domain|domain]]'''
*'''[[API Format Domain|domain]]'''
-
*'''period'''
+
*'''[[API Format Period|period]]'''
-
*authCode
+
*[[API Format authCode|authCode]]
-
*'''ownerHandle'''
+
*'''[[API Format Handle|ownerHandle]]'''
-
*'''adminHandle'''
+
*'''[[API Format Handle|adminHandle]]'''
-
*'''techHandle'''
+
*'''[[API Format Handle|techHandle]]'''
-
*nsGroup
+
*[[API Format Handle|billingHandle]]
-
*[[API Format Nameservers|nameServers]]
+
*[[API Format Handle|resellerHandle]]
-
*useDomicile
+
*'''[[API Format nsGroup|nsGroup]]''' ('nameserver group', use ''dns-openprovider'' if you want to use our nameservers. Mandatory field only if nameServers field is empty)
 +
*[[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 only if nsGroup field is empty)
 +
*[[API Format autorenew|autorenew]] ''( on | off | default )''
 +
*[[API Format isDnssecEnabled|isDnssecEnabled]] (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used)
 +
*[[API Format DNSSEC Keys|dnssecKeys]] (when using your own nameservers)
 +
*[[API Format useDomicile|useDomicile]] (''0'' (default) or ''1'')
 +
*[[API Format Transfer At|at]] ''(format: yyyy-mm-dd)''
 +
*promoCode
 +
*acceptPremiumFee (required in case when domain is premium, value is the price returned in the response for transferDomainRequest without acceptPremiumFee. e.g. <acceptPremiumFee>33</acceptPremiumFee>)
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
-
|Expiration date in case of a succeeded realtime domain transfer
+
|
-
*expirationDate
+
*[[API Format expirationDate|expirationDate]] ''(available only in case of a succeeded realtime domain transfer)''
 +
*[[API Format expirationDateOpenprovider|expirationDateOpenprovider]] ''(available only in case of a succeeded realtime domain transfer)''
|}
|}
Line 37: Line 47:
     'adminHandle' => 'SR003891-NL',
     'adminHandle' => 'SR003891-NL',
     'techHandle' => 'SR003891-NL',
     'techHandle' => 'SR003891-NL',
 +
    'billingHandle' => 'SR003891-NL',
     'domain' => array(
     'domain' => array(
       'name' => 'domain',
       'name' => 'domain',
Line 43: Line 54:
     'period' => '1',
     'period' => '1',
     'authCode' => 'asd79SAD(8sd',
     'authCode' => 'asd79SAD(8sd',
-
     'nsGroup' => 'MyServer'
+
     'nameServers' => array(
 +
      array(
 +
        'name' => 'ns1.yourdomain.com',
 +
        'ip' => '100.1.2.3',
 +
        'ip6' => '2a01:d078:0:147:94:198:153:68',
 +
      ),
 +
      array(
 +
        'name' => 'ns2.yourdomain.com',
 +
        'ip' => '100.1.2.6',
 +
        'ip6' => '20f1:610:0:800d::15',
 +
      ),
 +
    ),
 +
    'dnssecKeys' => array(
 +
      array(
 +
        'flags' => 256,
 +
        'alg' => 8,
 +
        'pubKey' => 'AwEAA{...}VNfPps3=',
 +
      ),
 +
      array(
 +
        'flags' => 257,
 +
        'alg' => 8,
 +
        'pubKey' => 'AwEAA{...}TK5f9fs=',
 +
      ),
 +
    ),
   ));
   ));
===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.''
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
  <openXML>
  <openXML>
Line 57: Line 92:
     <adminHandle>SR003891-NL</adminHandle>
     <adminHandle>SR003891-NL</adminHandle>
     <techHandle>SR003891-NL</techHandle>
     <techHandle>SR003891-NL</techHandle>
 +
    <billingHandle>SR003891-NL</billingHandle>
     <domain>
     <domain>
       <name>this-domain-is-registered</name>
       <name>this-domain-is-registered</name>
Line 63: Line 99:
     <period>1</period>
     <period>1</period>
     <authCode>asd79SAD(8sd</authCode>
     <authCode>asd79SAD(8sd</authCode>
-
     <nsGroup>MyServer</nsGroup>
+
     <nameServers>
 +
      <array>
 +
        <item>
 +
          <name>ns1.yourdomain.com</name>
 +
          <ip>100.1.2.3</ip>
 +
          <ip6>2a01:d078:0:147:94:198:153:68</ip6>
 +
        </item>
 +
        <item>
 +
          <name>ns2.yourdomain.com</name>
 +
          <ip>100.1.2.6</ip>
 +
          <ip6>20f1:610:0:800d::15</ip6>
 +
        </item>
 +
      </array>
 +
    </nameServers>
 +
    <dnssecKeys>
 +
      <array>
 +
        <item>
 +
          <flags>256</flags>
 +
          <alg>8</alg>
 +
          <pubKey>AwEAA{...}VNfPps3=</pubKey>
 +
        </item>
 +
        <item>
 +
          <flags>257</flags>
 +
          <alg>8</alg>
 +
          <pubKey>AwEAA{...}TK5f9fs=</pubKey>
 +
        </item>
 +
      </array>
 +
    </dnssecKeys>
   </transferDomainRequest>
   </transferDomainRequest>
  </openXML>
  </openXML>
Line 70: Line 133:
  <openXML>
  <openXML>
   <reply>
   <reply>
-
     <code>0</code>
+
     <nowiki><code>0</code></nowiki>
     <desc></desc>
     <desc></desc>
   </reply>
   </reply>
  </openXML>
  </openXML>

Revision as of 03:48, 1 November 2017

Contents

Module Domain > Transfer

Module domain
Command name transferDomainRequest
Use Used to start or schedule domain transfer
Input
  • domain
  • period
  • authCode
  • ownerHandle
  • adminHandle
  • techHandle
  • billingHandle
  • resellerHandle
  • nsGroup ('nameserver group', use dns-openprovider if you want to use our nameservers. Mandatory field only if nameServers field is empty)
  • nsTemplateName (name of the template to use to automatically create DNS zone on the domain; only applicable if nsGroup is dns-openprovider)
  • nameServers (mandatory field only if nsGroup field is empty)
  • autorenew ( on | off | default )
  • isDnssecEnabled (0 (default) or 1 - Only accepted when nameservers of Openprovider are used)
  • dnssecKeys (when using your own nameservers)
  • useDomicile (0 (default) or 1)
  • at (format: yyyy-mm-dd)
  • promoCode
  • acceptPremiumFee (required in case when domain is premium, value is the price returned in the response for transferDomainRequest without acceptPremiumFee. e.g. <acceptPremiumFee>33</acceptPremiumFee>)
Output

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('transferDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'ownerHandle' => 'SR003891-NL',
    'adminHandle' => 'SR003891-NL',
    'techHandle' => 'SR003891-NL',
    'billingHandle' => 'SR003891-NL',
    'domain' => array(
      'name' => 'domain',
      'extension' => 'com'
    ),
    'period' => '1',
    'authCode' => 'asd79SAD(8sd',
    'nameServers' => array(
      array(
        'name' => 'ns1.yourdomain.com',
        'ip' => '100.1.2.3',
        'ip6' => '2a01:d078:0:147:94:198:153:68',
      ),
      array(
        'name' => 'ns2.yourdomain.com',
        'ip' => '100.1.2.6',
        'ip6' => '20f1:610:0:800d::15',
      ),
    ),
    'dnssecKeys' => array(
      array(
        'flags' => 256,
        'alg' => 8,
        'pubKey' => 'AwEAA{...}VNfPps3=',
      ),
      array(
        'flags' => 257,
        'alg' => 8,
        'pubKey' => 'AwEAA{...}TK5f9fs=',
      ),
    ),
  ));

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. 

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <transferDomainRequest>
    <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>
    <authCode>asd79SAD(8sd</authCode>
    <nameServers>
      <array>
        <item>
          <name>ns1.yourdomain.com</name>
          <ip>100.1.2.3</ip>
          <ip6>2a01:d078:0:147:94:198:153:68</ip6>
        </item>
        <item>
          <name>ns2.yourdomain.com</name>
          <ip>100.1.2.6</ip>
          <ip6>20f1:610:0:800d::15</ip6>
        </item>
      </array>
    </nameServers>
    <dnssecKeys>
      <array>
        <item>
          <flags>256</flags>
          <alg>8</alg>
          <pubKey>AwEAA{...}VNfPps3=</pubKey>
        </item>
        <item>
          <flags>257</flags>
          <alg>8</alg>
          <pubKey>AwEAA{...}TK5f9fs=</pubKey>
        </item>
      </array>
    </dnssecKeys>
  </transferDomainRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_Domain_transferDomainRequest"
Views
Personal tools