Skip to content

WHMCS Configuration

This integration works with HSPs, Resellers, and Marketplaces.

Blackwall provides an integration plugin for the WHMCS billing system.

Install the plugin

We recommend managing Blackwall via GateKeeper directly or one of Blackwall's integration modules, not both. Running them concurrently can cause configuration conflicts and complicate troubleshooting. Pick one interface and use it consistently for all changes. This matters especially in hosted environments, where service providers don't have access to customer integration module instances.

To install the Blackwall plugin on the WHMCS server:

  1. Download the archive with the extension: 

    curl -O https://repo.botguard.net/modules/botguard-whmcs-latest.tar.gz
    or 
    wget https://repo.botguard.net/modules/botguard-whmcs-latest.tar.gz

  2. Extract the contents of the archive to the path where WHMCS is installed, like: 

    tar -zxf botguard-whmcs-latest.tar.gz -C /var/www/html/whmcs/

  3. Set the required permissions for the extracted folder: 

    chown apache:apache -R /var/www/html/whmcs/modules/servers/botguard

Note

WHMCS directory path and username may differ in various Linux distributions.

Configure the plugin

Before configuring the pluging, ensure that you have understood the following terminology overview:

  • Server = the GateKeeper API endpoint.
  • Server Group = the WHMCS group that points products to a GateKeeper instance.
  • Product Group = the storefront/order-form category that contains customer-facing products.
  • Product = the item customers order in WHMCS.


To configure the plugin, perform each of the following sub-steps:

  1. Add your Blackwall server.
  2. Create a WHMCS Server Group and add your Blackwall server to it.
  3. Create a WHMCS Product Group.
  4. Create a WHMCS Product.
  5. Assign the Server Group to the product.

Each product can use a different Server Group, allowing you to connect different products to different GateKeeper instances.

Add the Blackwall server

  1. Log in to your WHMCS account using your login credentials.

  2. Once your account homepage loads, from the top-right corner of the WHMCS admin panel, click wrench icon. System Settings

  3. From the options displayed, select System Settings.

  4. In the search field on the System Settings page, enter 'server'. Servers Search

  5. Click the Servers widget.

  6. Click Add New Server.
    Add server

  7. On the basic server form displayed, click Go to Advanced Mode. Advanced mode

  8. From the Module dropdown, select Blackwall. Irrelevant fields are hidden automatically, making configuration easier. Server config

  9. Populate the remaining fields:

    Field Value Example
    Name A descriptive name for this server Blackwall EU
    Hostname GateKeeper API hostname (without https://) **-**-**.test.blackwall.com
    Port GateKeeper API port (pre-filled with 8443) 8443
    Secure Must be checked for HTTPS ☑️
    API Key Your GateKeeper API key (UUID) ********-****-****-****-************

  10. Click Test Connection to verify that the credentials entered are correct. If the information entered in the previous steps is correct, a success message displays.

  11. Click Save Changes once you have seen the success message.

Create a WHMCS Server Group

  1. Repeat steps 1-5 of the previous section.

  2. Click Create New Group.
    Add new group.

  3. Enter a meaningful name for your new group in the Name field.
    Add new group

  4. Select your new Blackwall server from the left list panel and click Add to move it to the right list panel. This effectively adds the server to your new group. You can remove a server again by clicking it in the right-hand list panel and clicking Remove, which effectively removes the server from your new group. For this plugin, only one server (GateKeeper instance) should be associated with any server group.
  5. Click Save Changes.

Create a WHMCS Product Group

Before creating a product, create a WHMCS Product Group to organise the product in the WHMCS order form.

    1. Log in to your WHMCS account using your login credentials.
  2. Once your account homepage loads, from the top-right corner of the WHMCS admin panel, click wrench icon.
  3. From the dropdown menu displayed, click System Settings.
  4. From the widgets displayed, click Products/Services.
  5. When the Products/Services page displays, click + Create a New Group.

  6. Populate the Create Group page fields as follows:

    1. In Product Group Name, enter a meaningful name for the group. For example: Blackwall

    2. In the URL field, enter the friendly URL slug for the product group. For example: blackwall

    3. Optionally, in the Product Group Headline, enter a heading that your customers see on the order form.

    4. Optionally, in the Product Group Tagline, enter a short description for the product group.
    5. Select the required Order Form Template.
    6. Select the payment gateways that customers can use for products in this group.
    7. Select the Hidden checkbox if you do not want this product group to appear on the public WHMCS order form. This is useful while you are configuring or testing the products in the group. Hidden product groups are not displayed to customers in the order form, but administrators can still manage them in WHMCS.
    8. Click Save Changes.

Create a WHMCS Product

You can create a new product by performing the following steps, or skip this section if you want to use an existing product.

  1. Log in to your WHMCS account as an administrator, using your login credentials.
  2. Open the menu item Addons » Apps & Integration. whmcs17.png
  3. Start typing Blackwall in the search box.
  4. Once autocomplete finds the Blackwall add-on module, click the Blackwall widget.
  5. On the page displayed, click the Create New Product button. whmcs18.png
  6. On the Create a New Product page that displays, populate the following fields:
    1. Select the Product Type that best matches how you want WHMCS to manage your new product. For the Blackwall plugin, Shared Hosting is typically used, unless your internal setup requires another type. whmcs19.png
    2. In Product Group, select the group that should contain the product. In this example, we previously created the Product Group Blackwall.
    3. In Product Name, enter the customer-facing name of the product. This is the name that appears in WHMCS order forms, invoices, and client-area product lists.
    4. Review the automatically generated URL, which is based on the selected product group and product name. Use this friendly URL to link to this product.
    5. In Module, select the required provisioning module. If the product does not need automated provisioning during setup, leave this as No Module.
    6. Toggle the Create as Hidden switch to ON if you do not want customers to see the product in the public order form yet. This is recommended while you are configuring or testing the product.
    7. Click Continue.

Assign the Server Group to the product

  1. Log in to your WHMCS account using your login credentials.
  2. From the left sidebar, click Products/Services. Edit new group
  3. Locate the product or service that you want to edit. If you do not wish to use an existing product, refer to Create a new product (optional).
  4. Click the edit icon for the product or service that you want to configure.
  5. On the page that displays, click the Module Settings tab. Edit new group
  6. From the Server Group dropdown menu, select the new server group that you created.
  7. Click Save Changes.
  8. Choose the components that you want to use in this product:
    1. After saving changes in the previous step, various component options display on the Module Settings page. whmcs20.png
    2. Select the checkboxes for the components that you want to include in your new product.
    3. Click Save Changes.

Each product can use a different Server Group. This allows you to connect different products to different GateKeeper instances, which in turn provides flexibility.

Feedback