Install and configure Openprovider module in WHMCS 8.X – Openprovider

The Openprovider module is compatible with WHMCS versions up to 8.6 and PHP 7.4.

Currently, the module is not actively maintained by Openprovider. Pull requests will be reviewed, and potentially merged. As this is an open-source project, users are encouraged to fork and develop the current module to meet their needs.

In this article, you will find everything you need to install and configure the Openprovider module in WHMCS 8.X, so that you can automatically register extensions that also allow additional fields, such as .es domains, without manipulation.

WHMCS Domain Module

The WHMCS module for Openprovider conveniently interacts with your Openprovider account, enabling you to simplify certain domain provisioning and management functions, such as enrollment, renewal, deletion, and contact information changes.

The module keeps the expiration dates of the domain and auto-renew settings aligned between the installation of your WHMCS and Openprovider account, meaning that the same domains are renewed every day.

In addition, the module allows you to search for domain availability using the Openprovider API, enhancing performance over the default domain availability check.

Install and configure the Openprovider Module
Download modules from : https://github.com/openprovider/Openprovider-WHMCS-domains/releases

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.

Enter the credentials for an API user. Ensure API access is enabled in the Openprovider Control Panel for the credentials you are using
Click Save
Import TLD/domain prices via Openprovider API by running the modules/registrars/openprovider/cron/DownloadTldPrices.php script (either as a cron job or run the script from the terminal of the hosting server). Please refer to Import and sync TLD prices from Openprovider for detailed instructions.
Navigate to Utilities > Registrar TLD Sync to select TLDs to import prices, 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 TLD that 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.

Optional and Advanced configurations

Lookup provider and domain name spinning

Click "change" to Choose Openprovider as the lookup provider
Choose "configure" to select namespinning options

Enable premium domains

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 the premium fee correctly, potentially meaning that your client will pay significantly less for the domain.

Navigate to Configuration >> System Settings >> Domain Pricing
Enable Support for 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 it 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

Upload the contents of <Module directory>/custom-pages to the top level of your WHMCS folder i.e. <your WHMCS directory>/
Create a directory named overrides within the <your WHMCS directory>/lang directory.
Copy the file lang/overrides/english.php to the overrides directory.
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

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 "Domain Currently 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

[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.

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 there are any connectivity issues with Openprovider, or API commands are not working for some reason, the first troubleshooting step should be to look at the API logs.

Go to the Module Log at Configuration > System Logs or, prior to WHMCS 8.0, Utilities > Logs.
Set Module Logging to On.

And you can find the raw API commands being sent and received by your WHMCS modules. The responses should contain some information about how the problem can be solved.

FAQ

Common issues and solutions for them can be found here.