Difference between revisions of "Domain Registration"

From AWBS Wiki
Jump to: navigation, search
(TLD Setup/Pricing)
(IDN)
 
(48 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==eNom==
+
__NOTOC__
 
+
==Table of Contents==
'''At www.enom.com'''
+
# [[BizCN_Configuration|BizCN Configuration]]
 
+
# [[dot.tk_Configuration|Dot.TK Configuration]]
Go to resellers on the top menu.
+
# [[eNom_Configuration|eNom Configuration]]
 
+
# [[Hexonet_Configuration|Hexonet Configuration]]
Click on test account link on that menu.
+
# [[Internet.bs_Configuration|Internet.bs Configuration]]
 
+
# [[IRRP.Net_Configuration|iRRP.net/Key System Configuration]]
#Click Setup your account on the testing server.
+
# [[ISPAPI_Configuration|ISPAPI Configuration]]
#Click Reset your account balance in the test environment to $5000.00.
+
# [[LogicBox_Configuration|LogicBox Configuration]]
#Click the Add/Edit/Delete IP addresses that are allowed to access your account on the test server and enter your server's main IP address. Save.
+
# [[NetEarthOne_Configuration|NetEarthOne Configuration]]
 
+
# [[Nominet_EPP_Configuration|NominetEPP Configuration]]
+
# [[Nokta_TK_Configuration|Nokta TK Configuration]]
 
+
# [[OnlineNic_Configuration|OnlineNic Configuration]]
'''In AWBS'''
+
# [[OpenSRS_Configuration|OpenSRS Configuration]]
 
+
# [[PlanetDomain_Configuration|PlanetDomain Configuration]]
Login to your AWBS site as super admin.
+
# [[Reg.ru_Configuration|Reg.ru Configuration]]
 
+
# [[RegisterFly_Configuration|RegisterFly Configuration]]
Enter the Configuration area. Go to the Module Setup page and ensure the eNom module is enabled.
+
# [[ResellerClub_Configuration|ResellerClub Configuration]]
 
+
# [[ResellOne_Configuration|ResellOne Configuration]]
Go to the Registrar Setup page. Click the icon beside Enom to enter the eNom setup area.
+
# [[#TLD Config|TLD Config]]
 
+
# [[#TLD Setup/Pricing|TLD Setup/Pricing]]
Enter your enom.com reseller account username and password. Make sure you have test mode set to True and secure mode set to False. Do not change the Live URL or Test URL settings. Enter prices as desired for the various enom services.
+
# [[#Domain Name Options|Domain Name Options]]
 
+
# [[#For Sale System|For Sale System]]
If you have a backorder affiliate account somewhere, enter your backorder url.
+
# [[#IDN|IDN]]
 
+
# [[#Domain Push Feature|Domain Push Feature]]
If you wish domain names to be registered with nameservers other than enom's by default, enter desired nameservers in the nameserver fields.
+
# [[#Legal_Types_for_TLD's|Legal Types for TLD's]]
Note: If you will be offering any of eNom's dns services such as url forwarding, etc you should leave the nameserver fields blank.
+
# [[#Setting_specific_number_of_years_for_registrations_and_renewals|Setting specific number of years for registrations and renewals]]
 
+
If you have a default park page you set for all newly registered domains, enter the complet url in the Default parking page url field. This only applies if you have left the nameserver fields empty, as it sets a url frame for the domain if it is using eNom's nameservers.
+
 
+
Save.
+
 
+
Enter the enom registrar setup page again.  Click the Test ENOM connection link to verify your configuration is correct.
+
 
+
'''At www.enom.com'''
+
 
+
If there are no errors, login to your account at enom.com, go to the support area, open a new support request and ask for API access for the IP you entered in the test account setup area.
+
 
+
+
'''In your AWBS Configuration'''
+
Once you have completed your testing and are ready to put your site live for orders, go to the Registrar Setup area and set test mode to False and secure connection to True. Run the Test ENOM connection test again to ensure there are no problems.
+
 
+
 
+
'''At www.enom.com'''
+
Other settings at enom.com
+
 
+
Login to your reseller account at enom.com.
+
 
+
Go to settings.
+
 
+
Select '1' for 'by default, domains will be registered, hosted, and renewed for x year(s).
+
 
+
Select the 'define your own default host records in the fields below' and setup a default park page. (If you don't define your default host records, your domains will inherit the ones from your master reseller account).
+
 
+
Save changes.
+
 
+
Click the reseller tab.
+
Click reseller renewal settings. Select 'do not contact my customers for renewal'. (AWBS will send the renewal notices)
+
 
+
Save changes.
+
 
+
You may also wish to use the domains >> advanced tools >> global edit to ensure no existing domains are set to auto renew.
+
 
+
 
+
==iRRP.Net/Key System==
+
 
+
Go to the AWBS '''Configuration''' area, '''Module Setup''' page.
+
Enable the irrp.net/Key Systems module.
+
 
+
Go to the '''Registrar Setup''' page, click the icon beside irrp to enter the irrp.net/Key System configuration page.
+
 
+
Enter your irrp.net/Key Systems reseller account username and password.
+
 
+
If you are an RRPProxy.net reseller, use this url: ssl.rrpproxy.net/api/call.cgi
+
 
+
''Note: there is no test mode if you are an RRPProxy.net reseller.''
+
 
+
+
Set test mode to True for testing, switch to false when ready to go live.
+
 
+
Set a backorder URL if you have a backorder affiliate link for backordering domain names.
+
 
+
Enter at least 2 valid registered nameservers to be used for all new domain registrations by default.
+
 
+
Irrp test nameservers:
+
ns1.dnapi.net
+
ns2.dnapi.net
+
 
+
To test your connection,  click the Test Connection link at the top of the irrp configuration page.
+
 
+
==OpenSRS==
+
 
+
'''At OpenSRS:'''
+
 
+
Login to your OpenSRS reseller account.
+
 
+
If you don't know or don't have a private key already, click Generate New Private Key.
+
Copy the Private Key generated for configuration of the AWBS Opensrs module.
+
 
+
Click Add IPs for Script/API Access.
+
Add your server's main IP address for API access and save.
+
 
+
Click Renewal Management.
+
It is recommended to disable all user domain renewal notices in your OpenSRS account. AWBS sends renewal notice emails.
+
 
+
 
+
'''In AWBS:'''
+
 
+
Configuration >> Module Setup
+
 
+
Set Opensrs to Active in the Domain Registrars section.
+
 
+
Click the Save Changes button.
+
 
+
Configuration >> Registrar Setup
+
 
+
In the Opensrs row, click the icon to edit.
+
 
+
Registrar Name: Opensrs (do not edit this field)
+
 
+
Username: Enter your Opensrs reseller account username
+
 
+
Private Key: Enter the private key you generated in your Opensrs reseller account.
+
 
+
Secure Mode: True or False (True is recoomended)
+
 
+
Test Mode: True or False (True for testing, False for live system)
+
 
+
Live URL: rr-n1-tor.opensrs.net
+
 
+
Test URL: horizon.opensrs.net
+
 
+
Backorder URL: Enter your affilate link for backordering domains if applicable
+
 
+
Allow Feature Select In Cart: Leave unchecked, this setting is not applicable to the Opensrs module.
+
 
+
Nameserver1: through Nameserver4: Enter default nameservers for new registrations. Minimum 2 maximum 4 nameservers. Enter only registered nameservers.
+
 
+
Note: Opensrs test system nameservers: ns1.domaindirect.com ns2.domaindirect.com
+
 
+
Configuration >> TLD Config
+
 
+
Set all TLDs you will offer through your Opensrs reseller account to Opensrs in the registrar column.
+
 
+
+
 
+
Note: OpenSRS uses port 55443, if you run a firewall and are having trouble connecting, open port 55443 in your firewall and flush out your cached rules.
+
 
+
==ResellerClub==
+
Contact Resellerclub support to obtain a test account. Use your test account information during testing while the AWBS Resellerclub registrar module is in test mode.
+
Use your real reseller account information in the AWBS Resellerclub module while in live mode.
+
 
+
In AWBS, login to your AWBS site as super admin. Go to the Module Setup page and ensure the Resellerclub registrar module is enabled.
+
 
+
Go to the registrar setup area and click the icon next to Resellerclub to enter the Resellerclub configuration page.
+
 
+
Enter your Resellerclub reseller account username (email address) and the password.
+
 
+
Set test mode to True while testing, set to False when going live.
+
 
+
Set a backorder URL if you have a backorder affiliate link for backordering domain names.
+
 
+
Parent ID:
+
You can find the Parent ID by logging in to your Resellerclub account. Go to settings, personal information, primary profile.
+
 
+
Lang Pref: Set your language preference. Use lower case two letter language code.
+
 
+
Role: reseller
+
 
+
Enter at least 2 nameservers to be used for new domain registrations by default.
+
Note: use ns1.directi.com and ns2.directi.com when in test mode.
+
 
+
If you get an error when processing Resellerclub orders, use debug mode to view full return from the Resellerclub system. The full return will help guide you to the problem.
+
 
+
==ResellOne Configuration==
+
 
+
'''At ResellOne:'''
+
 
+
Login to your ResellOne reseller account.
+
If you don't know or don't have a private key already, click Generate New Private Key.
+
Copy the Private Key generated for configuration of the AWBS ResellOne module.
+
 
+
+
 
+
Click Add IPs for Script/API Access.
+
Add your server's main IP address for API access and save.
+
 
+
Click Renewal Management.
+
It is recommended to disable all user domain renewal notices in your ResellOne account. AWBS sends renewal notice emails.
+
 
+
 
+
'''In AWBS:'''
+
 
+
Configuration >> Module Setup
+
 
+
Set ResellOne to Active in the Domain Registrars section.
+
 
+
Click the Save Changes button.
+
 
+
+
 
+
Configuration >> Registrar Setup
+
 
+
In the ResellOne row, click the icon to edit.
+
 
+
Registrar Name: ResellOne (do not edit this field)
+
Username: Enter your ResellOne reseller account username
+
Private Key: Enter the private key you generated in your ResellOne reseller account.
+
Secure Mode: True or False (True is recoomended)
+
Test Mode: True or False (Set to False, ResellOne does not have a test environment)
+
Live URL: resellers.resellone.net
+
Test URL: not applicable
+
Backorder URL: Enter your affilate link for backordering domains if applicable
+
Allow Feature Select In Cart: Leave unchecked, this setting is not applicable to the ResellOne module.
+
 
+
Nameserver1: through Nameserver4: Enter default nameservers for new registrations. Minimum 2 maximum 4 nameservers. Enter only registered nameservers.
+
 
+
+
Configuration >> TLD Config
+
 
+
Set all TLDs you will offer through your ResellOne reseller account to ResellOne in the registrar column.
+
 
+
+
 
+
''Note: ResellOne uses port 52443, if you run a firewall and are having trouble connecting, open port 52443 in your firewall and flush out your cached rules. This is OUTGOING traffic.''
+
  
 
==TLD Config==
 
==TLD Config==
Line 260: Line 62:
 
''Note: Using the API lookups will be more accurate than the various whois servers, however it takes longer for the results. If you offer many tlds, you may want to use this feature only for the most popular ones to keep the process quick enough and avoid apache/IIS timeouts.''
 
''Note: Using the API lookups will be more accurate than the various whois servers, however it takes longer for the results. If you offer many tlds, you may want to use this feature only for the most popular ones to keep the process quick enough and avoid apache/IIS timeouts.''
  
 +
[[TLD_Whois_Servers|Whois Server Listing]]
  
 
2. For TLDs that only have an html based whois server;
 
2. For TLDs that only have an html based whois server;
Line 279: Line 82:
 
Be sure the minimum years are set lower than the maximum. Make sure the maximum years are not higher than offered by the registrar. (This will vary depending on the registrar used.)
 
Be sure the minimum years are set lower than the maximum. Make sure the maximum years are not higher than offered by the registrar. (This will vary depending on the registrar used.)
  
Check the 'Free Option' checkbox if you are offering a free domain name with any hosting plans for all tlds that will be free. The free option will give the domain name free with the initial hosting order (future domain renewals will not be free).
+
Check the 'Free Option' checkbox if you are offering a free domain name with any hosting plans for all tlds that will be free. The free option will give the domain name free with the initial hosting order only (future domain renewals will not be free).
  
 
Use the 'pos' column to set the position of the tlds on your domain availability checkbox on the index and check.php pages of the site.
 
Use the 'pos' column to set the position of the tlds on your domain availability checkbox on the index and check.php pages of the site.
Line 290: Line 93:
  
 
==Domain Name Options==
 
==Domain Name Options==
 +
 +
Allowing discounts will enable discounts to be set on a per user basis by the AWBS administrator. Disabling discounts here will override any settings in the user accounts.
 +
 +
Options:
 +
 +
Allow discounts for registrations and renewals: (True - False)
 +
 +
Allow discounts for transfers: (True - False)
 +
 +
You may specify your word search's here as well. Once you have the wordsearch filled in, Be sure to check either "Suffix or Prefix)
 +
This will create the other suggested domain names on the domain name registration page when customers are looking for domain name availability.
  
 
==For Sale System==
 
==For Sale System==
 
Activate the For Sale System in the AWBS Configuration, system options page.
 
Activate the For Sale System in the AWBS Configuration, system options page.
 
 
  
 
Configure your For Sale categories in the AWBS Configuration, For Sale System page.
 
Configure your For Sale categories in the AWBS Configuration, For Sale System page.
 
 
  
 
This allows you to configure the various different categories that a domain displayed in on the domains for sale page of your site.
 
This allows you to configure the various different categories that a domain displayed in on the domains for sale page of your site.
 
  
 
The for sale system will allow users to place their domain name for sale. The system will produce a form for perspective buyers to contact the owner without giving any information on the owner.
 
The for sale system will allow users to place their domain name for sale. The system will produce a form for perspective buyers to contact the owner without giving any information on the owner.
  
 
The domain owner will receive the form results with the purchase offer or request for a price via email (the email address configured in the user's profile).
 
The domain owner will receive the form results with the purchase offer or request for a price via email (the email address configured in the user's profile).
 
 
  
 
Users can place any of their domains for sale or remove them at any time. They can choose the category they would like the domain displayed in.
 
Users can place any of their domains for sale or remove them at any time. They can choose the category they would like the domain displayed in.
Line 314: Line 121:
  
 
They can click on the 'S' icon to place the domain for sale.
 
They can click on the 'S' icon to place the domain for sale.
 +
 +
== IDN ==
 +
''(the following configuration information is new as of AWBS version 2.9.4)''
 +
In the AWBS Configuration area, Domain Options area, on the Registrar/Whois tab add in any tlds you want to offer for IDN registrations.
 +
On the Pricing/Availability/EPP tab, check the IDN checkbox and setup the rest of the settings and pricing.
 +
 +
Note: Any tlds that you check the IDN checkbox will not show up on the normal registration page, so you'll need to have duplicates for those you offer both, such as .com.
 +
 +
IDN orders are taken via this link;<br />
 +
http://[your_awbs_url]/check.php?isidn=1
 +
 +
== Domain Push Feature ==
 +
Your AWBS members (customers) have the option to push a domain name to another account.<br /><br />
 +
 +
To push a domain name to another account in the system, login to the user account and proceed to the domain list (manage domains link on member menu).<br />
 +
Click the M icon next to the domain name you want to push.<br />
 +
Click the link that says: Push to Another Account<br />
 +
Enter the username of the account you want to push the domain name to.<br />
 +
Enter a new password, something not used anywhere else.<br />
 +
Click the Submit button.<br /><br />
 +
Now give the password you used to the owner of the account you have pushed to. The next time that user logs in, he/she will have a message to retrieve the domain name. They will have to enter the correct password at that time and have a domain profile.<br /><br />
 +
Notes:<br />
 +
1. When a domain name is retrieved, the new owner's default '''domain profile''' will be used to update the whois contact info for that domain name.<br />
 +
2. Domains with hosting services cannot be pushed, customers will need to contact you to move those domain names.<br />
 +
3. Domains moved (assigned to a new user) in the domain manager of the admin area do not get any new contact information.<br />
 +
4. Some registrar modules do not support this feature due to the manner in which domain contact information is edited.<br />
 +
5. Some tlds are exempt from this feature due to their special transfer and ownership change rules.
 +
 +
== Legal Types for TLD's ==
 +
 +
'''***ONLY APPLICABLE TO VERSION 2.9.0 AND ABOVE***'''
 +
 +
This file should be place in the /includes/[registrar] directory and be named legal.php
 +
This file must then define ALL legal settings for the entire tld offering from this registrar
 +
 +
'''File information:'''
 +
 +
<code><nowiki>$additionaldomainfields[".us"][] =  (change the tld to the appropriate setting)</nowiki></code>
 +
 +
'''Available settings are:'''
 +
*Name (text)
 +
*Type (text, dropdown, tickbox or radio)
 +
*Options (value=name pairs only - name is displayed to the user, value is actual value sent to the api)
 +
*Default (default value - Must be set for tickbox and radio)
 +
*Description (displayed below the input field
 +
*Apicommand (the actual api command sent to the registrar - Example: X-US-NEXUS-CATEGORY)
 +
*Required (make this value required)
 +
 +
'''Example setting:'''<br />
 +
<code><nowiki>
 +
<?php </nowiki><br />
 +
<nowiki>$additionaldomainfields[".us"][] = array( </nowiki><br />
 +
<nowiki>"Name" => "Nexus Category", </nowiki><br />
 +
<nowiki>"Type" => "dropdown", </nowiki><br />
 +
<nowiki>"Required" => "true", </nowiki><br />
 +
<nowiki>"Options" => "C11=C11,C12=C12,C21=C21,C31=C31,C32=C32", </nowiki><br />
 +
<nowiki>"Default" => "C11", </nowiki><br />
 +
<nowiki>"Description" => "This is the description for this field. This is the description for this field.", </nowiki><br />
 +
<nowiki>"Apicommand" => "nexus1", </nowiki><br />
 +
<nowiki>); </nowiki><br />
 +
<nowiki>?> </nowiki><br />
 +
</code>
 +
 +
== Setting specific number of years for registrations and renewals ==
 +
 +
As of 2.9.0 it is possible to set specific number of years that individual TLD's can be registered for or renewed for.
 +
 +
For example, you can have it set so .com domains can only be registered for 1, 2 or 5 years, and when renewing they have the option of 1, 5, or 10 years.
 +
 +
''To do this you need to edit the database manually!''
 +
 +
#Open your AWBS Database in PHPmyAdmin or Equivalent editor
 +
#Find the tld_config table, and edit the TLD you would like to change
 +
#Find the config_1 field and enter the years you would like to exclude for registering.  For example:  1,3,5,7,9 would mean this TLD can only be registered for 2, 4, 6, 8, or 10 years. 
 +
#To exclude years for renewals, you can use the following format:  1,3,5,7,9|5,6,7,8,9,10 In this example, the TLD could be registered for 2,4,6,8 or 10 years, but can only be renewed for 1,2,3, or 4 years.

Latest revision as of 11:18, February 7, 2011

Table of Contents

  1. BizCN Configuration
  2. Dot.TK Configuration
  3. eNom Configuration
  4. Hexonet Configuration
  5. Internet.bs Configuration
  6. iRRP.net/Key System Configuration
  7. ISPAPI Configuration
  8. LogicBox Configuration
  9. NetEarthOne Configuration
  10. NominetEPP Configuration
  11. Nokta TK Configuration
  12. OnlineNic Configuration
  13. OpenSRS Configuration
  14. PlanetDomain Configuration
  15. Reg.ru Configuration
  16. RegisterFly Configuration
  17. ResellerClub Configuration
  18. ResellOne Configuration
  19. TLD Config
  20. TLD Setup/Pricing
  21. Domain Name Options
  22. For Sale System
  23. IDN
  24. Domain Push Feature
  25. Legal Types for TLD's
  26. Setting specific number of years for registrations and renewals

TLD Config

In the TLD Config page of the AWBS configuration area, you will setup the registrar to be used for each tld you offer as well as the whois server that will be used for the domain availability lookups for domain sales. (not used on the whois.php page of your AWBS site)

Note: You must have already enabled the domain registrar modules you will be using in the Module Setup page.

Select the registrar you will use for each TLD.

Enter the whois server to be used for the availability checks. You must use the responsible registry's whois server and the correct Match String their system uses. Note: port 43 outgoing needs to be open on your server in order for the communication to the whois servers to function.


Whois server options:

1. For some registrars, you have the option to use the registrar's API to check for domain availability.

eNom
IRRP
OpenSRS
ResellOne

To use the API for domain lookups enter the appropriate of the following into the whois server field for each tld you wish to use it.

enom
irrp
opensrs
resellone

The response strings are not required if using the API for lookups.


Note: Using the API lookups will be more accurate than the various whois servers, however it takes longer for the results. If you offer many tlds, you may want to use this feature only for the most popular ones to keep the process quick enough and avoid apache/IIS timeouts.

Whois Server Listing

2. For TLDs that only have an html based whois server;

Enter the full URL with required parameter(s) of the whois page into the Whois Server column/field.

Example: http://www.ipwebgroup.gr/gr/whois.php?domainName=

Enter the correct Match String.

Example: Domain does not exist

TLD Setup/Pricing

On this page you will configure your TLD availability in years and for registration, renewals and transfers as well as the retail pricing and postition they display on the home page and domain name page.

Enter the tld's in format 'com', not '.com'. (NO BEGINNING DOT)

Only check the renew and transfer boxes according to availability at your configured registrar for each tld. (This may vary depending on the registrar used.)

Be sure the minimum years are set lower than the maximum. Make sure the maximum years are not higher than offered by the registrar. (This will vary depending on the registrar used.)

Check the 'Free Option' checkbox if you are offering a free domain name with any hosting plans for all tlds that will be free. The free option will give the domain name free with the initial hosting order only (future domain renewals will not be free).

Use the 'pos' column to set the position of the tlds on your domain availability checkbox on the index and check.php pages of the site. Number them in the order you wish them to appear starting at 0.

Note: All tlds with pos setting of 0 will rank the same and then be ordered via their row numbers in the database.

Click the Edit Pricing link by each TLD to setup pricing for each term. Note: prices are total for that number of years

Domain Name Options

Allowing discounts will enable discounts to be set on a per user basis by the AWBS administrator. Disabling discounts here will override any settings in the user accounts.

Options:

Allow discounts for registrations and renewals: (True - False)

Allow discounts for transfers: (True - False)

You may specify your word search's here as well. Once you have the wordsearch filled in, Be sure to check either "Suffix or Prefix) This will create the other suggested domain names on the domain name registration page when customers are looking for domain name availability.

For Sale System

Activate the For Sale System in the AWBS Configuration, system options page.

Configure your For Sale categories in the AWBS Configuration, For Sale System page.

This allows you to configure the various different categories that a domain displayed in on the domains for sale page of your site.

The for sale system will allow users to place their domain name for sale. The system will produce a form for perspective buyers to contact the owner without giving any information on the owner.

The domain owner will receive the form results with the purchase offer or request for a price via email (the email address configured in the user's profile).

Users can place any of their domains for sale or remove them at any time. They can choose the category they would like the domain displayed in.

In the user's domain management area, each domain will show the 'S' icon if it is currently not for sale and the 'FS' icon if it is for sale.

They can click on the 'S' icon to place the domain for sale.

IDN

(the following configuration information is new as of AWBS version 2.9.4) In the AWBS Configuration area, Domain Options area, on the Registrar/Whois tab add in any tlds you want to offer for IDN registrations. On the Pricing/Availability/EPP tab, check the IDN checkbox and setup the rest of the settings and pricing.

Note: Any tlds that you check the IDN checkbox will not show up on the normal registration page, so you'll need to have duplicates for those you offer both, such as .com.

IDN orders are taken via this link;

http://[your_awbs_url]/check.php?isidn=1

Domain Push Feature

Your AWBS members (customers) have the option to push a domain name to another account.

To push a domain name to another account in the system, login to the user account and proceed to the domain list (manage domains link on member menu).
Click the M icon next to the domain name you want to push.
Click the link that says: Push to Another Account
Enter the username of the account you want to push the domain name to.
Enter a new password, something not used anywhere else.
Click the Submit button.

Now give the password you used to the owner of the account you have pushed to. The next time that user logs in, he/she will have a message to retrieve the domain name. They will have to enter the correct password at that time and have a domain profile.

Notes:
1. When a domain name is retrieved, the new owner's default domain profile will be used to update the whois contact info for that domain name.
2. Domains with hosting services cannot be pushed, customers will need to contact you to move those domain names.
3. Domains moved (assigned to a new user) in the domain manager of the admin area do not get any new contact information.
4. Some registrar modules do not support this feature due to the manner in which domain contact information is edited.
5. Some tlds are exempt from this feature due to their special transfer and ownership change rules.

Legal Types for TLD's

***ONLY APPLICABLE TO VERSION 2.9.0 AND ABOVE***

This file should be place in the /includes/[registrar] directory and be named legal.php
This file must then define ALL legal settings for the entire tld offering from this registrar

File information:

$additionaldomainfields[".us"][] = (change the tld to the appropriate setting)

Available settings are:

  • Name (text)
  • Type (text, dropdown, tickbox or radio)
  • Options (value=name pairs only - name is displayed to the user, value is actual value sent to the api)
  • Default (default value - Must be set for tickbox and radio)
  • Description (displayed below the input field
  • Apicommand (the actual api command sent to the registrar - Example: X-US-NEXUS-CATEGORY)
  • Required (make this value required)

Example setting:
<?php
$additionaldomainfields[".us"][] = array(
"Name" => "Nexus Category",
"Type" => "dropdown",
"Required" => "true",
"Options" => "C11=C11,C12=C12,C21=C21,C31=C31,C32=C32",
"Default" => "C11",
"Description" => "This is the description for this field. This is the description for this field.",
"Apicommand" => "nexus1",
);
?>

Setting specific number of years for registrations and renewals

As of 2.9.0 it is possible to set specific number of years that individual TLD's can be registered for or renewed for.

For example, you can have it set so .com domains can only be registered for 1, 2 or 5 years, and when renewing they have the option of 1, 5, or 10 years.

To do this you need to edit the database manually!

  1. Open your AWBS Database in PHPmyAdmin or Equivalent editor
  2. Find the tld_config table, and edit the TLD you would like to change
  3. Find the config_1 field and enter the years you would like to exclude for registering. For example: 1,3,5,7,9 would mean this TLD can only be registered for 2, 4, 6, 8, or 10 years.
  4. To exclude years for renewals, you can use the following format: 1,3,5,7,9|5,6,7,8,9,10 In this example, the TLD could be registered for 2,4,6,8 or 10 years, but can only be renewed for 1,2,3, or 4 years.