Difference between revisions of "Register"

From Boxis.net API Docs
Jump to: navigation, search
(Example URL with POST values)
 
(41 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Domain Function: Register=
 
  
With this command, you are able to register your domain with boxis.net..... bla bla bla here
+
=Domain Function: register=
  
 +
With this command, you are able to register your domain with boxis.net.
  
=== Input params ===
 
{|
 
|-
 
| - domain::String::Domain name that you need to Register
 
|-
 
| - years::Integer::Number of years for which you wish to Register this domain name
 
|-
 
| - ns::Array of Strings::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. Possible values are: 1 or 0
 
|}
 
  
=== 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')''
<source lang="xml">
+
 
 +
*'''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
 +
 
 +
*'''domain'''::String - ''Domain name that you need to register''
 +
 
 +
*'''years'''::Integer - ''Number of years for which you wish to register this domain name''
 +
 
 +
*'''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. Possible values are: 1 or 0'
 +
 
 +
*'''registrant'''::Array of Strings (optional) - ''Registrant contact details. Possible array keys are: firstname, lastname, companyname, address1, address2, city, state, country, postcode, email, phonenumber'
 +
 
 +
*'''billing'''::Array of Strings (optional) - ''Billing contact details. Possible array keys are: firstname, lastname, companyname, address1, address2, city, state, country, postcode, email, phonenumber'
 +
 
 +
*'''admin'''::Array of Strings (optional) - ''Admin contact details. Possible array keys are: firstname, lastname, companyname, address1, address2, city, state, country, postcode, email, phonenumber'
 +
 
 +
*'''tech'''::Array of Strings (optional) - ''Tech contact details. Possible array keys are: firstname, lastname, companyname, address1, address2, city, state, country, postcode, email, phonenumber'
 +
 
 +
 
 +
== Example URL with POST values ==
 +
 
 +
<pre>
 +
http://api.boxis.net/
 +
POST: version=1.0&returntype=xml&timestamp=1337853736&username=your@mail.com&authcode=1234567890&section=domains&action=register&domain=test1.com&years=2&ns[1]=ns1.boxis.ch&ns[2]=ns2.boxis.ch
 +
      &protect-privacy=1&registrant[firstname]=John&registrant[lastname]=Doe&registrant[companyname]=company1&registrant[address1]=baker+street+5&registrant[address2]=&registrant[city]=NY&registrant[state]=N
 +
      & registrant[country]=USA&registrant[postcode]=2322&registrant[email]=mail1%40mail.com&registrant[phonenumber]=48551151565
 +
</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 28: Line 56:
 
   <params/>
 
   <params/>
 
   <timestamp>1335767184</timestamp>
 
   <timestamp>1335767184</timestamp>
</return>  
+
</return>
</source>
+
</pre>
===== Error =====
+
 
 +
==== Example in XML (Error) ====
 +
 
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<return>
 +
  <result>0</result>
 +
  <resulttxt>Error: {error description}</resulttxt>
 +
  <params/>
 +
  <timestamp>1335767184</timestamp>
 +
</return>
 +
</pre>
 +
 
 +
==== Example in JSON (Success) ====
 +
 
 +
<pre>
 +
{"result":"1",
 +
"resulttxt":"success",
 +
"params":[],
 +
"timestamp":1335777400}
 +
</pre>
 +
 
 +
==== Example in JSON (Error) ====
 +
 
 +
<pre>
 +
{"result":"0",
 +
"resulttxt":"Error: {error description}",
 +
"params":[],
 +
"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  = 'register';
 +
$params  = array(
 +
    'returntype' => 'xml',
 +
    'domain' => 'test1.com',
 +
    'years' => 2,
 +
    'ns[1]' => 'ns1.boxis.ch',
 +
    'ns[2]' => 'ns2.boxis.ch',
 +
    'protect-privacy' => 1,
 +
    'registrant[firstname]' => 'John',
 +
    'registrant[lastname]' => 'Doe',
 +
    'registrant[companyname]' => 'company1',
 +
    'registrant[address1]' => 'baker street 5',
 +
    'registrant[address2]' => '',
 +
    'registrant[city]' => 'NY',
 +
    'registrant[state]' => 'NY',
 +
    'registrant[country]' => 'USA',
 +
    'registrant[postcode]' => '2322',
 +
    'registrant[email]' => 'mail1@mail.com',
 +
    'registrant[phonenumber]' => '48551151565'
 +
);
 +
 
 +
/* 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);
 +
}
 +
/*
  
=== Example in Json  ===
+
</pre>
example in Json
+

Latest revision as of 12:53, 26 October 2012

Domain Function: register

With this command, you are able to register your domain with 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
  • domain::String - Domain name that you need to register
  • years::Integer - Number of years for which you wish to register this domain name
  • 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. Possible values are: 1 or 0'
  • registrant::Array of Strings (optional) - Registrant contact details. Possible array keys are: firstname, lastname, companyname, address1, address2, city, state, country, postcode, email, phonenumber'
  • billing::Array of Strings (optional) - Billing contact details. Possible array keys are: firstname, lastname, companyname, address1, address2, city, state, country, postcode, email, phonenumber'
  • admin::Array of Strings (optional) - Admin contact details. Possible array keys are: firstname, lastname, companyname, address1, address2, city, state, country, postcode, email, phonenumber'
  • tech::Array of Strings (optional) - Tech contact details. Possible array keys are: firstname, lastname, companyname, address1, address2, city, state, country, postcode, email, phonenumber'


Example URL with POST values

http://api.boxis.net/
POST: version=1.0&returntype=xml&timestamp=1337853736&username=your@mail.com&authcode=1234567890&section=domains&action=register&domain=test1.com&years=2&ns[1]=ns1.boxis.ch&ns[2]=ns2.boxis.ch
      &protect-privacy=1&registrant[firstname]=John&registrant[lastname]=Doe&registrant[companyname]=company1&registrant[address1]=baker+street+5&registrant[address2]=&registrant[city]=NY&registrant[state]=N
      & registrant[country]=USA&registrant[postcode]=2322&registrant[email]=mail1%40mail.com&registrant[phonenumber]=48551151565

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  = 'register';
$params   = array(
    'returntype' => 'xml',
    'domain' => 'test1.com',
    'years' => 2,
    'ns[1]' => 'ns1.boxis.ch',
    'ns[2]' => 'ns2.boxis.ch',
    'protect-privacy' => 1,
    'registrant[firstname]' => 'John',
    'registrant[lastname]' => 'Doe',
    'registrant[companyname]' => 'company1',
    'registrant[address1]' => 'baker street 5',
    'registrant[address2]' => '',
    'registrant[city]' => 'NY',
    'registrant[state]' => 'NY',
    'registrant[country]' => 'USA',
    'registrant[postcode]' => '2322',
    'registrant[email]' => 'mail1@mail.com',
    'registrant[phonenumber]' => '48551151565'
);

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