![]() |
domorder
Domain Products
Getting the Reseller Pricing
Description
Gets the Reseller Slab Pricing.
It is recommended you cache all pricing information to ensure you do not have to send API queries to the platform. As there are a huge number of products, the accompanying data may cause longer wait time than usual.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| reseller-id | Integer | Optional | Reseller ID of the Reseller whose Slab Pricing has to be retrieved. By default, Pricing of the current user will be retrieved. |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/products/reseller-price.json?auth-userid=0&api-key=key
Response
Returns a hash map with the Slab based Selling Price for the specified Reseller or the Reseller whose authorization details are used. The response structure will be:
Domain Names (TLDs)
"productkey":
{
"slab-order":
{
"pricing":
{
"action-name":
{
"tenure-in-years":"price"
}
}
"category":
{
"slab-category":
{
"name":"category-name",
"quantity":"category-quantity"
}
}
}
}
Example:
"domcno":
{
"0":
{
"pricing":
{
"addtransferdomain":
{
"1":"0.0"
},
"restoredomain":
{
"1":"0.0"
},
"addnewdomain":
{
"1":"0.0"
},
"renewdomain":
{
"1":"0.0"
}
},
"category":
{
"category2":
{
"name":"receipts",
"quantity":"0.0"
},
"category1":
{
"name":"hosting",
"quantity":"0.0"
}
}
}
}
Web Services
"hosting":
{
"productkey":
{
"bandid":
{
"pricing":
{
"action":0.0,
"ssl":0.0
}
"description":
{
"parameter":value
}
}
}
}
Example:
"hosting":
{
"email_plan":
{
"1":
{
"pricing":
{
"renew":0.0,
"add":0.0
},
"description":
{
"no_of_mail_accounts":5,
"default":false
}
}
},
"websitebuilder_plan":
{
"1":
{
"pricing":
{
"renew":0.0,
"add":0.0
},
"description":
{
"no_of_mail_accounts":1,
"default":true,
"webspace":100,
"noofpages":10
}
}
}
}
Single Domain Linux Hosting
"productkey":
{
"bandid":
{
"pricing":
{
"action":0.0,
"ssl":0.0
}
"description":
{
"parameter":value
}
}
}
Example:
US Server
"singledomainhostinglinuxus":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}
India Server
"singledomainhostinglinuxin":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}
Single Domain Windows Hosting
"productkey":
{
"bandid":
{
"pricing":
{
"action":0.0,
"ssl":0.0
}
"description":
{
"parameter":value
}
}
}
Example:
US Server
"singledomainhostingwindowsus":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}
India Server
"singledomainhostingwindowsin":
{
"1":
{
"pricing":
{
"renew":0.0,
"ssl":0.0,
"add":0.0
}
"description":
{
"no_of_mail_accounts":-1,
"default":true,
"bandwidth":-1,
"webspace":-1
}
}
}
Multi Domain Linux Hosting
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US Server
"multidomainhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
India Server
"multidomainhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Multi Domain Windows Hosting
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US Server
"multidomainwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
India Server
"multidomainwindowshostingin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Reseller Linux Hosting
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US Server
"resellerhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
India Server
"resellerhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Reseller Windows Hosting
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US Server
"resellerwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Dedicated Linux
"productkey":
{
"addons":
{
"addon1-name":price,
"addon2-name":price
},
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}
Example:
"dedicatedserverlinuxus":
{
"addons":
{
"storage_1":0.0,
"cpanel":0.0,
"whmcs":0.0,
"ipaddress":0.0,
"storage_5":0.0,
"storage_4":0.0,
"storage_3":0.0,
"storage_2":0.0
},
"plans":
{
"105":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"106":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}
Getting the Customer Pricing
Description
Gets the generic Customer Pricing or a particular Customer's Cost Price if the Customer ID is provided.
It is recommended you cache all pricing information to ensure you do not have to send API queries to the platform. As there are a huge number of products, the accompanying data may cause longer wait time than usual.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| customer-id | Integer | Optional | Customer ID of the Customer whose Cost Price has to be retrieved. By default, generic Customer Pricing will be retrieved. |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/products/customer-price.json?auth-userid=0&api-key=key
Response
Returns a hash map with the generic Customer Pricing or the specified Customer's Cost Price. The response structure will be:
Domain Names (TLDs)
"productkey":
{
"action-name":
{
"tenure-in-years":"price"
}
}
Example:
"dotnet":
{
"addtransferdomain":
{
"1":"0.0"
},
"restoredomain":
{
"1":"0.0"
},
"addnewdomain":
{
"1":"0.0"
},
"renewdomain":
{
"1":"0.0"
}
}
Web Services
"hosting":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":0.0
}
}
Example:
"hosting":
{
"0":
{
"renew":
{
"12":0.0,
"24":0.0
},
"ssl":0.0,
"add":
{
"12":0.0,
"24":0.0
}
},
"1":
{
"renew":
{
"12":0.0,
"24":0.0
},
"add":
{
"12":0.0,
"24":0.0
}
}
}
Single Domain Linux Hosting
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US Server
"singledomainhostinglinuxus":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
India Server
"singledomainhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Single Domain Windows Hosting
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US Server
"singledomainhostingwindowsus":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
India Server
"singledomainhostingwindowsin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Multi Domain Linux Hosting
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US Server
"multidomainhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
India Server
"multidomainhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Multi Domain Windows Hosting
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US Server
"multidomainwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
India Server
"multidomainwindowshostingin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Reseller Linux Hosting
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US Server
"resellerhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
India Server
"resellerhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Reseller Windows Hosting
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US Server
"resellerwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Dedicated Server Linux
"productkey":
{
"addons":
{
"addon1-name":price,
"addon2-name":price
},
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}
Example:
"dedicatedserverlinuxus":
{
"addons":
{
"storage_1":0.0,
"cpanel":0.0,
"whmcs":0.0,
"ipaddress":0.0,
"storage_5":0.0,
"storage_4":0.0,
"storage_3":0.0,
"storage_2":0.0
},
"plans":
{
"105":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
},
"106":
{
"renew":
{
"1":0.0
},
"add":
{
"1":0.0
}
}
}
}
Listing All Orders under your Reseller Account
Follow the below mentioned instructions to view all Orders within your Reseller account with firstfoot Interactive Pvt Ltd.:
-
Login to your Control Panel. See details
-
In the Menu, point to Products and then click List All Orders.
-
This would list all Orders under your Reseller account. You may further tweak these results by submitting one or more of the following parameters:
-
Belonging to: You may choose to view Orders associated with a domain name or belonging to a Customer or a Sub-Reseller. Choose the appropriate option from the drop-down menu and mention either the domain name / Order ID or the Customer Username / ID or the Sub-Reseller Username / ID.
-
For Product: Select the desired Product from the drop-down menu.
NoteIn order to search for Single Domain Linux Hosting and/or Single Domain Windows Hosting Orders, select the option as Single Domain Hosting.
In order to search for Multi Domain Linux Hosting and/or Multi Domain Windows Hosting Orders, select the option as Multi Domain Hosting.
Similarly, in order to search for Reseller Linux Hosting and/or Reseller Windows Hosting Orders, select the option as Reseller Hosting.
-
With Status: Select the status as Any, Active, InActive or Suspended.
-
Expiry: You may choose to list Orders based on their Expiry status. Select Any, Expired or Expiring in certain number of days.
-
Purchased between: You may choose to list Orders based on their purchase date. Select the Start Date and End Date to search within this date range.
-
Include Sub-Reseller's results: You may include in the list all Orders belonging to your Sub-Resellers, by selecting this check box.
-
You may quickly list Orders belonging to your Customers, by selecting any of the below mentioned Auto Filters:
-
List all Orders: This will list all Orders.
-
Orders Expiring in next 30 days: This will list all Orders expiring in the next 30 days.
-
Expired Orders: This will list all expired Orders.
-
All Pending Orders: This will list all pending Orders.
The list of Orders that is displayed mentions domain names under the following sortable column heads:
-
Domain Name: This is the domain name of the Order. Clicking the domain name link of any Order will lead you to the Overview section. Clicking the Product specific tab in the Overview section will lead you to the Order Details view, from where you may manage this Order.
-
Product: This represents the Product category this Order belongs to. A single domain name may belong to multiple Product categories depending upon how many Products are purchased for the same.
For example, yourdomain.com may be visible under both Domain Registration as well as another Product if that Product has been purchased for yourdomain.com.
-
Expiry: This indicates the Expiry Date of the Order. For Orders that have expired, the Expiry Date would be displayed in red.
-
Deletion: This indicates the Deletion Date of the Order. For Orders that have expired, the Deletion Date would be displayed in red.
-
Cust. ID: This is the Customer ID of the Customer managing that particular Order. If the Customer is your immediate Customer, then you may click the Customer ID to view and manage your Customer
details. -
Resell. ID: If the Order belongs to your Customer, then this would display You; else it would display that Sub-Reseller's ID whose Customer the Order belongs to. Besides the
Sub-Reseller ID, you would be displayed an icon indicating that this Order belongs to your Sub-Reseller or his/her Sub-Reseller chain. You may view the entire Sub-Reseller chain the Order is associated with, by placing your mouse pointer over this icon.
Clicking the domain name link corresponding to any Order will open up its Overview. Then click the Product specific tab to reach the Order Information view, from where you can perform any modifications to the Order.
Listing All Orders under your Customer Account
Follow the below mentioned instructions to view all Orders within your Customer account with firstfoot Interactive Pvt Ltd.:
-
Login to your Control Panel. See details
-
In the Menu, point to Manage Orders and then click List/Search Orders.
-
This would list all Orders under your Customer account. You may further tweak these results by submitting one or more of the following parameters:
-
Name / Order ID: You may choose to view Orders associated with a domain name. Mention the domain name / Order ID here.
-
For Product: Select the desired Product from the drop-down menu.
NoteIn order to search for Single Domain Linux Hosting and/or Single Domain Windows Hosting Orders, select the option as Single Domain Hosting.
In order to search for Multi Domain Linux Hosting and/or Multi Domain Windows Hosting Orders, select the option as Multi Domain Hosting.
Similarly, in order to search for Reseller Linux Hosting and/or Reseller Windows Hosting Orders, select the option as Reseller Hosting.
-
With Status: Select the status as Any, Active, InActive or Suspended.
-
Expiry: You may choose to list Orders based on their Expiry status. Select Any, Expired or Expiring in certain number of days.
-
Purchased between: You may choose to list Orders based on their purchase date. Select the Start Date and End Date to search within this date range.
-
You may quickly list Orders by selecting any of the below mentioned Auto Filters:
-
List all Orders: This will list all Orders.
-
Orders Expiring in next 30 days: This will list all Orders expiring in the next 30 days.
-
Expired Orders: This will list all expired Orders.
-
All Pending Orders: This will list all pending Orders.
The list of Orders that is displayed mentions domain names under the following sortable column heads:
-
Domain Name: This is the domain name of the Order. Clicking the domain name link of any Order will lead you to the Order Details view, from where you may manage this Order.
-
Product: This represents the Product category this Order belongs to. A single domain name may belong to multiple Product categories depending upon how many Products are purchased for the same.
For example, yourdomain.com may be visible under both Domain Registration as well as another Product if that Product has been purchased for yourdomain.com.
-
Expiry: This indicates the Expiry Date of the Order. For Orders that have expired, the Expiry Date would be displayed in red.
Clicking the domain name link corresponding to any Order will open up its Overview. Then click the Product specific tab to reach the Order Information view, from where you can perform any modifications to the Order.
Changing your Personal Identification Number (PIN)
When you sign up for a Customer Account with firstfoot Interactive Pvt Ltd.,
an email containing the Account details will be sent to you. The Account details
include a numeric code known as Personal Identification Number (PIN).
The PIN will also be listed in the Customer
Profile Details view, which can be accessed by clicking the
icon at the top right corner of the page and then
clicking Your Account & Security within your Customer Control Panel. firstfoot Interactive Pvt Ltd.
may request you to authenticate yourself through this PIN, when you request
support.
You can easily modify your Personal
Identification Number (PIN) by following the below
process:
-
Login to your Control Panel. See details
-
Click on the
icon at the top right corner of the page and then click on Your Account & Security. -
On the Account & Security page, under the Security section, click on View / Change your PIN.
-
In the modal window click on the Change link and enter a new PIN.
-
The PIN should consist of 4 numeric characters.
-
Change the PIN on a regular basis.
-
Avoid using a PIN that contains personal information (social security number, birth date, etc.).
-
Avoid using repeating (1111) or sequential (1234) numbers.
-
Do not disclose your PIN to any unauthorized person.
NoteYou need to consider the following, in relation with your Personal Identification Number (PIN):
-
-
Click on the Change PIN button to submit your change.
Home
Welcome to the firstfoot Interactive Pvt Ltd. Support Knowledge Base. Here, we have listed detailed information regarding all our current Product and Service offerings and answers to possibly all your queries. The firstfoot Interactive Pvt Ltd. Support KB has been divided into categories indicating a particular Interface or a particular Product/Service. These have been further logically divided into sub-categories and answers, detailing a particular action or query.
In the event, you are unable to locate a particular answer, please make use of the Search box provided on the top-left of the page or inform our Support Team at http://billing.techzoneindia.com
Modifying the Privacy Protection Status
Description
Changes the Privacy Protection status of 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 whose privacy protection you want to change. |
| protect-privacy | Boolean | Required | Enable / Disable Privacy Protection service. Possible values are: true or false. |
| reason | String | Required | The reason to enable / disable Privacy Protection. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/domains/modify-privacy-protection.json?auth-userid=0&api-key=key&order-id=0&protect-privacy=true&reason=somereason
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 Privacy Protection Modification Action (actiontypedesc)
-
Action ID of the Privacy Protection Modification Action (eaqid)
-
Privacy Protection Modification Action Status (actionstatus)
-
Description of the Privacy Protection Modification 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)
invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will be returned even if the Selling Price for Privacy Protection is set to zero, since a zero priced Invoice will be raised while enabling Privacy protection.
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Check Availability
Description
Checks the availability of the specified domain name(s).
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| domain-name | Array of Strings | Required | Domain name(s) that you need to check the availability for |
| tlds | Array of Strings | Required | TLDs for which the domain name availability needs to be checked See details |
HTTP Method
GET
Example Test URL Request
https://domaincheck.httpapi.com/api/domains/available.json?auth-userid=0&api-key=key&domain-name=domain1&domain-name=domain2&tlds=com&tlds=net
Response
Returns a hash map containing domain name availability status for the requested TLDs:
-
Domain Availability Status (status)
-
available - domain name available for registration
-
regthroughus - domain name currently registered through the Registrar whose connection is being used to check the availability of the domain name
-
regthroughothers - domain name currently registered through a Registrar other than the one whose connection is being used to check the availability of the domain name. If you wish to manage such a domain name through your Reseller / Registrar Account, you may pass a Domain Transfer API call. See details
-
unknown - returned, if for some reason, the Registry connections are not available. You should ideally re-check the domain name availability after some time.
Note-
In case of Donuts TLDs, domain name availability can be checked for a maximum of 5 domain names per Donuts TLD group in one API call. Including more than 5 domain names belonging to the same Donuts TLD group in an API call will return the status as unknown for all the domain names.
Additional Information -
In case of .CA TLD, domain name availability can be checked for a maximum of 15 strings in one API call. Including more than 15 strings in an API call will return the status as unknown for all the strings.
-
-
-
Trademark Claims Key (tm-claims-key) - will be returned only if the domain name is available and Trademark for that domain name is listed in the Trademark Clearinghouse database
-
Premium Names (costHash) - A hash map will be returned only if the
domain is a premium name along with the pricing of the domain ("create",
"renew", "transfer") and the selling currency symbol -
Early Access Program (costHash) - A hash map will be returned only
if the domain is in EAP along with the early access fee
("early_access_fee") and the selling currency symbol. The early access fee
is the non-refundable component which needs to added to the selling price
of the domain -
3rd Level .UK domain name (ror) - will be returned for an available 2nd Level .UK domain name, if the corresponding 3rd Level .UK domain name already exists. Currently, a 2nd Level .UK domain name can only be registered by the person/entity that owns the 3rd Level .UK domain name, if it already exists.
NoteFor .UK availability check, the API call need to have only one domain name. Otherwise, the ror parameter will not be returned in the result.
Register
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). |
||||||
| 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:
|
||||||
| tech-contact-id | Integer | Required |
The Technical Contact of the domain name. Note
Pass -1 for the following TLDs:
|
||||||
| billing-contact-id | Integer | Required |
The Billing Contact of the domain name. Note
Pass -1 for the following TLDs:
|
||||||
| invoice-option | String | Required | This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:
|
||||||
| purchase-privacy | Boolean | optional |
Adds the Privacy Protection service for the domain name. Privacy Protection is not supported for the following TLDs (extensions):
|
||||||
| 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 a Domain Name in the Sunrise Phase:
To register a Domain Name in the Pre-Registration Phase: phase: Mention the phase as
To register a domain name that has a Trademark Claim: tm-claim: Mention the value for this additional parameter as accepted. To register a .ASIA domain name: cedcontactid: While registering a .ASIA domain name, 'Charter Eligibility Declaration Contact ID' is mandatory. This parameter represents the CED To register a .AU domain name:
To register a .BR (third level) domain name: organisationId: Only Brazilian nationals or organizations can register .BR domains. Hence, a tax ID (CPF in case of an individual contact) or an organisation ID (CNPJ in case of a company contact) of the person/organisation needs to be supplied. The tax/organization ID must either not be currently registered in our database or it should be a transferred authority to the registrar through the .BR registry web interface. In addition, depending on the contact, you will need to specify the “type” as BrOrgContact (for the Registrant contact) or BrContact (for the Admin/Technical/Billing contact). A BrgOrgContact will need the following additional attributes:
To register a .CN domain name: If the Registrant plans on hosting the domain name in China, he/she needs to ensure that he/she has a valid MIIT ICP Number and include the below parameters:
To register a .QUEBEC domain name: intended-use: This parameter indicates the intended use of the .QUEBEC domain name. For example, commercial use, statistic website, cultural, etc. To register a .TEL domain name:
Note
You may exclude the whois-type parameter itself from the API call, since it is optional. In that case,:
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. To register a .LAWYER, .ATTORNEY, .LTDA, .SRL 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 To register a .AIRFORCE, .ARMY, .DEGREE, .ENGINEER, .GIVES, .MARKET, .MORTGAGE, .NAVY, .REHAB, .SOFTWARE, .VET, .VOTE, .VOTO 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". 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 |
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®-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®-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®-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 .AU Domain Name
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.net.au&years=2&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=id-type&attr-value1=ACN&attr-name2=id&attr-value2=079 009 340&attr-name3=policyReason&attr-value3=1&attr-name4=isAUWarranty&attr-value4=true
Example Test URL Request for Registering a .CN Domain Name
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.cn&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=cnhosting&attr-value1=true&attr-name2=cnhostingclause&attr-value2=yes
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®-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 Registering a .TEL Domain Name
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.tel&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=whois-type&attr-value1=Natural&attr-name2=publish&attr-value2=N
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®-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®-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®-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)
-
-
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.
