Registrar module Settings

From NETIM
(Difference between revisions)
Jump to: navigation, search
(Local presence service management)
 
(16 intermediate revisions by one user not shown)
Line 18: Line 18:
 
Enter your handle and password defined for the production system
 
Enter your handle and password defined for the production system
  
Enter the direct URL to the latest WSDL of the API
+
Enter the direct URL to the API corresponding to the version of the module
  
[[Release_notes]]
+
[[Release_notes | API release notes]]
 +
 
 +
[[Get_NETIM_Registrar_module | Module releases notes]]
  
  
Line 27: Line 29:
 
Enter your handle and password defined for the tryout system
 
Enter your handle and password defined for the tryout system
  
Enter the direct URL to the latest WSDL of the API
+
Enter the direct URL to the API corresponding to the version of the module
  
[[Release_notes]]
+
[[Release_notes | API release notes]]
 +
 
 +
[[Get_NETIM_Registrar_module | Module releases notes]]
  
  
Line 36: Line 40:
 
- The credentials and the url for both systems are differents
 
- The credentials and the url for both systems are differents
  
- Ensure that you are using the latest WSDL from API
+
 
  
 
== [[File:Fleche.gif|link=]] General Domain Settings ==
 
== [[File:Fleche.gif|link=]] General Domain Settings ==
Line 61: Line 65:
 
client will be defined by default for them at the registry and disclosed into Whois data.
 
client will be defined by default for them at the registry and disclosed into Whois data.
  
If unchecked, the module will use your reseller handle for creating these contacts.
+
If "User Clients Details" is not ticked, the module will use for the contacts the information as follow:
Please note that "Default Billing/Admin/Tech Contact Details" are not used by our module.
+
 
 +
- The contact information provided if the first and last name are filled in,
 +
 
 +
- Otherwise the contact ID defined in the configuration file with variable $netim_default_contact_id
 +
 
 +
- Otherwise the reseller ID
 +
 
 +
 
 +
===Synchronization===
 +
 
 +
Settings "Sync Next Due Date" and "Domain Sync Notify Only" are taken into account
 +
 
 +
 
 +
'''Module <= 2.5'''
 +
 
 +
Synchronization of domains by the cron of WHMCS is not taken into account.
 +
 
 +
To synchronize domains, the netimsync.php script must be scheduled (see installation)
 +
 
 +
 
 +
'''Module > 2.5'''
 +
 
 +
Synchronization of domains is done by the cron of WHMCS if activated in the general settings.
 +
 
 +
Neverless, the asynchronous results must still be synchronized.
 +
 
 +
To synchronize pending operations, the netim_opesync.php script must be scheduled (see installation)
  
  
Line 80: Line 110:
 
Example for .COM domain names:
 
Example for .COM domain names:
  
1. Look at the extension values here [[COM#TLD_values]]
+
1. Look at the extension values here [[COM#TLD_values]]
 
+
2. Look at PeriodCreate and PeriodRenew which define the years available on this extension and enable the years into the matrix
+
2. Look at PeriodCreate and PeriodRenew which define the years available on this extension and enable the years into the matrix
   
+
You can get a range (minumum - maximum) :
You can get a range (minumum - maximum) :
+
 
   1-10 means 1 to 10 years (Check all years)
 
   1-10 means 1 to 10 years (Check all years)
 
   2-2 means 2 years (Check only the year 2)
 
   2-2 means 2 years (Check only the year 2)
 
+
You can get a list (1:2:3:...)
+
You can get a list (1:2:3:...)
 
   1:3:5 means 1 or 3 or 5 years (Check only the years 1, 3 , 5)
 
   1:3:5 means 1 or 3 or 5 years (Check only the years 1, 3 , 5)
 
   2:4:6:8:10 means every two years (Check only the years 2, 4, 6, 8, 10)
 
   2:4:6:8:10 means every two years (Check only the years 2, 4, 6, 8, 10)
 +
 +
4. Enter your pricing "Register" / "Renewal" for activated years
 +
''A value equal to 0 means that the year is not enabled''
 +
 
 +
5. Enter your pricing "Transfer" for year 1 and leave other years with value 0
 +
''A transfer is only valid for one year''
 +
Caution: NETIM doesn't accept all transfers, check if domainTransferIn has the value 1 in [[COM#Operations]]
  
4. Enter your pricing "Register" / "Renewal" for activated years
 
  
''A value equal to 0 means that the year is not enabled''
+
'''From WHMCS 7.5'''
 
+
5. Enter your pricing "Transfer" for year 1 and leave other years with value 0
+
  
''A transfer is only valid for one year''
+
You can define a pricing for renewal grace periods and redemption periods by clicking on the toothed wheel
  
Caution: NETIM doesn't accept all transfers, check if domainTransferIn has the value 1 in [[COM#Operations]]
+
[[File:grace.png | border |link=]]
 +
 
 +
 
 +
Example for .COM domain names:
 +
 
 +
1. Look at the extension values here [[COM#TLD_values]]
 +
 +
2. Enter the value concerning DelaiRenewAfterExpiration for the grace period.
 +
However, the fee to be entered is the additional fee for this period.
 +
The client will be charged your renewal fee + your grace period fee.
 +
As reseller, you will be charged our renewal fee.
 +
 
 +
3. Enter the value concerning DelaiRestoreAfterDelete for the redemption period.
 +
However, the fee to be entered is the additional fee for this period.
 +
The client will be charged your renewal fee + your redemption period fee.
 +
As reseller, you will be charged our restore fee.
  
 
=== DNS Management ===
 
=== DNS Management ===
Line 107: Line 155:
 
as define a web forwarding. As part of this module, you can use our services free of charge:
 
as define a web forwarding. As part of this module, you can use our services free of charge:
  
http://www.netim.com/domain/services/domain-name-dns.php
+
https://www.netim.com/domain-name/dns-management.html
  
http://www.netim.com/domain/services/domain-name-web-forwarding.php
+
https://www.netim.com/domain-name/web-forwarding.html
  
 
  '''Additional Information '''
 
  '''Additional Information '''
Line 121: Line 169:
 
This feature allows the client to create email addresses redirected to the address of their choice:
 
This feature allows the client to create email addresses redirected to the address of their choice:
  
http://www.netim.com/domain/services/domain-name-emails.php
+
https://www.netim.com/domain-name/email-forwarding.html
  
 
   '''Additional Information '''
 
   '''Additional Information '''
Line 130: Line 178:
 
=== ID protection ===
 
=== ID protection ===
  
Our module does not manage this feature, leave unchecked.
+
This feature allows the client to hide his contact information in the whois.
  
'''Additional Information '''
+
https://www.netim.com/domain-name/whois-privacy.html
Netim does not manage this service
+
  
 +
'''Additional Information '''
 +
  All extensions do not have the privacy whois feature, see [[:Category:Tld]], then 'HasWhoisPrivacy' in TLD values
  
  
Line 148: Line 197:
 
=== Automated Registration ===
 
=== Automated Registration ===
  
Select from the list of activated registrars, which one will be used by default when registering a domain name in this extension
+
Select, from the list of activated registrars, NETIM which will be used by default when registering a domain name in this extension
  
  
Line 156: Line 205:
  
 
   Edit the file  /whmcs_directory/modules/netim/config.inc.php
 
   Edit the file  /whmcs_directory/modules/netim/config.inc.php
 
 
===ToDo List Management ===
 
 
Our module can add an entry in the todo list (full administrator group) for each failed operation so that you can investigate.
 
 
You can enable or disable with following variables
 
 
'''Domain name Registration'''
 
 
$netim_report_domainCreate_error_in_todolist (true/false)
 
 
'''Domain name Renewal'''
 
 
$netim_report_domainRenew_error_in_todolist (true/false)
 
 
'''Domain name TransferIn'''
 
 
$netim_report_domainTransfer_error_in_todolist (true/false)
 
  
  
Line 235: Line 265:
 
If you are able to provide the local contact service yourself or if you use a third party, please proceed as follow:
 
If you are able to provide the local contact service yourself or if you use a third party, please proceed as follow:
  
1. Create a contact ID who matches the rules of the extension
+
1. Create a contact ID that matches the rules for the extension
  
 
2. Update $localcontactID with the newly created contact ID
 
2. Update $localcontactID with the newly created contact ID
 +
  
 
===Trustee service management ===
 
===Trustee service management ===
Line 253: Line 284:
 
'''If the registrant doesn't match the rules'''
 
'''If the registrant doesn't match the rules'''
  
The variable $netim_force_use_trusteeservice defines which extensions are allowed to use the trustee service in such case.  
+
The variable $netim_force_use_trusteeservice defines which extensions are allowed to use the trustee service.  
  
 
If the extension is set to true, the domain name is registered with the trustee ID defined in $trusteeID for the given extension
 
If the extension is set to true, the domain name is registered with the trustee ID defined in $trusteeID for the given extension
Line 260: Line 291:
  
 
  '''Caution'''
 
  '''Caution'''
  The trustee service have generally a yearly fee. Your reseller account will be charged for the service in addition to the transaction fee.
+
  The trustee service usually has a yearly fee. Your reseller account will be charged for the service in addition to the transaction fee.
 
  If an extension is set to true, ensure that you have taken into account the fee in your pricing.
 
  If an extension is set to true, ensure that you have taken into account the fee in your pricing.
  
Line 275: Line 306:
 
===Domain name Restoration management ===
 
===Domain name Restoration management ===
  
For some extensions, it is possible to restore a domain after its removal. But this notion of restoration is not supported by the application.
+
For some extensions, it is possible to restore a domain after its removal. However this notion of restoration is not supported by the application.
  
  The variable $netim_force_restore_during_renewal force or not the restoration of the domain name if possible
+
  The variable $netim_force_restore_during_renewal forces, or not, the restoration of the domain name if possible.
 
  Warning, the price of restoration may be much higher than a simple renewal.
 
  Warning, the price of restoration may be much higher than a simple renewal.
  
Line 292: Line 323:
 
  Pending operations at NETIM registrar
 
  Pending operations at NETIM registrar
  
Then go back to admin summary and will see them
+
You can then go back to admin summary and to see them

Latest revision as of 17:28, 31 January 2019

Contents

[edit] Fleche.gif Registrar settings

You need to setup your access to our API into the WHMCS's admin control panel, section "Setup" > "Products / services" > "Domain registrars". You will find Netim in the list.

Whmcs install registrar 1.gif


Click on "Activate" and configure the module by providing your credentials and the API


Whmcs install registrar 2.gif


To use in production

Enter your handle and password defined for the production system

Enter the direct URL to the API corresponding to the version of the module

API release notes

Module releases notes


To use in tryout

Enter your handle and password defined for the tryout system

Enter the direct URL to the API corresponding to the version of the module

API release notes

Module releases notes


Caution

- The credentials and the url for both systems are differents


[edit] Fleche.gif General Domain Settings

You can define general settings for domain name management into "Setup" > "General settings" > "Domains"


[edit] Default Nameservers

Nameservers defined here will be shown by default for every domain names.

If you only use Netim module for your domain names, and if you want to use our DNS name servers, you can set ns1.netim.net, ns2.netim.net, ns3.netim.net, ns4.netim.net, ns5.netim.net

If you have activated custom name servers at NETIM (see Setup_the_white_label#Custom_DNS_name_servers), you can define them here


[edit] Contacts management

A domain name has an administrative contact, a technical contact and a billing contact.

If "Use Clients Details" is selected, then we will use client's details for creating these contact. Then your client will be defined by default for them at the registry and disclosed into Whois data.

If "User Clients Details" is not ticked, the module will use for the contacts the information as follow:

- The contact information provided if the first and last name are filled in,

- Otherwise the contact ID defined in the configuration file with variable $netim_default_contact_id

- Otherwise the reseller ID


[edit] Synchronization

Settings "Sync Next Due Date" and "Domain Sync Notify Only" are taken into account


Module <= 2.5

Synchronization of domains by the cron of WHMCS is not taken into account.

To synchronize domains, the netimsync.php script must be scheduled (see installation)


Module > 2.5

Synchronization of domains is done by the cron of WHMCS if activated in the general settings.

Neverless, the asynchronous results must still be synchronized.

To synchronize pending operations, the netim_opesync.php script must be scheduled (see installation)


[edit] Fleche.gif Domain pricing

In section "Setup" > "Products / services" > "Domain pricing", you define all TLDs you want to sell

You will need to select "Netim" for each extension you want to register with us as follow:

Whmcs install tld 1.gif


[edit] Prices

You must define your pricing according to the extension.

Example for .COM domain names:

1. Look at the extension values here COM#TLD_values

2. Look at PeriodCreate and PeriodRenew which define the years available on this extension and enable the years into the matrix
You can get a range (minumum - maximum) :
  1-10 means 1 to 10 years (Check all years)
  2-2 means 2 years (Check only the year 2)

You can get a list (1:2:3:...)
  1:3:5 means 1 or 3 or 5 years (Check only the years 1, 3 , 5)
  2:4:6:8:10 means every two years (Check only the years 2, 4, 6, 8, 10)

4. Enter your pricing "Register" / "Renewal" for activated years
A value equal to 0 means that the year is not enabled
  
5. Enter your pricing "Transfer" for year 1 and leave other years with value 0
A transfer is only valid for one year
Caution: NETIM doesn't accept all transfers, check if domainTransferIn has the value 1 in COM#Operations


From WHMCS 7.5

You can define a pricing for renewal grace periods and redemption periods by clicking on the toothed wheel

Grace.png


Example for .COM domain names:

1. Look at the extension values here COM#TLD_values

2. Enter the value concerning DelaiRenewAfterExpiration for the grace period. 
However, the fee to be entered is the additional fee for this period. 
The client will be charged your renewal fee + your grace period fee. 
As reseller, you will be charged our renewal fee. 
  
3. Enter the value concerning DelaiRestoreAfterDelete for the redemption period. 
However, the fee to be entered is the additional fee for this period. 
The client will be charged your renewal fee + your redemption period fee. 
As reseller, you will be charged our restore fee.

[edit] DNS Management

This feature allows the client to manage their DNS settings. They can update DNS records as well as define a web forwarding. As part of this module, you can use our services free of charge:

https://www.netim.com/domain-name/dns-management.html

https://www.netim.com/domain-name/web-forwarding.html

Additional Information 
Available for all extensions
Domain names must use our DNS servers


[edit] Email forwarding

This feature allows the client to create email addresses redirected to the address of their choice:

https://www.netim.com/domain-name/email-forwarding.html

 Additional Information 
 Available for all extensions
 Domain names must use our DNS servers


[edit] ID protection

This feature allows the client to hide his contact information in the whois.

https://www.netim.com/domain-name/whois-privacy.html

Additional Information 
 All extensions do not have the privacy whois feature, see Category:Tld, then 'HasWhoisPrivacy' in TLD values


[edit] EPP code

This feature must be checked if the extension supports the EPP transfer code.

Additional Information 
All extensions do not have EPP code, see Category:Tld, then 'HasEppCode' in TLD values


[edit] Automated Registration

Select, from the list of activated registrars, NETIM which will be used by default when registering a domain name in this extension


[edit] Fleche.gif Specific Settings

Specific parameters below are used to define the behavior of the module for certain actions

 Edit the file  /whmcs_directory/modules/netim/config.inc.php


[edit] Admin notes notifications Management

Each domain has notes managed by the administrator. This field is visible in the administrator section on the details of a domain name. Our module can use this field to notify you of the result of operations.

You can enable or disable with following variables

Domain name Registration

$netim_report_domainCreate_in_adminnotes (true/false)

Domain name Renewal

$netim_report_domainRenew_in_adminnotes (true/false)

Domain name TransferIn

$netim_report_domainTransfer_in_adminnotes (true/false)


[edit] Local presence service management

Following extensions, restrictions may apply on the location of the administrative contact such as the country (.de, .hu, ..) or the city (.berlin, ...)

When ordering a domain name (registration or transfer), the administrative contact is selected according to general settings WHMCS_Settings#Contacts_management

1. If you have activated "Use Clients Details", we will use the client for all contacts. 
In such case, we will check if your client matches the rules as administrative contact for the tld
2. If you don't have activated "Use Clients Details", we will use your details as defined for your reseller account. 
In such case, we will check if you match the rules as the administrative contact for the tld

The variable $localcontactcountries lists all country codes for a given tld. If the administrative contact's country is registered into the list, the administrative contact matches the rules

The variable $localcontactcities lists all zipcodes for a given tld. If the administrative contact's zipcode is registered into the list, the administrative contact matches the rules


If the administrative contact matches the rules

The Local presence service is not used


If the administrative contact doesn't match the rules

The variable $netim_force_use_localcontactservice is used to define which extensions are allowed to use the local contact.

If the extension is set to true, the local contact ID is used from $localcontactID for the given extension

If the extension is set to false, the current administrative contact is used and the registration will fail.

Caution
The local contact service have generally a yearly fee. Your reseller account will be charged for the service in addition to transaction fee
If an extension is set to true, ensure that you have taken into account the fee in your pricing.


Use your own local contact service

If you are able to provide the local contact service yourself or if you use a third party, please proceed as follow:

1. Create a contact ID that matches the rules for the extension

2. Update $localcontactID with the newly created contact ID


[edit] Trustee service management

Following extensions, restrictions may apply on the registrant's country (.eu, .fr, .hu, ..)

The variable $trusteecountries lists all country codes for a given tld. If the registrant's country is registered into the list, the module assumes the registrant matches the rules


If the registrant matches the rules

The trustee service is not used


If the registrant doesn't match the rules

The variable $netim_force_use_trusteeservice defines which extensions are allowed to use the trustee service.

If the extension is set to true, the domain name is registered with the trustee ID defined in $trusteeID for the given extension

If the extension is set to false, the current registrant is used and the registration will fail.

Caution
The trustee service usually has a yearly fee. Your reseller account will be charged for the service in addition to the transaction fee.
If an extension is set to true, ensure that you have taken into account the fee in your pricing.


Use your own trustee service

If you are able to provide the trustee service by yourself or if you use a third party, please proceed as follow:

1. Create a registrant contact ID who matches the rules of the extension

2. Update $trusteeID with the newly created contact ID


[edit] Domain name Restoration management

For some extensions, it is possible to restore a domain after its removal. However this notion of restoration is not supported by the application.

The variable $netim_force_restore_during_renewal forces, or not, the restoration of the domain name if possible.
Warning, the price of restoration may be much higher than a simple renewal.


[edit] Fleche.gif Widgets

Access to Widgets is defined on a per admin role group basis.

In order to activate our widgets, go to Setup > Administrator Roles and then click the edit icon next to the admin role group you want to change.

Once on the permissions page, simply scroll down to the section labelled Widgets and from there you'll be able to enable/disable the Widgets accessible to that group by checking or unchecking the boxes. Our widgets are

NETIM registrar account
Pending operations at NETIM registrar

You can then go back to admin summary and to see them

Personal tools
Namespaces

Variants
Actions
Your account
Domain names
Shared Hosting
Old Hosting offers
SSL Certificates
Resellers
Affiliates
Contact Us
Miscellaneous