Revision as of 14:05, 26 June 2012

Domain Function: transfer

With this command, you are able to transfer your domain to boxis.net.

Input params

• version::String - API version (e.g. '1.0')

• timestamp::String - Sequence of characters, denoting the date and time (e.g '1336553826')

• username::String - User e-mail address (e.g 'mail1@example.com')

• authcode::String - md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))

• section::String - API module name. Use 'domains' value

• action::String - API module function. Use 'register' value

• action::String - API module function. Use 'transfer' value

• domain::String - Domain name that you need to transfer

• auth-code::String - Authorization Code (a.k.a. Domain Secret) of the domain name that you want to transfer

• ns[1],ns[2],..ns[5]::Array of Strings (optional) - List of Name Servers to be associated with the domain name. A maximum of 5 Name Servers can be specified

• protect-privacy::Boolean - Enables / Disables the Privacy Protection setting for the domain name

• protection-lock::Boolean - Enable / Disable Protection Lock service. Possible values are: true or false

• auto-renewal::Boolean - Enable / Disable Auto-Renewal service. Possible values are: true or false

Example URL with POST values

https://boxis.net/xmlapi.php
POST: version=1.0&returntype=xml&timestamp=1337853857&username=your@mail.com&authcode=1234567890&section=domains&action=transfer&domain=test1.net&years=1&auth-code=2332&ns[1]=ns1.boxis.ch&ns[2]=ns2.boxis.ch&
      protect-privacy=1&protection-lock=1&autorenew=0

Output params

Example in XML (Success)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <params/>
  <timestamp>1335767184</timestamp>
</return>

Example in XML (Error)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>0</result>
  <resulttxt>Error: {error description}</resulttxt>
  <params/>
  <timestamp>1335767184</timestamp>
</return>

Example in JSON (Success)

{"result":"1",
 "resulttxt":"success",
 "params":[],
 "timestamp":1335777400}

Example in JSON (Error)

{"result":"0",
 "resulttxt":"Error: {error description}",
 "params":[],
 "timestamp":1335777400}

Example using our PHP Class

/* API LOGIN DETAILS */
$email    = 'your@mail.com';    // your username
$apikey   = '1234567890';        // your apikey

/* API COMMAND DETAILS */
$apitype  = 'domains';
$command  = 'transfer';
$params   = array(
    'returntype' => 'xml',
    'domain' => 'test1.net',
    'years' => 1,
    'auth-code' => '2332',
    'ns[1]' => 'ns1.boxis.ch',
    'ns[2]' => 'ns2.boxis.ch',
    'protect-privacy' => 1,
    'protection-lock' => 1,
    'autorenew' => 0
);

/* PROCESS THE ACTION */
$boxisAPI = new BoxisAPIConnection($email, $apikey);
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);

/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)
if($return['timestamperror']) {
    $timestamp = $return['timestamp'];
    $return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);
}
*/

/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/
/*
if($return->timestamperror) {
    $timestamp = $return->timestamp;
    $return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);
}
/*