MaxMind is a leading provider of IP intelligence and online fraud prevention tools.

==Setup and Configuration==

To enable MaxMind integration in WHMCS 8.2 and later, follow the steps below:

* Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.
* Click '''Activate''' for MaxMind.
* Check the checkbox to enable MaxMind.
* Enter your '''MaxMind User ID''' and the '''Licence Key'''. You can find these within the '''My License Key''' page inside the MaxMind online portal.
* Click '''Save'''.

To enable MaxMind integration in WHMCS 8.1 and earlier, follow the steps below:

* Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''.
* Choose '''MaxMind''' from the menu.
* Check the '''Enable''' checkbox.
* Enter your '''MaxMind User ID''' and the '''Licence Key'''. You can find these within the '''My License Key''' page inside the MaxMind online portal.
* Click '''Save'''.

==Configuration Options==

===Choosing a Service Type===

MaxMind offers three different levels of check at the time of writing:

* '''Score''' - minFraud score provides only a risk score in WHMCS. No other data is available when using this check type. MaxMind recommend this check type to build your own risk modelling.
* '''Insights''' - minFraud Insights provide a wide range of data to check the potential risk of an order. Information regarding the IP location, the country data and email address is provided with this check type. minFraud Insights is the most comparable offering to the older V1 API.
* '''Factors''' - minFraud Factors builds on the same data as Insights, and then provides additional scoring based on the order input. Check the comparison page for the subscores that can be provided.'''

Essentially, the higher the level, the more analytics and metrics feedback you will receive. The different service types each have differing costs associated with them. Please refer to the MaxMind website for more details.

===MaxMind Fraud Risk Score===

Orders that receive a risk score higher than the value entered here will be marked as fraudulent and prevented from completing checkout.

The default value is 20. A value between 0.01 and 99.9 can be entered. This threshold can then be adjusted up or down depending upon results. For more information refer to [https://support.maxmind.com/what-is-the-riskscore/ What is the riskScore?]

Entering 0 in the Risk Score field will disable checking this option and is not recommended.

===Reject Free Email Service===

Ticking this option checks if the e-mail domain used by the customer is from a free e-mail provider and if so will flag the order as fraud. Examples of free e-mail providers include the following: Yahoo.com, Gmail.com, and MSN.com. The MaxMind system currently has categorised 31,000 free e-mail domain providers around the world.

===Reject Country Mismatch===

Select this option to mark an order as fraudulent if the billing address provided by a client is significantly different from the location of the IP Address used to place the order.

===Reject Anonymous Networks===

Select this option to mark an order as fraudulent if the order is placed via an anonymous network such as a proxy or VPN.

===Reject High Risk Country===

Select this option to mark an order as fraudulent if the transaction's billing address or IP address is located in a country that MaxMind has flagged as high risk.

===Custom Rules===

Custom Rules can be used to reject an orders based on a combination of rules you setup. Custom Rules can be created and managed from within your MaxMind account, more information is available in the [https://support.maxmind.com/custom-rules-guide/ Custom Rules documentation].<br/>
Accept Custom Rules have no effect on the order status.

==Upgrading from MaxMind V1.x to V2==

Your configuration will be automatically updated when upgrading a WHMCS installation from WHMCS 7.5 or earlier to WHMCS 7.6 or later. However, one additional configuration is required to allow fraud checking to continue. The new '''User ID''' configuration parameter must be set for API Authentication to succeed. Your MaxMind User ID can be found on the My License Key page in a MaxMind account.

==Legacy MaxMind Module==

If you are looking for documentation for the MaxMind module in WHMCS 7.5 or earlier, please see [[MaxMind_Legacy_Module]]

==Common Errors==
===MAX_REQUESTS_REACHED===
This means you have run out of MinFraud queries on your MaxMind account, you will need to purchase more queries via the MaxMind website.

===INVALID_LICENSE_KEY===
This error indicates that the license key you provided in your settings is incorrect. It can also indicate that your license key is not valid for the service you are attempting to access. You should first verify your license key has been properly entered at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''. If the license key is correct, you should contact MaxMind to inquire why your license key is returning as invalid.

===LICENSE_REQUIRED===
This error will be returned if no license key has been provided. Please check your license key setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''.

===USER_ID_REQUIRED===
This error will be returned if no User ID has been provided. Please check your license key setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''.

===PERMISSION_REQUIRED===
This is returned if you do not have permission to use the service. Please contact MaxMind for more information.

===IP_NOT_FOUND===
This error will be returned if the IP address is not valid, if it is not public, or if it is not in our GeoIP database.

===CITY_NOT_FOUND===
MaxMind maintain a list of valid cities, this city in the client's Profile at the time of ordering must match one of the cities on MaxMind's list, otherwise the order will be rejected with this error.

{{modules}}

File:Product-list-page-promo.png

2021-08-19T20:13:16Z

Joshua: Joshua uploaded a new version of File:Product-list-page-promo.png

File:Product-list-page-promo.png

2021-08-19T20:10:27Z

Joshua: Joshua uploaded a new version of File:Product-list-page-promo.png

MarketConnect Promotions and Upsells

2021-08-19T20:02:46Z

Joshua: /* Product List Page */

WHMCS MarketConnect comes with ready made landing pages and promotions/upsells built into the client area and shopping cart user experience.

You can control these and turn them on and off via the MarketConnect management page within the admin area.

==Promotions==

When enabled, MarketConnect can show promotional messages to customers promoting products and services which they do not have. These are supported in the Client Area homepage, the services list, specific product details and in the cart process.

===Homepage===

When the homepage banners are activated, they will show for logged in clients that don't have the service being offered. In this example a client has a hosting package but has not ordered a Weebly Site Builder service. We show them a banner highlighting the pricing we have configured in the Admin interface:

[[File:Screenshot 2017-05-16 11.37.28.png|750px]]

The learn more link takes you to our product specific landing page. The highlighted button takes you into a store page where you can setup the details of your order and progress to checking out.

===Product Detail Page===

When the product details options are activated, they will show on products that have not already ordered that service. In this example the client does not have spam filtering or weebly, so they are shown a sidebar promo for Weebly and a main panel promo relating to SpamExperts Email Security.

[[File:Client-product-details-upsell.png|750px]]

The learn more link takes you to the product specific landing page. The highlighted button takes you into a store page where you can setup the details of your order and progress to checking out.

===Product List Page===

When the product list page is enabled, we add a banner to the sidebar that allows you to promote additional services to your customers. In this example the customer has a hosting account but no site builder, so we show an advertisement.

[[File:Product-list-page-promo.png|750px]]

The banner takes you to our product specific landing page.

===View Cart Page===

When the view cart promotion is enabled, we add a banner underneath the existing items in the cart if there is a product in the cart but not this type of product. In this example the customer is shown a promotion for adding a SSL certificate to their hosting order.

[[File:Cart-ssl-upsell.png|750px]]

Clicking the button will add the product to the cart with the price and taxes in the summary section.

===Checkout Page===

When the checkout page promotion is enabled, if a customer proceeds to checkout without adding an additional service we offer them the chance to add it before completing the order. In this example you can see a promotion for all 3 MarketConnect services.

[[File:Cart-checkout-all-upsells.png|500px]]

==Upsells==

WHMCS can show users recommended products that they may upgrade to after making an initial choice. This provides a simple and convenient way for customers to see alternative options that are available and might be better suited to them. We refer to these as upsells. Upsells are shown when a customer adds MarketConnect service to the cart. Version 7.2.0 includes two upsell opportunities: in the store landing page and in the product configuration page.

===Store Landing Page===

The SpamExperts landing page allows you to select which type of service and shows discounts if you bundle multiple different services.

===Product Configuration Page===

Each of the MarketConnect products are configured in a custom product configuration page. This page will also display an upsell opportunity if the customer does not have a top of the line product selected. In this example, the customer has selected a RapidSSL certificate, they are offered the chance to upgrade to a wildcard SSL certificate.

[[File:Ssl-upsell-store-order.png|750px]]

SSL Monitoring

2021-01-12T21:37:06Z

Joshua:

SSL Monitoring makes it easy to see which domains have SSL and which do not.

It also makes it easy to spot issues with validation sooner, and know ahead of time when SSL Certificates are approaching their expiry dates. It's the perfect way to keep on top of your own SSL certificates, and be in a position to help your customers with their renewals.

For both client end users and admin users, SSL status is displayed in real-time when viewing a product/service within WHMCS, while the System Cron updates the SSL Status in batches of 100 every 24 hours. The status is indicated by an icon. An explanation of the different icons you might see is available below. Hovering over the icon will provide any additional information that is available via a tooltip.

==Where is the Status Shown?==

===Admin Area===
[[File:admin_area_display.png|thumb|SSL Status Admin Area]]
In the admin area, the icon displaying the status of SSL on the domain can be found on the service and domain details page, in the top right of the display next to the [[Products_Management#Moving_a_Product.2FService_to_another_Client|move]] button.

There is also a new SSL Status report which can be used to monitor and review the status of SSL across all the domains within your WHMCS installation. This new report can be accessed by navigating to ''Reports > General > SSL Status Monitoring'' within the WHMCS admin area.

===Client Area===
[[File:client_area_list_display.png|thumb|SSL Status Client Area List]]
The client area displays the status on the client service and domains lists, and on the service and domain details pages. On the lists, a new column has been added to the table with the list containing the status, with the status retrieved by and ajax call and updated.
[[File:client_area_display.png|thumb|SSL Status Client Area]]
On the products details page, the status can be see on the 'domain' tab.
The domain details page lists the ssl status as part of the standard domain information.
In the client area, the details pages will contain information about the SSL Certificate installed for the domain. This includes the issuer and expiry date of the issued SSL in cases where it can be reliably retrieved.

==What are the Icons?==

There are four icons that display the SSL information.
[[File:Ssl-active-green.png]] - A green padlock indicates that the selected domain has an active and valid SSL Certificate.

[[File:ssl-inactive-domain.png]] - A grey padlock with a negative sign is displayed for domains that are not considered active. These are services and domains that are in a Terminated, Expired or Cancelled status.

[[File:ssl-inactive-red.png]] - A red padlock indicates that the selected domain does not have an active or valid SSL Certificate.

[[File:ssl-unknown.png]] - A grey padlock with a question mark indicates that the state of SSL for a domain cannot be verified with any certainty.

==Troubleshooting==
===Technical Details===
# Upon loading the page, a cURL call is made from the WHMCS server to https://$example.com with the ssl_verify_peer option enabled
#* Where $example.com is the contents of the service's Domain field
# If no response is received, the "?" padlock icon is displayed
# If a cURL error is received, then the red padlock icon is displayed
#* This indicates cURL was unable to [https://curl.haxx.se/docs/sslcerts.html validate the certificate]
# If no cURL error is received, the test was successful and the yellow padlock icon is displayed
# Unsupported cURL versions will be flagged in the [[System Health Status]] page

===Testing===
* Connect to the command-line of your WHMCS server and run:
curl -v https://$example.com
** Replace $example.com with the value from the Domain field in WHMCS.
* Look for an error code at the end of the output. An example is shown below:
<source>
[root@john ~]# curl -v https://v75.test.whmcs.rocks
* About to connect() to v75.test.whmcs.rocks port 443 (#0)
* Trying 104.20.20.8... connected
* Connected to v75.test.whmcs.rocks (104.20.20.8) port 443 (#0)
* Initializing NSS with certpath: sql:/etc/pki/nssdb
* CAfile: /etc/pki/tls/certs/ca-bundle.crt
CApath: none
* SSL: certificate subject name '*.whmcs.com' does not match target host name 'v75.test.whmcs.rocks'
* NSS error -12276
* Closing connection #0
curl: (51) SSL: certificate subject name '*.whmcs.com' does not match target host name 'v75.test.whmcs.rocks'
</source>
* In this example a '''51''' error code is returned
* Please work with your server admin/hosting provider to resolve the cURL connection error between the WHMCS server and the hosting server.