WHMCS Module Installation - Setup Guide

After signing a Reseller Contract with our Sales Team, the installation process is divided into a few simple steps, such as:

• Obtaining your API Keys from the EasyDMARC Dashboard
• Downloading and installing the Module itself
• Configuring the module in your WHMCS Admin Panel
• Setting up EasyDMARC as a Product or an add-on to your existing products. 

Note: The module requires PHP 8.1 and is therefore compatible with WHMCS 8.x versions. The Module’s functionality has been tested and verified on WHMCS 8.13

Step 1 - Obtain your API Keys from the EasyDMARC Dashboard

1. Sign in to your EasyDMARC Account and go to our API Page.
2. Click Generate Key to open and provide a name for your new Keys.
3. Click Generate and you will be provided with Client ID and Secret Key
   
   a. Copy both values and keep them confidential at all times

Step 2 - WHMCS Module Installation

1. Download the module .ZIP file from here.
2. Extract the downloaded package to your main WHMCS Directory
   1. The password to extract the file will be provided by our Sales Team upon signing the Reseller Contract.

Step 3 - WHMCS Server Connection setup

1. Sign in to your  WHMCS Admin panel and go to Settings → System Settings
2. Find Servers from All Settings and select it. 
3. Click Add New Server and use the following details to set it up:
   1. Select Module → EasyDMARC
   2. Add Hostname → api2.easydmarc.com
   3. Username → use the generated Client ID
   4. Password → use generated Secret Key
4. After providing all details, click Test Connection, and you should see a connection success message and server configuration page. Name your new Server and click Save Changes
5. Click Create New Group, provide a name, choose the newly created Server from the list below, and click Save Changes.
   
   

 

Step 4 - Product Group and Product Configuration in WHMCS 

Create New Product Group

1. Sign in to your  WHMCS Admin panel and go to Settings → System Settings
2. Find Products/Services from All Settings and select it. 
3. Click Create a New Group. Here you can provide:
   1. Group name, e.g., EasyDMARC Products
   2. URL
   3. Product Group Headline and Tagline
   4. Choose Order Form Template and Available Payment Gateways
   5. Keep Hidden option unchecked
4. Click Save Changes.

 Crete New Product 

1. Go back to Products/Services  and click Create a New Product
   
   
2. Select Product Type, e.g. Other.
3. Choose a previously created Product Group.
4. Name your New Product, e.g., EasyDMARC Premium
   1. This will be the name your Customers will see.
5. Choose the EasyDMARC module from the list.
6. Create as Hidden should be set to OFF.
7. Click Continue.

 

Configure New Product 

After creating your new product, you should configure different options in the following tabs:

1. Details 

You can update the previously provided values, add product descriptions, choose product color, etc. In addition, you can select the option to Require Domain during the EasyDMARC checkout flow. If selected, the domain name Customer provides will be automatically added to their EasyDMARC account.

2. Pricing 

Here you can configure the pricing for your product and choose options such as:

• Payment Type: Free, One-Time, or Recurring
• After selecting the Recurring option, you can choose if you want to sell it in monthly or annual subscriptions
• Configure all other needed settings according to your needs
  
  

3. Module Settings

In this page, you are selecting the EasyDMARC Product Plan that has been assigned to you when signing up for the Reseller Program. This Product Plan will be provisioned for the Customer. Leave Organisation and Domain Group values as None. In addition, you can choose when the product should be activated for the Customer, e.g., upon order placement or when you receive the payment. 

4. Upgrades

You can define the upgrade paths for the configured product, for example, from Plus to Premium plan, depending on the Product Plans you are offering.

Configure EasyDMARC as a New Addon

You can also create EasyDMARC as an add-on and choose with which products it can be purchased, e.g., at a discounted price. Addon configuration is very similar to the configuration of the Product. You also need to specify details such as:

• Addon Name and description
• Pricing 
• Which Product Plan should be provisioned at EasyDMARC when the Customer buys your Addon
• Most importantly, you need to choose Applicable Products for which Addons can be purchased.

• After completing the Addon configuration, your Customers will be able to buy EasyDMARC, for example, with Domains or Hosting services.

 

Customer Access to EasyDMARC after purchase

After purchasing EasyDMARC products from your website, Customers will be able to use a dedicated SSO (Single Sign-On) to access their EasyDMARC account. In addition WHMCS Customer panel will show them information such as:

• All Domains added to the EasyDMARC account with respective Domain Group names
• Their Plan Name
• Domains and Email Volume Limit
• Billing frequency and expiration date

Whenever there are any questions, feel free to reach out EasyDMARC experts.