PDF Reseller/Registrar Domain Name API

Corp.

Reseller/Registrar Domain Name API

Table of contents

TABLE OF CONTENTS ...............................................................................................................1

INTRODUCTION .......................................................................................................................3

REQUIREMENTS........................................................................................................................4

IMPLEMENTATIONS .................................................................................................................6

General information .................................................................................................................................................. 6

Domain related operations ...................................................................................................................................... 7

Domain Availability Check (Resource path /Domain/Check) ............................................................................. 7

Domain Create (Resource path /Domain/Create) ................................................................................................ 8

Domain Update (Resource path /Domain/Update) ........................................................................................... 24

Domain Info (Resource path /Domain/Info) ....................................................................................................... 26

Domain Registry Status (Resource path /Domain/RegistryStatus) .................................................................. 28

Domain Transfer Initiate (Resource path /Domain/Transfer/Initiate) ............................................................. 29

Domain Transfer Retry (Resource path /Domain/Transfer/Retry) ................................................................... 31

Domain Transfer Cancel (Resource path /Domain/Transfer/Cancel)............................................................... 32

Domain Transfer Resend Initial Auth Email (Resource Path /Domain/Transfer/ResendAuthEmail) ........... 33

Domain Transfer History (Resource Path /Domain/Transfer/History)............................................................. 34

Domain Transfer Away Approve (Resource Path /Domain/TransferAway/Approve) ..................................... 36

Domain Transfer Away Reject (Resource Path /Domain/TransferAway/Reject) ............................................. 37

Domain Trade .Eu /.Fr (Resource Path /Domain/Trade).................................................................................... 38

Domain Registrar Lock Enable (Resource Path /Domain/RegistrarLock/Enable) ........................................... 39

Domain Registrar Lock Disable (Resource Path /Domain/RegistrarLock/Disable) ......................................... 40

Domain Registrar Lock Status (Resource Path /Domain/RegistrarLock/Status) ............................................. 41

Domain Private Whois Enable (Resource Path /Domain/PrivateWhois/Enable) ............................................. 42

Domain Private Whois Disable (Resource Path /Domain/PrivateWhois/Disable) ........................................... 43

Domain Private Whois Status (Resource Path /Domain/PrivateWhois/Status) .............................................. 44

Domain Push (Resource path /Domain/Push) .................................................................................................... 45

Domain Change Tag .uk (Resource Path /Domain/ChangeTag/DotUK) .............................................................. 46

Domain List (Resource path /Domain/List)......................................................................................................... 47

Domain Renew (Resource path /Domain/Renew).............................................................................................. 51

Domain Restoration (Resource Path /Domain/Restore) ................................................................................... 52

Domain Count (Resource path /Domain/Count) ................................................................................................ 53

Domain Registrant Email Verification Info (Resource path / Domain/RegistrantVerification/Info) ............. 54

Domain Registrant Email Verification Start (Resource path / Domain/RegistrantVerification/Send) ......... 55

Nameservers (host) related operations ............................................................................................................... 57

Domain Host Create (Resource path /Domain/Host/Create) ............................................................................ 57

Domain Host Info (Resource path /Domain/Host/Info) ..................................................................................... 58

Domain Host Update (Resource path /Domain/Host/Update) ......................................................................... 59

Domain Host Delete (Resource path /Domain/Host/Delete) ............................................................................ 60

Domain Host List (Resource path /Domain/Host/List) ...................................................................................... 61

Domain forwarding related operations ............................................................................................................... 64

Domain Url Forward Add (Resource path /Domain/UrlForward/Add) ............................................................. 64

Domain Url Forward Update (Resource path /Domain/UrlForward/Update) ................................................. 65

Domain Url Forward Remove (Resource path /Domain/UrlForward/Remove) ............................................... 66

Domain Url Forward List (Resource path /Domain/UrlForward/List) .............................................................. 67

Domain Email Forward Add (Resource path /Domain/EmailForward/Add) .................................................... 68

Domain Email Forward Update (Resource path /Domain/EmailForward/Update)......................................... 69

Domain Email Forward Remove (Resource path /Domain/EmailForward/Remove) ...................................... 69

Domain Email Forward List (Resource path /Domain/EmailForward/List) ...................................................... 70

DNS management related operations .................................................................................................................. 72

Domain DNS record Add (Resource path /Domain/DnsRecord/Add)............................................................... 72

Domain DNS record Remove (Resource path /Domain/DnsRecord/Remove) ................................................ 73

Domain DNS record Update (Resource path /Domain/DnsRecord/Update) ................................................... 75

Domain DNS record List (Resource path /Domain/DnsRecord/List) ................................................................ 76

Account related operations ................................................................................................................................... 78

Account Balance Get (Resource path /Account/Balance/Get) .......................................................................... 78

Account Default Currency Set (Resource path /Account/DefaultCurrency/Set) ............................................. 79

Account Default Currency Get (Resource path /Account/DefaultCurrency/Get) ............................................ 80

Account Price List Get (Resource path /Account/PriceList/Get) ....................................................................... 80

Account Configuration Get (Resource path /Account/Configuration/Get) ...................................................... 85

Account Configuration Set (Resource path /Account/Configuration/Set) ....................................................... 86

Introduction

This document explains our current approach in implementing an API, initially mainly for domain

name registrations and in the future for other products and services.

Our API is designed with simplicity in mind, limiting the complexity to the bare minimum. As a

consequence, we are currently not exposing our API using Webservices that may require a more

advanced understanding of programming.

In order to make it even easier we are offering several SDK for the most common coding languages

(PHP, Java, Perl, C++, etc...).

Our API is using the HTTPS GET and POST as underlying protocols and should therefore, even with no

advanced programming knowledge, be extremely easy to understand.

When conceiving our API we were inspired by the REST (Representational State Transfer) approach

(see ) however we do not pretend to be

fully RESTful or 100% compliant with REST.

As a consequence of adopting the REST approach we also call a command a resource and a

resource a command without any distinction. In our context a REST resource is no more and

no less than a command or what would be called a method using Java terminology.

Each submitted request, i.e. a command also called a resource, will return a set of values in TEXT

format and optionally you can obtain the same result in JSON and XML format by just setting a

parameter. Whereas for reasons of simplicity in this document we show results using the TEXT format

output we strongly recommend using JSON as output (see . Please don¡¯t get

mislead by the meaning of JSON, you will enjoy JSON even if you have no clue at all about Javascript,

JSON ¡°...is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for

machines to parse and generate...¡±)

Whichever your background or the output you chose, as long as you are able to post data to a

webpage and parsing the returned result you will have absolutely no problem in using our API.

Requirements

To access our API, you need an account which you create for free using our website

(), however if you are reading this document you most probably

already have an account.

You will then need to request an API key providing the IP from where you will access the API. Please

login to your account, under the menu 'My Account' click on 'Get my API key'. Before accessing this,

please make sure you have a positive balance under your account otherwise the API access will be

practically useless as all billable operations are debited from your prepaid balance.

For testing purposes, we have set a test server accepting connections from any IP and you

can use the test API Key and password provided below without the need to contact us.

We will then supply you with a personal API key and a password. The API key will be linked to your

account.

In the case where an operation using the API is subject to a cost the payment for that operation will

be settled directly through your prepaid account and you will be able to select, from the API itself,

which balance and currency shall be used. You will also be able to check your balance/s and change

your payment preferences (balance and currency).

Using the API simply consists in programmatically sending commands or more technically speaking,

posting data to a web page and parsing the result. Theoretically you could execute simple commands

such as checking the availability of a domain by entering an URL in your preferred web browser

without having to write a single line of code.

Here is a simple example to check if the domain is available:



m

where:

/Domain/Check is the command you are executing, also called a resource using REST

terminology.

and

?ApiKey=testapi&Password=testpass&Domain= are the parameter name and

values you are passing to the command /Domain/Check

NOTE: Parameter names and commands are NOT case sensitive. However parameter

values are case sensitive. During the beta test period Commands could be case

sensitive, so please use the same case as in the documentation.

Consequently:



m

and



om

are perfectly equivalent.

The following sections are describing each call to the API, the parameters required and the returned

results.

In order to experiment with our API, you can use the following credentials without requesting any

prior authorization:

Submitting url:

ApiKey=testapi

Password=testpass

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download