How To Set Up HOSTAFRICA's VPS WHMCS Reseller Module


[2021/01/19] Version 1.7.5 Changelog:

  • WHMCS 8.1 cart theme update

[2020/09/30] Version 1.7.3 Changelog:

  • Backup quota validation

[2020/08/25] Version 1.7.1 Changelog:

  • Text Changes

[2020/08/25] Version 1.7.0 Changelog:

  • Fixed Change Package functionality

[2020/06/11] Version 1.6.9 Changelog:

  • Fixed Module Change

[2020/06/11] Version 1.6.8 Changelog:

  • Fixed Module Change

[2020/05/26] Version 1.6.7 Changelog:

  • Fixed admin panel vm info
  • Fixed version numbering

[2020/04/17] Version 1.6.6 Changelog:

  • Fixed custom orderform template issues.

[2020/02/02] Version 1.6.5 Changelog:

  • Fixed hooks errors.

[2020/01/10] Version 1.6.4 Changelog:

  • Extended suspend/unsuspend functionality.

[2019/11/19] Version 1.6.3 Changelog:

  • Fix for wrong redirection after backup create.

[2019/08/29] Version 1.6.2 Changelog:

  • Stability tweaks

[2019/07/08] Version 1.6 Changelog:

  • Stability tweaks
  • Added additional locations

[2019/06/10] Version 1.5.1 Changelog:

  • Stability tweaks
  • Compatibility tweaks for older PHP versions

[2019/04/06] Version 1.5 Changelog:

  • Added JWT encryption/decryption
  • Stability tweaks
  • Special template for reseller products (Refer to updated point 16 in this guide to learn how to change the template for product group)

[2019/04/06] Version 1.4 Changelog:

  • Added Backup management
  • Added Usage Statistics
  • Stability tweaks

[2019/03/06] Version 1.2 Changelog:

  • Upgrade functionality has been added
  • Upgrade configurable options has been added
  • Console access from client area has been added
  • Minor Bug Fixes
  • Clients now can generate API credentials themselves

API documentation here

How To Set Up HOSTAFRICA's VPS WHMCS Reseller Module

1.   Download our reseller module version 1.7.5 : Download

2. You will need to extract downloaded file, using software like “7zip”, “winrar”, “unzip”, in which you will find folder shown in the screenshot below.

3. The folder needs to be uploaded to your root WHMCS folder, where the “modules” directory is located.

4. Log in to your WHMCS admin control panel.

5.  Go to Setup > Addon Modules.

6. Find the “HostAfrica API Module”. Click Activate and after Module is active press the Configure button.

7.  Check the “Full Administrator” checkbox and click “Save Changes”.

8. Login into your client area and navigate to Edit Account Details.

9.  In Account Details page click on API Management located at the left side of the screen in My Account sidebar.

10. In API Management page

  • Enter IP address of the server where your WHMCS is located.
  • Press Generate on both buttons
  • Copy Your API Key and API Secret (do not share these keys with anyone else)
  • Press Submit Button.

11. In your WHMCS admin control panel go to Addons -> HostAfrica API Module.

12.     Click on the “Add Credentials” button.

13.     In the following form, enter the required credentials and press the “Submit” button.

  • Email address – Enter the email address that you use for your client profile in our WHMCS.
  • API Key – Enter the API key we have provided you.
  • API Secret – Enter the API Secret we have provided you.
  • Host – URL of WHMCS where your account located. (

14.  In your WHMCS admin control panel go to Setup > Products/Services > Products/Services.

15. Create a new product group by the clicking button at the top of the page.

16.  Configure product group. You can name it anything you want. 
In Order Form Template select HA VPS Reseller Cart.

17. Create New product from Products/Services. Press Continue.

  • Product Type – Dedicated/VPS Server.
  • Product Group – Group you have previously created.
  • Product Name – This is your product name.

18.  Go to Module Settings and chose module “Host Africa”, then save changes.

19. After saving, product dropdown will load into the page. Choose the product you want to setup. Press “Save Changes”.

20.  Select Product plan you want to resell and press “Save Changes” once more.

21. Go to Custom Field tab and enter fields data and Save Changes.

  • For Windows Cloud Server (Reseller), Cloud Server (Reseller),  Virtuozzo Container (Reseller) configure custom fields like this:
    • Field Name – OS|OS Template
    • Field Type – Drop Down
    • Select Options – Available OS template list:


Cloud Server Templates Centos8,Centos7,Centos6,Debian_10,Debian_9,Ubuntu_20.04,Ubuntu_18.04,Ubuntu_16.04

Windows Cloud Server Templates Windows_2019,Windows_2016,Windows_2012_R2

Virtuozzo Server Templates                                                                         centos-8-x86_64,centos-7-x86_64,centos-6-x86_64,ubuntu-20.04-x86_64,ubuntu-18.04-x86_64,ubuntu-16.04-x86_64,debian-10.0-x86_64,debian-9.0-x86_64,debian-8.0-x86_64,suse-42.3-x86_64

    • Required Field – Should be checked
    • Show on Order Form – Should be checked


  • For Additional location servers configure custom fields like this:
    • Field Name – osTemplate|OS Template
    • Field Type – Drop Down
    • Select Options – Available OS template list
Cloud Server - US-Chicago                                                                                                                                                                                                                                   IfzOamnMhQ|CentOS 7,ugv8X0Cggy|CentOS 6,ywjfvlx5AZ|Debian 9,sU7XcmnKBh|Debian 8,aJDchkopl3|Ubuntu LTS 18.04,PBTTMBCUGl|Ubuntu LTS 16.04,oWftelfq9M|Fedora 29,PQ0oxFuIa4|Fedora 28
Windows Cloud Server - US-Chicago V26T7sESBo|Windows Server 2019 Standard,XOc9YiS8Rz|Windows Server 2016 Standard
Cloud Server - US-LosAngeles d37qU3J47C|CentOS 7,Hh0OtjHvES|CentOS 6,QnJj6VfTIw|Debian 9,BnQMb0ptmw|Debian 8,2Rvb40aMub|Ubuntu LTS 18.04,UYH5u4p3YF|Ubuntu LTS 16.04,L2s6ZcbaUh|Fedora 28,CntB7TQPif|Fedora 27
Windows Cloud Server - US-LosAngeles l3Am5Bneb6|Windows Server 2019 Standard,sj3xYWAfUY|Windows Server 2016 Standard
Cloud Server - BR-SaoPaulo EZl4wkhXBF|CentOS 7,wATtc6V30M|CentOS 6,VBePhqol2Z|Debian 9,wpgnlnIgLK|Debian 8,kxd7FEc9zt|Ubuntu LTS 18.04,uueJP2Q6NN|Ubuntu LTS 16.04,6F2ciu0yva|Fedora 29,7QbMlCBNEW|Fedora 28,TlYaTxvR81|Fedora 27,7Q8HKPWg5g|Fedora 26
Windows Cloud Server - BR-SaoPaulo rb7SKhIJbz|Windows Server 2019 Standard,9w99zC0Td2|Windows Server 2016 Standard
Cloud Server - DE-Frankfurt 5x8YPs37SP|CentOS 7,56mdUhCTXl|CentOS 6,nYmSZX2AoR|Debian 9,Nn6xljcKEe|Ubuntu LTS 18.04,9QQTdZ5itZ|Ubuntu LTS 16.04 x64,ZWv5xhqDH4|Ubuntu LTS 16.04,STCmsr3ove|Ubuntu LTS 14.04,psx5x9q1zn|Fedora 29,SzfZSihzkY|Fedora 28,volL1VQM1a|Fedora 27,aSKo1vuUPL|Fedora 26,rnbLXNXgEi|Debian 8
Windows Cloud Server - DE-Frankfurt P4TCx1NyMJ|Windows Server 2019 Standard,Qeb0Rao9CN|Windows Server 2016 Standard
Cloud Server - UK-London O124730ZlV|CentOS 7,NTq7qVufgc|CentOS 6,ELgwDwybLq|Debian 9,YlfQRnszCt|Debian 8,onyAYsjBBr|Ubuntu LTS 18.04,yvlcKBVE7J|Ubuntu LTS 16.04,AQwlpFFi06|Fedora 29,KrgaxTZTml|Fedora 28
Windows Cloud Server - UK-London vH5L31z8FQ|Windows Server 2019 Standard,7grE6ZrBUm|Windows Server 2016 Standard


22. Go to Setup > Products/Services > Configurable Options.

23.  Click “Create a New Group”.

24. Fill Out New Configurable Options Group Details and press “Save Changes”.

  • Group name – Name can be anything
  • Description – Not required
  • Assigned Products – Select products you just created

25. For Windows Cloud Server (Reseller), Cloud Server (Reseller),  Virtuozzo Container (Reseller): Press “Add New Configurable Option” and fill out the form and press “Save Changes”.

26. For Windows Cloud Server (Reseller), Cloud Server (Reseller),  Virtuozzo Container (Reseller): Repeat step 22 with following configurable options.

27. For Additional location servers: Press “Add New Configurable Option” and fill out the form and press “Save Changes”.

28. For Additional location servers: Repeat step 22 with following configurable options.

The setup is now complete.

  • 3 Users Found This Useful
Was this answer helpful?

Related Articles

VPS Reseller API

[2019/04/06] Version 1.5 Changelog: Added JWT encryption/decryption Stability tweaks Special...

VPS Reseller Implementation

Please see all the information on our new WHMCS implementation below: Provisioning In order to...