Domain Module for WHMCS 8.x

This new version of Openprovider domain module is compatible with WHMCS versions up to 8.10.1 and PHP 8.1.

If you notice any bugs or lack of functionality or other problems, please report it to Openprovider Support team immediately with all available details (reseller_id, error details, module logs, WHMCS & PHP & web server version details and screenshot(s)/screen record if possible) so that we can rectify issues accordingly. The more details you can provide about issues, the faster we can reproduce and investigate it for a resolution. Your help in this regard is greatly appreciated!

Introduction

The Openprovider WHMCS module integrates conveniently with your Openprovider account, allowing you to automate domain provisioning and management tasks, such as registration, renewal, deletion, updates to contact details, etc.

The module keeps domain expiration dates, status and auto renew settings synchronized (on all Pending Transfer, Pending Registration, and Active status domains) between your WHMCS installation and Openprovider account, making sure the correct domains get renewed each day.

Additionally, the module allows you to use the Openprovider API to check for domain availability, increasing performance over the default domain availability check.

Features

Domain registrations, renewals and transfers
Domain updates
TLD Price Sync
Domain availability lookup service
Domain name spinning service
Domain Sync using WHMCS native cron
Domain status synchronization reports
Renew domains upon transfer completion
DNSSEC management
DNS management (Openprovider Standard DNS)
Nameserver management (for domains registered through Openprovider)

Install and configure the Openprovider module

Copy files into the module directories

Upload the contents of /modules/registrars/openprovider from this repository to <your WHMCS directory>/modules/registrars/openprovider
Upload the contents of /includes/hooks/ to <your WHMCS directory>/includes/hooks
If you do not have the file <your WHMCS directory>/resources/domains/additionalfields.php then add the example version from resources/domains/additionalfields.php
- Otherwise add the following lines to the top of your additionalfields.php file. :
```
<?php
if (function_exists('openprovider_additional_fields'))
$additionaldomainfields = openprovider_additional_fields();
```
[Optional] Upload <Module directory>/modules/addons/openprovider to <WHMCS directory>/modules/addons

Basic Configurations
Navigate to Configuration >> System Settings >> Domain Registrars and activate Openprovider module.

Enter API credentials (username and password, not hash) of your user. Ensure API access is enabled in the Openprovier control panel for the credentials you are using. Please refer to this KB article if API is not enabled already.
Click Save.
Navigate to Utilities > Registrar TLD Sync and click on the Openprovider logo to fetch list of domain extensions and pricing information, configure margin, Automatic Registration, etc. For more details, please refer to Registrar TLD Sync.

Navigate to Configuration >> System Settings >> Domain Pricing and select Openprovider as registrar for the TLDs which you want to sell via Openprovider

That's all you need to do to get started selling domains from Openprovider! Additional configurations can be found below.

Advanced configurations

Lookup provider and domain name spinning

Navigate to Configuration > System Settings > Domain Pricing or, prior to WHMCS 8.0, Setup > Products/Services > Domain Pricing
Under Lookup Provider Click Change to Choose Openprovider as the lookup provider

Choose "configure" to select namespinning options

Enable premium domains (optional)

First make sure that the currency that you are using to pay Openprovider is configured in Configuration >> System Settings >> Currencies (prior to WHMCS 8.0, Setup >> Payments >> Currencies) and click on Update Exchange Rate. Otherwise WHMCS will not use premium fee correctly, potentially meaning that your client will pay significantly less for the domain.

Enable Support premium domains
Configure premium pricing and margins
In the Advanced configuration file of the module ( /modules/registrars/openprovider/configuration/advanced-module-configurations.php) find the parameter "OpenproviderPremium" and set to true

Allow additional DNS records

If you plan on allowing your end users to edit their own DNS records, and want them to be able to create all record types supported by Openprovider, you can make some modifications to the WHMCS templates as described here:

Modify WHMCS templates to allow all DNS record types which Openprovider supports

Allow end users to edit DNSSEC records

Navigate to the target client profile > domains select the desired domain and under Management Tools activate "DNS Management"
The below option will appear in the domain details page of the chosen domain

Notes:
- If you experience any difficulty accessing the DNSSEC page, please check if file 'dnssec.php' exists in your WHMCS directory. If the file doesn't exist, please manually upload/copy the contents of <Module directory>/registrars/openprovider/custom-pages (dnssec.php file) to the top level of your WHMCS folder (i.e. <your WHMCS directory>/)
- If you see the menu option as "dnssectabname" as shown in the screenshot below, copy the folder <Module directory>/lang/overrides to <your WHMCS directory>/lang/ folder.

Configure TLDs which don't allow locking (.nl, .be, .eu, .es)

Not all TLDs allow domain locking, but WHMCS assumes that this option is available for all domains. As a result, end users will see a warning "you domain is unlocked" when they visit the domain details page. You can hide this option with the following changes to your template files.

Open clientareadomaindetails.tpl in the template you are using and replace

{if $lockstatus eq "unlocked"}

with

{$domainSplit = "."|explode:$domain}
{$domainTld = $domain|replace: $domainSplit.0 : ""}
{if $lockstatus eq "unlocked" && $domainTld != '.eu' && $domainTld != '.nl' && $domainTld != '.be'  && $domainTld != '.es'}

Configure tag management

Set up tag management to send custom emails to the end users of your resellers.

Configuration instructions can be found here

Decide whether to use Openprovider Auto-renew

Various options exist for managing domain renewals. A detailed explanation of your options can be found here

Custom DNS Templates

Create a custom DNS template in the Openprovider control panel (DNS management > Manage DNS templates),
Put the name of it in the advanced configuration file and any domain created with the Openprovider nameservers will have a DNS zone automatically created on Openprovider nameservers according to your DNS template.

Troubleshooting

If domain operations from WHMCS are not working or showing errors or if there is any connectivity issues with Openprovider or API errors, the first troubleshooting step should be to enable module logging, reproduce the issue/error and review the System Module Debug Log.

Navigate to Configuration > System Logs > Module Log (prior to WHMCS 8.0, Utilities > Logs) and you can find the raw API commands being sent and received by your WHMCS modules. The responses should contain additional information about the problem and how it can be solved.

alt text

If you have Openprovider addon installed and activated in your WHMCS, you should be able to download module and activity logs from Addons >> Openprovider >> click on the 'Download' button.

For more details, please refer to WHMCS documentation: Troubleshooting Module Problems and System Logs

Important: Only enable module logging for troubleshooting or testing purposes. At all other times, make certain that you set Module Logging to Off.

FAQ

Common issues and solutions for them can be found here.

[DEPRECATED] Configure the Openprovider cron sync

This feature is deprecated since version 5.3 of the Openprovider domain module, and is not recommended for versions WHMCS 8+. We suggest that you use the WHMCS native domain sync and do not use the Openprovider custom sync for WHMCS 8 and higher.

Configuration instructions can be found here

openprovider / Openprovider-WHMCS-domains

readme