Renew: Difference between revisions

From Boxis.net API Docs
Jump to navigation Jump to search
No edit summary
Line 3: Line 3:
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 ===
== 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''
|}


=== Output 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''
 
 
== Output params ==


==== Example in XML (Success) ====
==== Example in XML (Success) ====
Line 57: Line 48:
</pre>
</pre>


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


<pre>
<pre>
Line 66: Line 57:
</pre>
</pre>


==== Example in Json (Error) ====
==== Example in JSON (Error) ====


<pre>
<pre>
Line 73: Line 64:
  "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);
</pre>
</pre>

Revision as of 11:31, 24 May 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


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);