Register

From Boxis.net API Docs
Revision as of 07:38, 30 May 2012 by Admin (Talk | contribs)

Jump to: navigation, search

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'


Example URL with POST values

https://boxis.net/xmlapi.php
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

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

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