Hosting Scripts On Your
Server / Wholesale Plus Account
You can integrate our API into your site with a Reseller
Wholesale Plus Account. This is the
most advanced and flexible option for free
Private Label Reselling.
If you will be hosting the scripts on
your server you can download a ZIP file for Perl, PHP or ASP containing
the files that you will need to get started.
You can create an account in our development
environment to test our automated registration system using the domain
name registration code on your servers.
Below is a
review of some of the programming parameters involved with hosting
scripts on your server and integrating with our system.
How to Register Domain
Names
Follow this process to create a web site that
registers domain names using our automated domain name registration
system.
- Contact us and set up an account. You will
receive a username and password from us, and the IP of our test server.
- If you are in a Windows environment, Read the "
URL Interface COM Object" file for information on how to use the
provided COM object to register names using our system. Otherwise read
"Interfacing With Our URL Interface" below. You may test all you like
using the test server.
- Contact us when you have finished developing your
site. We will provide you with the IP of the live server, and you can
begin registering domain names in real time.
Interfacing With Our URL Interface
Our URL Interface allows clients to access our domain
name registration features from their own systems. This document will
describe how to interface programmatically. For a description of using
the Interface in a Windows environment using the supplied COM object,
see the document "URL Interface COM Object".
The HTTP Protocol
The server side of this protocol is simply an asp page running on IIS.
Although it is a web page, it is not meant to be accessed directly by
your users. It is meant to be accessed from your back end program
running on your web site. This is just to make it easier for you to
develop an interface to it.
HTTP requests are TCP connections to port 80 on the given server. After
you connect to the server, the HTTP request is sent as follows (example
URL string shown):
GET /interface.asp?command=check&tld=com&sld=mydomain&responsetype=text
HTTP/1.0
The URL string parameter will be described below. After you send the
request, the response will come back in the following format (example
data shown):
HTTP/1.1 200 OK
Server: Microsoft-IIS/4.0
Date: Mon, 10 Apr 2000 20:05:54 GMT
Content-Type: text/html
Set-Cookie: ASPSESSIONIDGQGGQGPQ=NJIFGMHCGPINKAKLLJCICJFN; path=/
Cache-control: private
Command=CHECK
RRPCode=210
RRPText=Domain name available
ErrCount=0
The header information may vary. A blank line signals the end of the
headers. The page is simply a list of name=value pairs (if debugging is
activated on the server, there may be additional text before the
name=value pairs. This can be ignored. Start parsing data when you
receive an ‘=’ char in the line). The server closes the connection after
it sends the page.
Parameters
The GET request requires that all parameters be passed in the URL. The
URL in the GET request will always start with:
/interface.asp?
Here is a list of all possible parameters and their use:
| Parameter |
Description |
| Uid |
Username |
| Pw |
Password |
| Command |
Command. See “commands” below |
| Sld |
Second level domain (i.e. “enom”) |
| Tld |
Top level domain (i.e. “com”) |
| Usedns |
Can specify default nameservers. One option is
to set to our nameservers. Otherwise use NS(x) (see below) to specify
nameservers. |
| NumYears |
Number of years to register a name for |
| Reference |
Unique reference number of use with GETRESULT |
| Getbalance |
Set to “1” to return balance with any command |
| Pageurl |
URL for SETPAGEURL |
| Responsetype |
Set to “text” |
| Domainpassword |
Password for SETPASSWORD |
| Accesslevel |
Access level for SETPASSWORD |
| NS1 .. NS12 |
Fill in with any number of nameservers. These
will be set when you register the name with PURCHASE |
| Address1 .. Address5 |
“From” addresses for FORWARDING |
| ForwardTo1 .. ForwardTo5 |
“To” addresses for FORWARDING |
RegistrantAddress1
RegistrantAddress2
RegistrantCity
RegistrantCountry
RegistrantEmailAddress
RegistrantFax
RegistrantFirstName
RegistrantJobTitle
RegistrantLastName
RegistrantOrganizationName
RegistrantPhone
RegistrantPostalCode
RegistrantStateProvince
RegistrantStateProvinceChoice |
Registrant information to be specified with
PURCHASE |
TechAddress1
TechAddress2
TechCity
TechCountry
TechEmailAddress
TechFax
TechFirstName
TechJobTitle
TechLastName
TechOrganizationName
TechPhone
TechPostalCode
TechStateProvince
TechStateProvinceChoice |
Tech contact information to be specified with
PURCHASE |
AdminAddress1
AdminAddress2
AdminCity
AdminCountry
AdminEmailAddress
AdminFax
AdminFirstName
AdminJobTitle
AdminLastName
AdminOrganizationName
AdminPhone
AdminPostalCode
AdminStateProvince
AdminStateProvinceChoice |
Admin contact information to be specified with
PURCHASE |
AuxBillingAddress1
AuxBillingAddress2
AuxBillingCity
AuxBillingCountry
AuxBillingEmailAddress
AuxBillingFax
AuxBillingFirstName
AuxBillingJobTitle
AuxBillingLastName
AuxBillingOrganizationName
AuxBillingPhone
AuxBillingPostalCode
AuxBillingStateProvince
AuxBillingStateProvinceChoice |
Aux billing information to be specified with
PURCHASE |
UseCreditCard
CreditCardNumber
CreditCardExpMonth
CreditCardExpYear
CCName
ChargeAmount
|
Credit card information to be specified with
PURCHASE/creditcard option |
Response Values
Here is a list of values that will be returned by the server and their
meaning:
| Value |
Description |
| Command |
The command that was executed |
| RRPCode |
RRP code returned from NSI |
| RRPText |
RRP text returned from NSI |
| ErrCount |
Number of errors |
| Err1 .. Err(x) |
Error descriptions. There will be ErrCount
number of these |
| Balance |
Your account balance |
Commands
These are the valid values for “Command”.
CHECK - Checks to see if a given
domain name is registered or not. Required parameters:
| Sld |
Second level domain name |
| Tld |
Top level domain name |
| RRPCode: |
| 210 |
Domain available |
| 211 |
Domain not available |
You can use the Check command to check .com .net and
.org all at the same time for a given SLD. Specify “*” for the TLD and
all top level domains will be checked. In response you will get: (where
<x> is a number from 1 to 3)
| Domain<x> |
Full domain name that was checked |
| RRPCode<x> |
RRP code for this domain check |
| RRPText<x> |
RRP text for this domain check |
PURCHASE -
Purchases (registers) a new domain name. Required parameters:
| Uid |
Your username |
| Pw |
Your password |
| Sld |
Second level domain name |
| Tld |
Top level domain name |
If you use the credit card processing option here
are the additional requirements:
| UseCreditCard |
yes |
| RegistrantAddress1 |
Registrants Address |
| RegistrantCity |
Registrant's City |
| RegistrantCountry |
Registrant's country |
| RegistrantEmailAddress |
Registrant's email |
| RegistrantFirstName |
Registrant's First name |
| RegistrantLastName |
Registrant's Last name |
| RegistrantPhone |
Registrant's phone |
| RegistrantPostalCode |
Registrant's Postal Code |
| RegistrantStateProvince |
Registrant's State or Province |
| CreditCardNumber |
Credit Card Number |
| CCType |
Credit Card Type |
| CreditCardExpMonth |
Expiration Month |
| CreditCardExpYear |
Expiration Year |
| CCName |
Name on Credit Card |
| ChargeAmount |
Amount charged per year |
You can optionally specify the number of years to
register the name by passing the parameter “NumYears”. If you do not
specify this, the default for your account is used instead.
Specify name servers either by setting Usedns or NS(x) params. If you do
not specify either, the domain name will not have any name servers.
Specify WhoIs information by setting the Registrant*, Admin*, Tech*, and
AuxBilling* parameters. You can specify any information you’d like. It
will show up when somebody does a WhoIs on the domain name.
If there were no errors and RRPCode was 200, then the domain name was
registered. Otherwise, there was an error (most likely the name was
already registered).
GETREGLOCK - Gets current staus of the
Register Lock. Required parameters:
| Uid |
Your username |
| Pw |
Your password |
| Sld |
Second level domain name |
| Tld |
Top level domain name |
Returns RegLock=1 if Locked, 0 otherwise.
SETREGLOCK - Sets
the register lock. Required parameters:
| Uid |
Your username |
| Pw |
Your password |
| Sld |
Second level domain name |
| Tld |
Top level domain name |
| Unlockregister |
set = 1 to unlock, if 0 or nothing name will be
locked |
GETRENEW - Gets
the renewal status of the name. Required parameters:
| Uid |
Your username |
| Pw |
Your password |
| Sld |
Second level domain name |
| Tld |
Top level domain name |
Returns RenewName = 1 if the name is set to be
auto-renewed, 0 otherwise. If ErrCount = 0 the command succeeded.
Otherwise check Err(x) values.
SETRENEW - Sets
the auto-renew flag. Required parameters:
| Uid |
Your username |
| Pw |
Your password |
| Sld |
Second level domain name |
| Tld |
Top level domain name |
| Renewflag |
Set = 1 to auto-renew. If 0 or nothing
auto-renew will not be set. |
Returns RenewName=1 if successful and the ErrCount
will be 0.
EXTEND - Extends
the registration period. Required parameters:
| Uid |
Your username |
| Pw |
Your password |
| Sld |
Second level domain name |
| Tld |
Top level domain name |
| NumYears |
Optional. If not set defaults to 1. |
FORWARDING - Sets
email forwarding addresses. Required parameters:
| Uid |
Your username |
| Pw |
Your password |
| Sld |
Second level domain name |
| Tld |
Top level domain name |
| Address(x) |
Email name (will be <name>@sld.tld) |
| ForwardTo(x) |
Full email address to forward to |
SETPAGEURL - Sets
URL forwarding for a domain. Required parameters:
| Uid |
Your username |
| Pw |
Your password |
| Sld |
Second level domain name |
| Tld |
Top level domain name |
| Pageurl |
URL to forward www.<sld>.<tld> to |
GETRESULT - Gets
the result of a previous command. Required parameters:
| Uid |
Your username |
| Pw |
Your password |
| Reference |
The same reference number you passed to the
original command. |
SETPASSWORD -
Sets the domain password for a given domain so that a client may log in
and have access to change host/email information. Required parameters:
| Uid |
Your username |
| Pw |
Your password |
| Sld |
Second level domain name |
| Tld |
Top level domain name |
| DomainPassword |
Password for the domain |
| AccessLevel |
“1” = all access, “0” = restricted access. |
.US and .BIZ Domains now
one-year minimum!