Skip to content

Latest commit

 

History

History
202 lines (140 loc) · 13.1 KB

README-EN.md

File metadata and controls

202 lines (140 loc) · 13.1 KB

Installation and Integration guide

Minimum Requirements

  • WHMCS 7.8 or higher
  • PHP7.4 or higher (Recommended 8.1)
  • PHP SOAPClient plugin must be active.
  • Customer T.C. Customfields containing identity information / Tax Number / Tax Office information. (Optional)

Setup

!!!! Attention !!!!

If you are upgrading, back up your old files before installation.

Put the "modules" folder in the folder you downloaded into the folder where Whmcs is installed. (Example: /home/whmcs/public_html) Discard .gitinore, README.md, LICENSE files.

image

  • Go to System Settings Section

image

  • Go to the Domain Registrar Section

image

  • On the page you entered, if you left the module files in the correct folder, "DomainNameAPI" will appear.
  • After activating, enter the username and password obtained by us.
  • After saving, your username and current balance will be visible.
  • Match the TR Identity Number and Tax Number Information to be used to obtain the .tr domain name of your users, if any, from the settings you have seen.
  • If you are using single-primary currency except USD You may set "Exchange Convertion For TLD Sync" setting. (This setting is using for only pricing sync for regional TLD imports. Otherwise you do not need to change)

+ Youtube link


Pricing, TLD Attribution and Lookup Settings

image

-Go to Domain Pricing from System Settings.


image

  • Determine the TLD you want to sell. (Example: .com.tr)
  • Select "Domain Name API" for auto registration.
  • Select the EPP code Option.
  • For pricing, you can enter manually. You can also set a Bulk Price. (will be explained in the next section).

image

-Instead of using public Whois servers as a domain query source, you can use the domainname api. For this, press the "Change" button in the "Lookup provider" section, select the "DomainNameApi" option that appears at the bottom after the domain registry option, then choose which TLDs to use.

For more information : Whmcs Domain Pricing


Bulk Pricing & & Automated Pricing

image

image

  • Go to Registrar TLD Sync from Utilities section. Select "DomainNameApi" from the screen that comes up, wait a bit.
  • On the next screen, all tlds in our system are cross-compared with all tlds on whmcs, profit margin and loss are calculated and displayed in bulk, allowing import. For more information : Whmcs TLD Sync

Manager's Perspective

image

  • You can send a "Deletion request" for the domain name.
  • You can send "Transfer Cancellation" for the domain name.
  • You can see the live status, instant start and end of the domain name
  • You can list your subs
  • You can view additional field information

General Settings

image image

  • Go to General Settings from System Settings, select the domain tab.
  • Activate the 'Allow clients to register domains with you' option if you want your customers to be able to register domain names themselves.
  • Activate the 'Allow clients to transfer a domain to you' option if you want your customers to be able to transfer the domain name themselves.
  • Activate the 'Enable Renewal Orders' option if you want your customers to be able to renew their domain name before the maturity date.
  • Activate the 'Auto Renew on Payment' option if you want your customers to be reflected in the payment renewal at the same time.
  • Activate the 'Domain Sync Enabled' option if you want the current domain to be checked and synchronized at regular intervals. We recommend enabling this option.
  • If you want to manage Turkish, Hebrew, Arabic, Russian etc. domain names, activate the 'Allow IDN Domains' option.
  • In the 'Default Nameserver' information, enter your nameserver information.

Sync Settings - (Senkronizasyon Ayarları)

image image

  • Go to Automation settings from System Settings. Go to the Domain Sync Settings section.
  • Turn on domain synchronization,
  • Activate the "Sync Next Due Date" option if you want the end date to be changed in the update.
  • Adjust other settings according to the intensity of your system.

Error - Detail View - (Hata - Detay Görüntüleme)

image image

  • Go to the Module Log section on the right from the System Logs option.
  • Find the relevant log and click on the date
  • You can view detailed request, reply and filtered reply.

!! We recommend that the system log is closed for daily use in terms of system performance. For detailed information : Whmcs Logging

Tests

Test Name GTLD TRTLD
Register
Transfer
Renew
Nameserver
RegistrarLock
Contact
EPP
Delete
SubNameserver
Availability
PricingSnyc
CancelTransfer
Sync
TransferSync
Test Adı GTLD TRTLD
Register
Transfer
Renew
Nameserver
RegistrarLock
Contact
EPP
Delete
SubNameserver
Availability
PricingSnyc
CancelTransfer
Sync
TransferSync

Troubleshooting

  • I alredy added new customfields but in settings i cannot see them.
  • The cache may have expired. Delete all files in cache folder.

  • I got error "Parsing WSDL: Couldn't load from..."
  • Looks like network problem. Your Server's Ip address might be blocked by registry. Reach us for solving.

Return and Error Codes with Explanations

Code Explanation Details
1000 Command completed successfully Command completed successfully
1001 Command completed successfully; action pending. Command completed successfully; action pending
2003 Required parameter missing Required parameter missing. For example: Missing phone number in contact information
2105 Object is not eligible for renewal Object is not eligible for renewal, update actions locked. Status must not be "clientupdateprohibited". May be due to other status conditions.
2200 Authentication error Authentication error, authorization code incorrect, or domain is registered with another registrar.
2302 Object exists Domain name or nameserver information already exists in the database. Cannot be registered.
2303 Object does not exist Domain name or nameserver information does not exist in the database. New registration required.
2304 Object status prohibits operation Object status prohibits the action, updates locked. Status must not be "clientupdateprohibited". May be due to other status conditions.