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. Note
.AI Domains can only be registered for 2 years. |
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. |
auto-renew | Boolean | Required |
Enables / Disables the Auto Renewal setting for the domain name. Note
|
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.
|
discount-amount | Float | Optional | Discount amount for the order value. |
purchase-premium-dns | Boolean | Optional | Purchase Premium DNS service. |
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&discount-amount=0.0
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&discount-amount=0.0
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&discount-amount=0.0&attr-name1=phase&attr-value1=sunrise&attr-name2=smd&attr-value2=<smd_file_content>
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&discount-amount=0.0&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&discount-amount=0.0&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&discount-amount=0.0&attr-name1=premium&attr-value1=true&attr-name2=eap&attr-value2=true
Example Test URL Request for Registering a .LAT Domain Name
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&discount-amount=0.0
For a .lat domain name it is recommended, that you create a contact with the contact type as MXContact. Click here for more information on creating a contact.
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)
-
Discount Amount (discount-amount)
-
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.