Search:
DETAILED SPECIFICATION
General error handling
Back to IndexEvery request made to the server will return XML or JSON if a request was processed successfully; it will have a status entry set to “OK”. This does not mean that the request was processed (for example, if registering a domain that was not available), just that enough information was passed that it could have been.
<?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?>
<dottk>
<partner_function>
[… content depending on function used, see below…]
</partner_function>
<status>OK</status>
</dottk>
Please note: if the main status entry returns OK the returned information contains also a status entry within the function request. For the possible return values of this status field, please refer to appendix A.
If the request could not be processed, it will have a status entry of “NOT OK”, and a reason will be given. This will look like:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<reason>No domain name specified</reason>
<status>NOT OK</status>
</dottk>
Please note: if the main status entry returns NOT OK the reason field returns the error. Please refer to appendix B for more information.
1. Connection test
Back to Index |
DESCRIPTION. This function is used to check if you are able to the reach the DomainShare API. |
 |
SYNTAX. URL |
Input HTTPS post variables: none
 |
REMARKS INPUT. If no output format is provided, the output of this function call will be provided in XML. |
 |
PROCESSING RESULTS. |
Possible output:
The result in case of success:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_ping>
<type>result</type>
<status>PING REPLY</status>
<timestamp>2010-06-01 16:04:12 UTC</timestamp>
</partner_ping>
<status>OK</status>
</dottk>
 |
REMARKS OUTPUT. |
The variable timestamp is always in the YYYY-MM-DD HH24:MM:SS UTC format.
2. Availability Check
Back to Index |
DESCRIPTION. This function is used to check if a free domain name is still available with the Dot TK Registry. This function can also be used to obtain status information of a domain name. |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
domainname |
M | < domainname to check> | TEST0112.TK |
|
REMARKS INPUT. If no output format is provided, the output of this function call will be provided in XML. |
The email and password variables are the credentials of a DomainShare Partner.
A domain name used in the domainname variable should contain at least 4 characters and a maximum of 64 characters. Only roman characters A-Z, 0-9 and the dash (-) are allowed. A domain name should end with .TK
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
Possible output:
The result in case of success:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_availability_check>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN AVAILABLE</status>
<domaintype>FREE</domaintype>
</partner_availability_check>
<status>OK</status>
</dottk>
If the domain has previously been registered by someone else or if the domain is not available for free registrations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_availability_check>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN NOT AVAILABLE</status>
</partner_availability_check>
<status>OK</status>
</dottk>
If the domain has been registered by yourself and is using name servers:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_availability_check>
<type>result</type>
<status>DOMAIN NOT AVAILABLE</status>
<domaintype>FREE</domaintype>
<domainname>TEST0112.TK</domainname>
<expirationdate>20100218</expirationdate>
<nameservers>
<hostname>NS65.WORLDNIC.COM</hostname>
</nameservers>
<nameservers>
<hostname>NS66.WORLDNIC.COM</hostname>
</nameservers>
<nameservers>
<hostname>NS1.TEST0112.TK</hostname>
<ipaddress>100.200.101.201</ipaddress>
</nameservers>
</partner_availability_check>
<status>OK</status>
</dottk>
If the domain has been registered by yourself and is using URL forwarding:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_availability_check>
<type>result</type>
<status>DOMAIN NOT AVAILABLE</status>
<domaintype>FREE</domaintype>
<domainname>TEST0112.TK</domainname>
<expirationdate>20100218</expirationdate>
<forwardurl>http://www.test.com</forwardurl>
</partner_availability_check>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
If the domain is available for registration the status variable contains DOMAIN AVAILABLE. If the domain name is not available the status variable contains DOMAIN NOT AVAILABLE.
If an availability check is made for a domain that is already registered within your portfolio the expiration date of the domain is shown. The output for the variable expirationdate is provided in the output as YYYYMMDD.
The variable domaintype field always returns the value FREE.
If a domain name is already registered with the portfolio of a DomainShare partner, either the name server information or forwarding URL (whatever is applicable) will be presented in the output.
3. Domain Registration
Back to Index |
DESCRIPTION. This function is used to register a free domain name with the Dot TK Registry. Only available domain names can be registered. A domain name can be registered from 1 to 12 months. If no registration period is provided, a default registration period of 3 months is used. |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
domainname |
M | < domainname to check> | TEST0112.TK |
enduseremail |
M | <email address enduser> | enduser@gmail.com |
monthsofregistration |
O | <number of months> | 12 |
nameserver |
O | <nameserver value> | NS1.A.COM |
nameserver |
O | <nameserver value> | NS2.A.COM |
forwardurl |
O | <forwarding url> | http://www.test.com |
|
REMARKS INPUT. If no output format is provided, the output of this function call will be provided in XML. |
The email and password variables are the credentials of a DomainShare Partner.
A domain name used in the domainname variable should contain at least 4 characters and a maximum of 64 characters. Only roman characters A-Z, 0-9 and the dash (-) are allowed. A domain name should end with .TK
The email address of the DomainShare Partners enduser needs to be provided as value of the enduseremail variable. An email is sent by Dot TK directly to the enduser. The enduser needs to confirm their email address within 72 hours of registration. During this time the domain name will work normally. If the domain name is not confirmed by the enduser within 72 hours of registration, the domain name is cancelled. An enduser is eligible to have a maximum of 100 domain names registered per day under his/her email address. Please refer to chapter 9 if the enduser confirmation email needs to be resent.
If no value of the monthsofregistration variable is provided, a value of 3 months is used as default.
Optional variables are nameserver and forwardurl. It’s mandatory that one of these variables is used. Using both or using none is not allowed. Please note that if you want to use name servers within the same domain, you need to add glue records (see Chapter 5). At least a minimum of two (2) and a maximum of eight (8) name servers should be used. For more information about URL Forwarding please review the applicable information in chapter E.
The forwardurl parameter should always start with ‘http://’. Forwarding is not possible with SSL websites, so ‘https://’ is not supported.
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
Possible output:
The result after a successful registration:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_registration>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<monthsofregistration>12</monthsofregistration>
<expirationdate>20110614</expirationdate>
<status>DOMAIN REGISTERED</status>
<domaintype>FREE</domaintype>
</partner_registration>
<status>OK</status>
</dottk>
The domain was not registered because the enduser has registered already 100 domain names:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_registration>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>ENDUSER QUOTA REACHED</status>
</partner_registration>
<status>OK</status>
</dottk>
The domain was not available for registration:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_registration>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN NOT AVAILABLE</status>
</partner_registration>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
If the domain is available for registration, the domain is registered and the status variable contains DOMAIN REGISTERED. If the domain name is not available the status variable contains DOMAIN NOT AVAILABLE. If the domain name is registered by an enduser that has already 100 domains registered on one day, the status variable contains ENDUSER QUOTA REACHED.
The output for the variable expirationdate is provided in the output as YYYYMMDD.
The variable domaintype field always returns the value FREE.
4. Renewal of domains
Back to Index |
DESCRIPTION. DomainShare domains need to be actively renewed by the DomainShare Partner. Renewals may only take place in the last 15 days of any registration period. |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
domainname |
M | < domainname to check> | TEST0112.TK |
monthsofregistration |
O | <number of months> | 12 |
|
REMARKS INPUT. |
The email and password variables are the credentials of a DomainShare Partner.
A domain name used in the domainname variable should contain at least 4 characters and a maximum of 64 characters. Only roman characters A-Z, 0-9 and the dash (-) are allowed. A domain name should end with .TK
If no value of the monthsofregistration variable is provided, a value of 3 months is used as default.
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
Possible output:
The result after a successful renewal:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_renew>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<monthsofregistration>12</monthsofregistration>
<expirationdate>20120614</expirationdate>
<status>DOMAIN RENEWED</status>
<domaintype>FREE</domaintype>
</partner_renew>
<status>OK</status>
</dottk>
The domain was not available for renewal, because the domain name is not eligible for renewal yet (renewals may only take place in the last 15 days of any registration period):
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_renew>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN NOT YET RENEWABLE</status>
<expirationdate>20110614</expirationdate>
<domaintype>FREE</domaintype>
</partner_renew>
<status>OK</status>
</dottk>
The domain was not available for renewal because of other reasons:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_renew>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN NOT AVAILABLE</status>
</partner_renew>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
If the domain is available for registration, the domain is registered and the status variable contains DOMAIN RENEWED. If the domain name is not available for renewal yet, the status variable contains DOMAIN NOT YET RENEWABLE. If the domain name was not available for renewal because of other reasons the status variable contains DOMAIN NOT AVAILABLE.
Not only at a successful renewal is the expirationdate shown, it is also shown when the domain name is in the DomainShare Partner’s portfolio but when it’s not due for renewal yet. Renewals may only take place in the last 15 days of any registration period. The expirationdate has the format of YYYYMMDD.
The variable domaintype field always returns the value FREE.
5. Add/modify glue record
Back to Index |
DESCRIPTION. Glue records are needed for domains that are configured to use DNS and where the name servers are in the same DNS zone. Example: if you register TEST0112.TK and if you want to use name servers within that same DNS zone, like NS1.TEST0112.TK and NS2.TEST0112.TK, then you need to add NS1.TEST0112.TK and NS2.TEST0112.TK as glue records to prevent circular dependency. This function adds or modifies glue records. If the glue record relates to a domain name that is in the DomainShare partner’s portfolio and if it has not been registered before, it will be added to the database of the Dot TK Registry. If it has been registered before by the DomainShare Partner the record will be modified with the new IP address |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
hostname |
M | <hostname> | NS1.TEST0112.TK |
ipaddress |
M | <ipaddress> | 100.200.101.201 |
|
REMARKS INPUT. |
The email and password variables are the credentials of a DomainShare Partner.
The contents of the hostname variable should be a fully qualified domain name (FQDN) existing out of a local hostname and the parent domain. An example is NS1.TEST0112.TK
The ipaddress variable should contain a routable IPv4 address.
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
Possible output:
The reply after a successful host registration:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_host_registration>
<type>result</type>
<hostname>NS1.TEST0112.TK</hostname>
<ipaddress>100.200.101.201</ipaddress>
<status>HOST REGISTERED</status>
</partner_host_registration>
<status>OK</status>
</dottk>
The reply after a successful host modification:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_host_registration>
<type>result</type>
<hostname>NS1.TEST0112.TK</hostname>
<ipaddress>100.200.101.202</ipaddress>
<status>HOST MODIFIED</status>
</partner_host_registration>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
Only hosts of authorized free domains in the partner’s portfolio can be updated or registered.
A successful modification or registration of a glue records will return the value of
status as HOST MODIFIED or HOST REGISTERED.
6. Remove glue record
Back to Index |
DESCRIPTION. Glue records are needed for domains that are configured to use DNS and where the name servers are in the same DNS zone. With this function you can remove existing glue records. |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
hostname |
M | <hostname> | NS1.TEST0112.TK |
|
REMARKS INPUT. |
The email and password variables are the credentials of a DomainShare Partner.
The contents of the hostname variable should be a fully qualified domain name (FQDN) existing out of a local hostname and the parent domain. An example is NS1.TEST0112.TK.
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
Possible output:
The reply after a successful host registration:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_host_removal>
<type>result</type>
<hostname>NS1.TEST0112.TK</hostname>
<status>HOST REMOVED</status>
</partner_host_removal>
<status>OK</status>
</dottk>
The reply when the host has not been registered before:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_host_removal>
<type>result</type>
<hostname>NS1.TEST0112.TK</hostname>
<status>HOST NOT FOUND</status>
</partner_host_removal>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
Only glue records of authorized free domains in the partner’s portfolio can be removed.
When the hostname is not present as a glue record at Dot TK, the value of status is returned as HOST NOT FOUND. At successful removal of a hostname the value of status is returned as HOST REMOVED.
7. List glue records
Back to Index |
DESCRIPTION. Glue records are needed for domains that are configured to use DNS and where the name servers are in the same DNS zone. With this function you can list existing glue records of a domain name. |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
domainname |
M | <name to list glue records for> | TEST0112.TK |
|
REMARKS INPUT. |
The email and password variables are the credentials of a DomainShare Partner.
A domain name used in the domainname variable should contain at least 4 characters and a maximum of 64 characters. Only roman characters A-Z, 0-9 and the dash (-) are allowed. A domain name should end with .TK
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
Possible output:
The reply when there are availabe glue records for this domain:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_host_list>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<host>
<hostname>NS1.TEST0112.TK</hostname>
<ipaddress>100.200.101.201</ipaddress>
</host>
<host>
<hostname>NS2.TEST0112.TK</hostname>
<ipaddress>100.200.101.202</ipaddress>
</host>
<status>GLUE RECORDS FOUND</status>
</partner_host_list>
<status>OK</status>
</dottk>
The reply when no glue records are available for this domain:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_host_list>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>NO GLUE RECORDS FOUND</status>
</partner_host_list>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
Only glue records of authorized free domains in the partner’s portfolio will be listed.
A successful listing of glue records for a domain will return the value of status as GLUE RECORDS FOUND (when glue records are found) or NO GLUE RECORDS FOUND (when no glue records for this domain are present).
8. Modify domain
Back to Index |
DESCRIPTION. This function is used to modify the settings of a domain name. It’s possible to change the name servers or the forwarding URL. Please note that it can take up to 30 minutes before every DNS in the world is updated with the new information. Any modification of a domain will remove any old settings for this domain. |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
domainname |
M | <domain name to update> | TEST0112.TK |
nameserver |
O | <nameserver value> | NS1.A.COM |
nameserver |
O | <nameserver value> | NS2.A.COM |
forwardurl |
O | <forwarding url> | http://www.test.com |
|
REMARKS INPUT. |
The email and password variables are the credentials of a DomainShare Partner.
A domain name used in the domainname variable should contain at least 4 characters and a maximum of 64 characters. Only roman characters A-Z, 0-9 and the dash (-) are allowed. A domain name should end with .TK
Optional variables are nameserver and forwardurl. It’s mandatory that one of these variables is used. Using both or using none is not allowed. Please note that if you want to use name servers within the same domain, you need to add glue records (see Chapter 5). At least a minimum of two (2) and a maximum of eight (8) name servers should be used. For more information about URL Forwarding please review the applicable information in chapter E.
The forwardurl parameter should always start with ‘http://’. Forwarding is not possible with SSL websites, so ‘https://’ is not supported.
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
Possible output:
The result after a successful modification:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_modify>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN MODIFIED</status>
</partner_modify>
<status>OK</status>
</dottk>
The result after when the modification was not successful:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_modify>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN COULD NOT BE MODIFIED</status>
</partner_modify>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
Only DNS servers of authorized free domains in the partner’s portfolio can be modified;
When the domain is modified with the new information, the value status is returned as DOMAIN MODIFIED. When the Dot TK Registry was unable to modify the domain name, the value of status is returned as DOMAIN COULD NOT BE MODIFIED.
9. Resend enduser email
Back to Index |
DESCRIPTION. DomainShare Partners are registering domain names for others (endusers). Endusers need to confirm their email address with Dot TK before a domain is fully authorized. During initial domain name registration this confirmation email is sent to the enduser. This function is resending the confirmation email. It can be used in case the enduser has not received the Dot TK confirmation email. When this function is used for domains that are already confirmed, an email with the enduser Dot TK Registration ID is sent. |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
domainname |
M | <domainname to request status for> | TEST0112.TK |
enduseremail |
O | <email address enduser> | enduser@gmail.com |
|
REMARKS INPUT. |
The email and password variables are the credentials of a DomainShare Partner.
A domain name used in the domainname variable should contain at least 4 characters and a maximum of 64 characters. Only roman characters A-Z, 0-9 and the dash (-) are allowed. A domain name should end with .TK
If a new value of enduseremail is provided for a domain that is not set to an authorized status, the database is updated with this new value and a confirmation email is sent to the new email address of the enduser.
If this function is used for domains that are already set to an authorized status an email with the Registration ID is sent to the enduser.
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
Possible output:
The result when the domain is not yet confirmed by the registrant (enduser):
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_resend_email>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>CONFIRMATION EMAIL SENT</status>
</partner_resend_email>
<status>OK</status>
</dottk>
The result when the domain is already confirmed by the registrant (enduser):
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_resend_email>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>REGISTRATION ID SENT</status>
</partner_resend_email>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
This function can only be used for domains of endusers that are part of the partner’s portfolio.
When the enduser email is successfully sent to an enduser that has not confirmed his/her email address, the value status is returned as CONFIRMATION EMAIL SENT. When the enduser email is successfully sent to an enduser that has confirmed his/her email address, the value of status is returned as REGISTATION ID SENT.
10. Deactivate Domain
Back to Index |
DESCRIPTION. DomainShare Partners can opt to deactivate domain names at any time. Deactivation of a domain name can only take place if a valid reason is provided. |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
domainname |
M | <domainname to request status for> | TEST0112.TK |
reason |
M | <reason for deactivation> | only_ads |
|
REMARKS INPUT. |
The email and password variables are the credentials of a DomainShare Partner.
A domain name used in the domainname variable should contain at least 4 characters and a maximum of 64 characters. Only roman characters A-Z, 0-9 and the dash (-) are allowed. A domain name should end with .TK
Upon deactivation a reason should be supplied. After deactivation, the parking page with
advertisements will be relevant to the previous content and to the reason supplied. The following reasons can be used:
| Reason | Content |
| adult | Please select this reason if the domain contained pornography, adult or mature content. This does not include chat, lingerie and/or swimwear websites. However, nudism websites are considered to be ‘mature content’. |
| adult_gay | Please select this reason if the domain contained pornography of male homosexual nature, adult or mature content related to male homosexuality. This does not include chat and/or swimwear websites. |
| drugs | Please select this reason if the domain contained information about illicit drugs and drug paraphernalia. It also includes websites that promote or sell hard alcohol, tobacco, tobacco-related products and/or prescription drugs. It does not contain websites that promote or sell wines or beers. |
| violence | Please select this reason if the domain contained violent content, racial intolerance or advocacy against any individual, group, or organization. This includes nazi propaganda websites, homophobic content and others. |
| gambling | Please select this reason if the domain contained gambling or casino content. Gambling is defined as an act where there is betting with/for money involved (which includes bingo). This differs to gaming, which are acts where there is no betting with/for money involved, but is an actual computer game. |
| only_ads | Please select this reason if the content on a domain contains monetized or non-monetized Domain Parking. Domain Parking includes webpages that solely show advertisements and no actual content, “Under Construction” pages, “Coming Soon” pages and alike. |
| does_not_exist | Please select this reason if the content on a domain does not exist, shows an empty page, shows an error message, shows a ‘not available’ page or is hidden behind a firewall or used with a VPN and is therefore not available for the public and for Dot TK’s content verification systems. |
| virus_spyware | Please select this reason if the content on a domain is involved in uploading, posting, linking to or otherwise transmitting any material that contains software viruses or any other computer code, files or programs designed to interrupt, destroy or limit the functionality of any computer software, hardware or telecommunications equipment. |
| weapons | Please select this reason if the content is intended to promote and/or sell weapons or ammunition (e.g., firearms, fighting knives, stun guns). |
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
Possible output:
The result when the domain is deactivated:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_domain_deactivate>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN DEACTIVATED</status>
</partner_domain_deactivate>
<status>OK</status>
</dottk>
The result when the domain could not be deactivated:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_domain_deactivate
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN COULD NOT BE DEACTIVATED</status>
</partner_domain_deactivate>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
This function can only be used for domains that are active and part of the partner’s portfolio.
When the domain is deactivated successfully, the value status is returned as DOMAIN DEACTIVATED. When the Dot TK Registry was unable to deactivate the domain name, the value of
status is returned as DOMAIN COULD NOT BE DEACTIVATED.
11. Reactivate Domain
Back to Index |
DESCRIPTION. DomainShare Partners can opt to reactivate a previously deactivated domain. There are two requirements to reactivate domains. Both requirements should be met to successfully reactivate a domain name. The first requirement is that reactivation can only be done if the domain was deactivated because it had a reason value of does_not_exist. The second requirement is that only domain names that have been deactivated less than 15 days ago can be reactivated.The reactivation function is mostly used if the DomainShare Partner made a honest mistake in deactivating a domain name. |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
domainname |
M | <domainname to request status for> | TEST0112.TK |
|
REMARKS INPUT. |
The email and password variables are the credentials of a DomainShare Partner.
A domain name used in the domainname variable should contain at least 4 characters and a maximum of 64 characters. Only roman characters A-Z, 0-9 and the dash (-) are allowed. A domain name should end with .TK
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
Possible output:
The result when the domain is reactivated:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_domain_reactivate>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN REACTIVATED</status>
</partner_domain_reactivate>
<status>OK</status>
</dottk>
The result when the domain could not be reactivated:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_domain_reactivate>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>DOMAIN COULD NOT BE REACTIVATED</status>
</partner_domain_reactivate>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
This function can only be used for domains that are not active and part of the partner’s portfolio.
When the domain is reactivated successfully, the value status is returned as DOMAIN REACTIVATED. When the Dot TK Registry was unable to reactivate the domain name, the value of status is returned as DOMAIN COULD NOT BE REACTIVATED.
12. Park settings domain
Back to Index |
DESCRIPTION. This function allows DomainShare Partners to increase their revenue on domain names that show a parking page with advertisements. The DomainShare Partner is able to set a category of the domain and one or more keywords. The Dot TK Registry and its advertising partners do take the suggestions of the DomainShare Partner seriously when deciding on what subjects advertisements should be displayed. However, it is in Dot TK’s sole discretion to display any advertisements based on different categories or keywords. |
|
SYNTAX. URL |
Input HTTPS post variables:
(M = Mandatory, O = Optional)
| Name variable | M/O | Input syntax | Example |
email |
M | <email address DS Partner> | test@testpartner.com |
password |
M | <password DS Partner> | jjfk222 |
domainname |
M | <domainname to request status for> | TEST0112.TK |
category |
O | <standard category> | category |
keyword |
O | <keyword> | gambling |
|
REMARKS INPUT. |
The email and password variables are the credentials of a DomainShare Partner.
A domain name used in the domainname variable should contain at least 4 characters and a maximum of 64 characters. Only roman characters A-Z, 0-9 and the dash (-) are allowed. A domain name should end with .TK
Optional variables are category and keyword. It’s mandatory that one or both of these variables is used. Using none is not allowed. The use of multiple keywords (up to 4) is allowed.
When a value in category is supplied, a parking page with advertisements will most likely be relevant to such category. However, it’s in Dot TK’s sole discretion to display any advertisements based on different categories or keywords.
| Reason | Content |
| adult_straight | Adult entertainment textual advertisements |
| adult_gay | Adult entertainment textual advertisements related to gay websites |
| banking | Ads related to banking, finance, Dow Jones, stock trading |
| business | Ads related to agreements, lawyers, business |
| dating | Ads related to dating and finding love |
| diet | Ads related to reducing weight, weight loss |
| drinks | Ads related to spirits, wine, beer |
| drugs | Ads related to pharmaceuticals, drugstores |
| education | Ads related to courses, jobs, education, recruitment |
| electronics | Ads MP3 players, mobile phones |
| fashion_men | Ads related to menswear, jeans |
| fashion_women | Ads related to womens underwear, lingerie |
| violence | Ads related to guns, weapons |
| finance | Ads related to credit, loans, credit cards |
| food | Ads related to high-end food, cheeses, truffles |
| gambling | Ads related to poker, blackjack, casino |
| games | Ads related to online games, cheats, gaming |
| generic_1 | Ads related to online banking, general finance |
| generic_2 | Ads related to movies, free games |
| gifts | Ads related to gift coupons, perfect gifts |
| internet | Ads related to hosting, internet access |
| magazines | Ads related to magazine subscriptions |
| movies | Ads related to movies and online television |
| music | Ads related to MP3, DJs, techno |
| news | Ads related to newspaper subscriptions, celebrity news |
| real_estate | Ads related to mortgage, dream homes |
| ringtones | Ads related to ringtones, mobile phones |
| sports | Ads related to football, soccer and other sports |
| travel | Ads related to hotels, flights |
| virus_spyware | Ads related to antivirus software, firewall |
| weapons | Ads related to guns, weapons |
The value of keyword should be UTF8 encoded.
If no output format is provided, the output of this function call will be provided in XML.
|
PROCESSING RESULTS. |
The result when the category and/or keywords are set:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_update_parking>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>CATEGORY/KEYWORD(S) UPDATED</status>
</partner_update parking>
<status>OK</status>
</dottk>
The result when the update for category and/or keywords were not successful:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dottk>
<partner_update_parking>
<type>result</type>
<domainname>TEST0112.TK</domainname>
<status>CATEGORY/KEYWORD(S) COULD NOT UPDATED</status>
</partner_update parking>
<status>OK</status>
</dottk>
|
REMARKS OUTPUT. |
This function can only be used for domains that are not active and part of the partner’s portfolio.
When the settings of category and/or keyword(s) are applied successfully, the value status is returned as CATEGORY/KEYWORD(S) UPDATED. When the Dot TK Registry was unable to apply the category and/or keyword(s), the value of status is returned as CATEGORY/KEYWORD(S) COULD NOT UPDATED.
Join DomainShare now!
Are you a hosting provider and do you want to give away domains to your customers?
Signup Now for Dot TK DomainShare