Namebay Documentation

Home/Namebay Documentation

Namebay Documentation

Welcome on Namebay’s documentations.

You will find there all the technical documentation on the Namebay APIs.

Namebay API :
Technical documentation about the Namebay APIs :

  • DNS API :
    This set of API commands is dedicated to reseller’s dns zones management using Namebay dns infrastructure. It allows resellers to manage the zones corresponding to their corresponding registered domain names.
    Note that the access to this feature requires either a per-domain advanced dns option service or the per reseller full access to api zone management feature.
    Please contact Namebay for more explanations on these features.
    NB: The serial value of every dns zone is automatically refreshed after each zone and / or record update.
    This documentation is available here : http://api.namebay.com/doc/NAMEBAY_API-dns_managment_v1.3-FR.pdf
  • Domain Names API :
    Namebay API is a set of commands that allow resellers to manage domain names and to access other services thanks to the credentials of you reseller account (the access is granted with the credential of your reseller account).
    This documentation is available here : http://api.namebay.com/doc/NAMEBAY_API-nom-domaine_v7.13.pdf
  • SSL API :
    Set of commands that allow resellers to buy and manage SSL Certificates thru the Namebay API.
    A reseller account is mandatory.

Overview of Namebay API :
Namebay has two types of commands :

  • XML commands over http post on https://api.namebay.com/api.aspx
  • SOAP commands

SOAP commands are detailed in the Domain Names API.

Xml commands are built with:

  • Credentials of your reseller account
  • Command name
  • Parameters
  • Response by the Namebay API

Command Syntax :

Request :

<api>
 <authentication>
  <login>…</login>
  <password>…</password>
 </authentication>
 <command>
  <command_name>
   <parameter_name>…</parameter_name>
   […]
  </command_name>
 </command>
</api>

Response :

<?xml version="1.0" encoding="utf-8"?>
<api>
 <response>
  <trID>…</trID>
  <result code="…">
   <msg>…</msg>
  </result>
 </response>
 <resData>
  <command_name>
   <output_parameter_name>…</output_parameter_name>
   […]
  </command_name>
 </resData>
</api>


 
Tags description :

Request :

<api> : API declaration tag.
 <authentication> :  authentication tag declaration.
  <login>’your API login’</login> : your login.
  <password>’your API password’ </password> : your password.
 </authentication> : authentication end tag.
 <command> : command description tag.
  <command_name> : command tag.
   <parameter_name>’parameter value’</parameter_name> : Name of the input parameter followed by its value. There are as many tags as parameters.
  </command_name> : command end tag.
 </command> : command description end tag.
</api> : API declaration end tag.

Response from Namebay :

<?xml version="1.0" encoding="utf-8"?> : XML declaration.
<api> : Beginning of an api response.
 <response> : response declaration.
  <trID>‘Transaction identifier’</trID> : An id generated by Namebay corresponding to the request.
  <result code="’"response code’"> : A result code with a message.
   <msg>’message’</msg> : The message
  </result> : result end tag.
 </response> : response end tag.
 <resData> : outputs tag declaration.
  <commandNameData> : command name.
   <outputName>’Value’ </outputName> : Outgoing parameter and its value. There are as many tags as parameters.
  </commandNameData> : end of command.
 </resData> : outputs end tag.
</api> : end of request.


 
Request Example : Contact_check

Request :

<api>
 <authentication>
  <login>MonLogin</login>
  <password>MonMotDePasse</password>
 </authentication>
 <command>
  <contact_check>
   <contact_id>A contact Identifier</contact_id>
  </contact_check>
 </command>
</api>

Response :

<?xml version="1.0" encoding="utf-8"?>
<api>
 <response>
  <trID>NBAY-API-508279318082006050401</trID>
  <result code="200">
   <msg>command completed successfully</msg>
  </result>
 </response>
 <resData>
  <contact_chkData>
   <contact_id available="1">A contact Identifier</contact_id>
  </contact_chkData>
 </resData>
</api>