reseller

is added when reseller has a customer specific business

Register

Note

It is recommended, that you read TLD and their Contacts specific information, prior to continuing reading further:

Description

Registers a domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required

Domain name that you need to Register.

For an Internationalized Domain Name, refer to the supported character sets mentioned below:

Note

The domain name used in the API call can be in Unicode (the native language) or in Punycode format.

Example: The domain name can be provided as ѯҋ111 (Unicode) or xn--111-dkd4l (Punycode).

domain-name=ѯҋ111
domain-name=xn--111-dkd4l

years Integer Required Number of years for which you wish to Register this domain name.
ns Array of Strings Required The Name Servers of the domain name.
customer-id Integer Required The Customer for whom you wish to Register this domain name.
reg-contact-id Integer Required The Registrant Contact of the domain name.
admin-contact-id Integer Required

The Administrative Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .EU

  • .UK
tech-contact-id Integer Required

The Technical Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .EU

  • .UK
billing-contact-id Integer Required

The Billing Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .CA

  • .EU

  • .UK

  • .LONDON
invoice-option String Required This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:

  • NoInvoice: This will not raise any Invoice. The Order will be executed.

  • PayInvoice: This will raise an Invoice and:

    • if there are sufficient funds in the Customer's Debit Account, then the Invoice will be paid and the Order will be executed.

    • if there are insufficient funds in the Customer's Debit Account, then the Order will remain pending in the system.

  • KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be executed.

  • OnlyAdd: This will raise an Invoice for the Customer to pay later. The registration action request will remain pending.
purchase-privacy Boolean optional

Adds the Privacy Protection service for the domain name.

Privacy Protection is not supported for the following TLDs (extensions):

  • .CA

  • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  • .EU

  • .IN

  • .PRO

  • .UK

  • .US
protect-privacy Boolean Optional

Enables / Disables the Privacy Protection setting for the domain name.
attr-name Map[name] Optional Mapping key of the extra details needed to register a domain name. Refer the description of attr-value.
attr-value Map[value] Optional

Mapping value of the extra details required to register a domain name. This together with attr-name shall contain the extra details.

  • To register an Internationalized Domain Name:

    idnLanguageCode: While registering an IDN, you need to provide the corresponding language code:

    • .BIZ IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Chinese - zh

      • Danish - da

      • Finnish - fi

      • German - de

      • Hungarian - hu

      • Icelandic - is

      • Japanese - jp

      • Korean - ko

      • Lithuanian - lt

      • Latvian - lv

      • Norwegian - no

      • Polish - pl

      • Portuguese - pt

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=ko

    • .CA IDN: The language code needs to be mentioned as fr.

      attr-name1=idnLanguageCode&attr-value1=fr

    • .CO IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Chinese - zh

      • Danish - da

      • Finnish - fi

      • Icelandic - is

      • Japanese - jp

      • Korean - ko

      • Norwegian - no

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=da

    • .COM / .NET IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.

      attr-name1=idnLanguageCode&attr-value1=aze

    • .EU IDN: The language code needs to be mentioned as latin.

      attr-name1=idnLanguageCode&attr-value1=latin

    • .INFO IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Danish - da

      • German - de

      • Hungarian - hu

      • Icelandic - is

      • Korean - ko

      • Latvian - lv

      • Lithuanian - lt

      • Polish - pl

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=ko

    • .NAME IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.

      attr-name1=idnLanguageCode&attr-value1=aze

    • .ORG IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Chinese - zh-cn (for IDN.org domain name and .机构 domain name - the Chinese IDN for .org)

      • Cyrillic - ru (for .орг domain name - the Russian IDN for .org)

      • Danish - da

      • German - de

      • Hindi - hin-deva (for .संगठन domain name - the Hindi IDN for .org)

      • Hungarian - hu

      • Icelandic - is

      • Korean - ko

      • Latvian - lv

      • Lithuanian - lt

      • Polish - pl

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=ko

  • To register a Domain Name in the Sunrise Phase:

    • phase: Mention the phase as sunrise.

      attr-name1=phase&attr-value1=sunrise

    • smd: Pass the content of the smd file as the value for this attr-name.

      attr-name2=smd&attr-value2=<smd_file_content>

  • To register a Domain Name in the Pre-Registration Phase:

    phase: Mention the phase as

    • prega for regular pre-registration

      attr-name1=phase&attr-value1=prega

    • landrush for priority pre-registration

      attr-name1=phase&attr-value1=landrush

  • To register a domain name that has a Trademark Claim:

    tm-claim: Mention the value for this additional parameter as accepted.

    attr-name1=tm-claim&attr-value1=accepted


  • To register a 2nd Level .UK domain name with a non UK Registrant Contact, specify an additional Service Contact: See details:

    service-contact: Mention the Contact ID of the Service Contact.

    attr-name1=service-contact&attr-value1=0

  • To register a .LAWYER, .ATTORNEY domain name:

    REGULATORY BODY: The Regulatory Body information is collected during the registration process. This information is only required if the registrant is offering professional services related to the TLD

    attr-name1=regulatorybody&attr-value1=<regulatory-body-here>

  • To register a .DEGREE, .ENGINEER, .MORTGAGE, .MARKET, .SOFTWARE, .NAVY, .VET, .ARMY, .GIVES, .AIRFORCE, .BIO, .ARCHI domain name:

    TNC: stands for Terms and Conditions

    Any other value for attr-value1 except y or Y will result in an error "Please accept the Terms & Conditions".

    attr-name1=tnc&attr-value1=y

  • To register a .DENTIST domain name:

    TNC: stands for Terms and Conditions

    Any other value for attr-value1 except y or Y will result in an error "Please accept the Terms & Conditions".

    REGULATORY BODY: The Regulatory Body information is collected during the registration process. This information is only required if the registrant is offering professional services related to the TLD

    attr-name1=tnc&attr-value1=y&attr-name2=regulatorybody&attr-value2=<regulatory-body>

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice

Example Test URL Request for Registering a Domain Name with Privacy Protection


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&purchase-privacy=true

Example Test URL Request for Registering a Domain Name in the Sunrise Phase


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domains1.bike&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customerid=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=phase&attr-value1=sunrise&attr-name2=smd&attr-value2=<smd_file_content>

Example Test URL Request for Registering a .COM IDN


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=ѯҋ112.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=idnLanguageCode&attr-value1=aze

Example Test URL Request for Registry Premium domain registration


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice
&attr-name1=premium&attr-value1=true

Example Test URL Request for domain registration in EAP


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=eap&attr-value1=true

Example Test URL Request for Registry Premium domain registration in EAP


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=premium&attr-value1=true&attr-name2=eap&attr-value2=true

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Domain Registration Action (actiontypedesc)

  • Action ID of the Domain Registration Action (eaqid)

  • Domain Registration Action Status (actionstatus)

  • Description of the Domain Registration Action Status (actionstatusdesc)

  • Invoice ID of the Domain Registration Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Domain Registration Order (customerid)

  • Privacy Protection Details (privacydetails)

    • Domain Name (description)

    • Order ID of the Domain Registration Order (entityid)

    • Action Type (actiontype)

    • Description of the Privacy Protection Purchase Action (actiontypedesc)

    • Action ID of the Privacy Protection Purchase Action (eaqid)

    • Privacy Protection Purchase Action Status (actionstatus)

    • Description of the Privacy Protection Purchase Action Status (actionstatusdesc)

    • Invoice ID of the Privacy Protection Purchase Invoice (invoiceid)

    • Selling Currency of the Reseller (sellingcurrencysymbol)

    • Transaction Amount in the Selling Currency (sellingamount)

    • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

    • Customer ID associated with the Domain Registration Order (customerid)

Note

  • invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

  • Details under privacydetails will be returned only if purchase-privacy is set to true in the Domain Registration API call

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

API Requests

Note

It is recommended, that you read TLD and their Contacts specific information, prior to visiting the below-mentioned Domains and Contacts related
links. See details

The Reseller API is organized into the following type of methods:

Domains

Use these methods to Search, Register or Renew domain names, etc.

Contacts

Use these methods to add Contacts to domain names, modify existing Contacts, etc.

Customers

Use these methods to add Customers, modify Customer details, etc.

Resellers

Use these methods to add Resellers, modify Reseller details, etc.

Free Email

Use this method to activate Free Email service.

Single Domain Hosting

Use these methods to add Single Domain Hosting Orders.

Multi Domain Hosting

Use these methods to add Multi Domain Hosting Orders.

Reseller Hosting

Use these methods to add Reseller Hosting Orders.

VPS

Use these methods to add VPS Orders.

Hosting

Use these methods to add Email Hosting or Web Hosting Orders.

Domain Forward

Use these methods to activate the Domain Forwarding service.

DNS

Use these methods to activate the DNS service for a domain name.

Website Builder

Use these methods to get details of various Website Builder packages and add a Website Builder package for a Customer.

Digital Certificates

Use these methods to add a Digital Certificate Order, get details of a Digital Certificate Orders, delete Digital Certificate Order, etc.

Products

Use these methods to check availability of a product for the specified domain name, get details of Active products, etc.

Common

Use these methods to know Pricing details for a product, know the allowed Payment Gateways for each Customer, etc.

Domains

Note

It is recommended, that you read TLD and their Contacts specific information, prior to continuing reading further:

Check Availability

Checks the availability of specified domain name(s).

Check Availability - IDN

Checks the availability of the specified Internationalized Domain Name(s) (IDN).

Check Availability - Premium Domains

Checks the availability of Premium Domain Names based on the specified keyword.

Suggest Names

Suggests domain names for the given keyword.

Register

Registers a specified domain name.

Transfer

Transfers a specified domain name to you.

Validating a Transfer Request

Checks if a transfer request is valid for the specified domain name.

Renew

Renews the specified Domain Registration Order for multiple years.

Search

Gets a list of Domain Registration Orders, which suit the Search criteria, along with the details.

Get Customer Default Name Servers

Gets a list of the default Name Servers for the Customer.

Get Order Id

Gets the Order Id of a Registered domain name.

Get Registration Order Details

Gets the details of a Domain Registration Order.

Modify Name Servers

Modifies the Name Servers of the specified Domain Registration Order.

Add Child Name Server

Adds Child Name Servers for the specified Domain Registration Order.

Modify Child Name Server Host Name

Modifies the name of the Child Name Server of the specified Domain Registration Order.

Modify Child Name Server IP Address

Modifies the IP addresses associated with the specified Child Name Server of the specified Domain Registration Order.

Deleting Child Name Server IP Address

Deletes the IP address associated with the specified Child Name Server of the particular Domain Registration Order.

Modify Contacts

Modifies the Contacts of the specified Domain Registration Order.

Modify Privacy Protection Status

Changes the Privacy Protection status of the specified Domain Registration Order.

Modify Auth-Code

Modifies the Auth-Code of the specified Domain Registration Order.

Apply Theft Protection Lock

Applies the Theft Protection lock on the specified Order.

Remove Theft Protection Lock

Removes the Theft Protection lock on the specified Order.

Get the List of Locks Applied on a Domain Name

Gets the list of locks applied on a Domain Registration Order.

Get TEL CTH Login Details

Gets the CTH Login Details for the specified .TEL Domain Registration Order.

Modify TEL Whois Preference

Modifies the Whois preference of the .TEL Domain Registration Order.

Resend Transfer Approval Mail

Resends the Transfer Approval mail for the specified Order.

Release a UK Domain Name

Releases (transfer-out) the specified .UK domain name to the specified Registrar tag.

Cancel Transfer

Cancels the Transfer-In Order that is awaiting Admin approval.

Suspend

Applies the Suspension on the specified Domain Registration Order.

Unsuspend

Removes the Suspension on the specified Domain Registration Order.

Delete

Deletes the specified Domain Registration Order.

Restore

Restores the specified Domain Registration Order.

Rechecking NS with .DE Registry

Recheck zone configuration with .de registry of the expired .DE Domain Registration Order.

Associating/Dissociating .XXX Membership Token/ID

Allows associating/dissociating the Membership Token/ID provided by the .XXX Registry, to a Domain Registration Order.

Renew

Description

Renews the specified Domain Registration Order for specified number of years.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of the Domain Registration Order that you want to Renew.
years Integer Required Number of years for which you want to Renew this Order.
exp-date Integer Required Current Expiry Date of the Order in epoch time format.
purchase-privacy Boolean optional

Renews the Privacy Protection service for the domain name.

Privacy Protection is not supported for the following TLDs (extensions):

  • .CA

  • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  • .EU

  • .IN

  • .PRO

  • .UK

  • .US
invoice-option String Required This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:

  • NoInvoice: This will not raise any Invoice. The Order will be renewed.

  • PayInvoice: This will raise an Invoice and:

    • if there are sufficient funds in the Customer's Debit Account, then the Invoice will be paid and the Order will be renewed.

    • if there are insufficient funds in the Customer's Debit Account, then the Order will remain pending in the system.

  • KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be renewed.

  • OnlyAdd: This will raise an Invoice for the Customer to pay later. The renewal action request will remain pending.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/renew.json?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036&invoice-option=NoInvoice

Example Test URL Request for Renewing a Domain Name with Privacy Protection


https://test.httpapi.com/api/domains/renew.json?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036&invoice-option=NoInvoice&purchase-privacy=true

Example Test URL Request for Registry Premium domain renewal


https://test.httpapi.com/api/domains/renew.json?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036&invoice-option=NoInvoice&attr-name1=premium&attr-value1=true

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Name Order (entityid)

  • Action Type (actiontype)

  • Description of the Domain Renewal Action (actiontypedesc)

  • Action ID of the Domain Renewal Action (eaqid)

  • Domain Renewal Action Status (actionstatus)

  • Description of the Domain Renewal Action Status (actionstatusdesc)

  • Invoice ID of the Domain Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer ID associated with the Domain Name Order (customerid)

  • Privacy Protection Details (privacydetails)

    • Domain Name (description)

    • Order ID of the Domain Registration Order (entityid)

    • Action Type (actiontype)

    • Description of the Privacy Protection Purchase Action (actiontypedesc)

    • Action ID of the Privacy Protection Purchase Action (eaqid)

    • Privacy Protection Purchase Action Status (actionstatus)

    • Description of the Privacy Protection Purchase Action Status (actionstatusdesc)

    • Invoice ID of the Privacy Protection Purchase Invoice (invoiceid)

    • Selling Currency of the Reseller (sellingcurrencysymbol)

    • Transaction Amount in the Selling Currency (sellingamount)

    • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

    • Customer ID associated with the Domain Registration Order (customerid)

Note

  • invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

  • Details under privacydetails will be returned only if purchase-privacy is set to true in the Domain Registration API call

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Deleting a domain name

Description

Deletes the specified Domain Registration Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of the Domain Registration Order that you want to delete

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/delete.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the below details:

  • Action ID of the Order Deletion Action (eaqid)

  • Order Deletion Action Status (actionstatus)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Note

A success status does not indicate that the domain was deleted. It indicates that the API call was accepted and passed all validations. You can use this method to get the status of the deletion action.

HTTP API

Introduction

The HTTP API provides a simple way to integrate the functionality See details of our Reseller platform with your Storefront, Control Panel or Application.
You can leverage existing HTTP libraries available in almost all programming languages and try out or test the API easily using your favorite browser.

Right now, the HTTP API is available for free, and is subject to limits on request volume. If your requirements are above and beyond our standard
usage policies See details, please get in touch with us.

Getting Started

Note

  • It is a good practice to URL encode all values when sending them via the HTTP API. This is especially required when Customer details, Sub-Reseller details, Contact details, Passwords, etc.
    contain special characters.

    Additional Information

    HTML URL Encoding Reference

  • The various entities in our system require specific validation for usage. See details

Before you can start making HTTP API requests, for security reasons, you must first register the IP addresses from where you will be accessing the API. You will be able to access the API only from these IPs. See details

Subscribe to reseller