Renew: Difference between revisions

From Boxis.net API Docs
Jump to navigation Jump to search
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Domain Function: Renew=
=Domain Function: renew=


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


=== Input params ===
{|
|-
| - '''domain'''::String::Domain name that you need to Transfer
|-
| - '''years'''::::Integer::Number of years for which you want to Renew create Order
|}


=== Output params ===
== Input params ==


==== example in XML ====
*'''version'''::String - ''API version (e.g. '1.0')''


===== success =====
*'''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 'renew' value
*'''domain'''::String - ''Domain name that you need to renew''
*'''years'''::Integer - ''Number of years for which you want to renew create order''
== Example URL with POST values ==
<pre>
http://api.boxis.net/
POST: version=1.0&returntype=xml&timestamp=1337853982&username=your@mail.com&authcode=1234567890&section=domains&action=renew&domain=test1.com&years=4
</pre>
== Output params ==
==== Example in XML (Success) ====
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<return>
<return>
Line 24: Line 42:
   <timestamp>1335767184</timestamp>
   <timestamp>1335767184</timestamp>
</return>
</return>
</pre>


===== error =====
==== Example in XML (Error) ====


<pre>
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<return>
<return>
Line 34: Line 54:
   <timestamp>1335767184</timestamp>
   <timestamp>1335767184</timestamp>
</return>
</return>
</pre>


==== Example in Json  ====
==== Example in JSON (Success) ====
 
===== success =====


<pre>
{"result":"1",
{"result":"1",
  "resulttxt":"success",
  "resulttxt":"success",
  "params":[],
  "params":[],
  "timestamp":1335777400}
  "timestamp":1335777400}
</pre>


===== error =====
==== Example in JSON (Error) ====


<pre>
{"result":"0",
{"result":"0",
  "resulttxt":"Error: {error description}",
  "resulttxt":"Error: {error description}",
  "params":[],
  "params":[],
  "timestamp":1335777400}
  "timestamp":1335777400}
</pre>
== Example using our PHP Class ==
<pre>
/* API LOGIN DETAILS */
$email    = 'your@mail.com';    // your username
$apikey  = '1234567890';        // your apikey
/* API COMMAND DETAILS */
$apitype  = 'domains';
$command  = 'renew';
$params  = array(
    'returntype' => 'xml',
    'domain' => 'test1.com',
    'years' => 4
);
/* 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);
}
/*


==== Errors Descriptions ====
</pre>
{|
|-
| - 'domain' is not valid
|-
| - there is no such tld
|-
| - this domain belongs to another user
|-
| - domain does not exists
|-
| - domain not renewed
|}

Latest revision as of 14:54, 26 October 2012

Domain Function: renew

With this command, you are able to renew 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 'renew' value
  • domain::String - Domain name that you need to renew
  • years::Integer - Number of years for which you want to renew create order


Example URL with POST values

http://api.boxis.net/
POST: version=1.0&returntype=xml&timestamp=1337853982&username=your@mail.com&authcode=1234567890&section=domains&action=renew&domain=test1.com&years=4

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  = 'renew';
$params   = array(
    'returntype' => 'xml',
    'domain' => 'test1.com',
    'years' => 4
);

/* 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);
}
/*