AWHMCS Android App

From WHMCS Documentation

Acceptable Password Characters
The following characters should not be used in an administrator password & " ' < > (ampersand, double quotes, single quotes, less than or greater than). Any other symbols such as # ! £ $ % ^ * ( ) . , / etc… are perfectly acceptable.

aWHMCS is the Official Android App for WHMCS.

Available for either $2.99 monthly or $29.99 per year, once a license is purchased it allows all your staff to use aWHMCS in conjunction with your WHMCS installation on any of their Android devices (the same licensing scheme as with all our mobile editions).

Please visit www.awhmcs.com for more information.

Setup Instructions

1. To begin with (if you haven't already done so), you will need to order the Android App addon from our client area. It's available as an addon to a license and can be ordered by logging into our client area @ www.whmcs.com/members/clientarea.php and selecting "View Available Addons" from the navigation bar.

2. Once you've ordered and paid, the addon will be instantly activated and you'll just need to perform a local key update by going to Help > License Information inside your WHMCS installation and then clicking on the Force License Update button to have it take effect.

3. Now, you're ready to download the aWHMCS App - you can download this from the Google Play Store by searching for "aWHMCS" - https://play.google.com/store/apps/details?id=com.whmcs.awhmcs2

4. Now locate and open the app on your Android device

5. The first time you start the app, you'll be taken straight to the configuration screen for you to input your WHMCS connection details. These consist of your WHMCS URL, admin username & password and an access key.

6. The URL should be the URL to your WHMCS directory without a trailing slash. For example if installed @ "http://demo.whmcs.com/" then the URL setting would be "http://demo.whmcs.com" and the admin username & password the same as you use to login to the main admin area.

If installed @ "http://www.yourdomain.com/whmcs/" then the URL setting would be "http://www.yourdomain.com/whmcs" and the admin username & password the same as you use to login to the main admin area.

Please note that your Admin account role needs to have API Access permission.

7. The access key is slightly more complicated. For this, you need to open up the configuration.php file for your WHMCS installation and add a line to it such as the one below:

$api_access_key = "abc123";

The abc123 in the above should be replaced with a random series of letters and numbers, you can think of it like a second password, and that same value is what you'll need to enter into the Access Key field on your phone

8. Then simply click Save and the connection will be tested. If any of the details were entered incorrectly you'll receive an Access Denied (username/password failure) or Invalid Access Key error message and be returned to re-enter the details.

9. If all was correct, you'll be taken to the home screen and can begin using the app.

Security PIN

The app offers a security Personal Identification Number (PIN) feature. When a PIN has been configured you will be prompted to enter it when starting or returning to the aWHMCS app, so that even if your device is lost, stolen or being used by friends/family, they cannot access your business data. To configure the PIN:

Edit Security PIN
  • From the Home screen, tap the options icon,
  • Tap Settings
  • Tap PIN code
  • Follow on on screen instructions to choose your 4 digit PIN and confirm it.

To change or remove the security PIN:

  • From the Home screen, tap the options icon,
  • Tap Settings
  • Tap PIN code
  • Enter your current PIN
  • Enter the new PIN and press OK to confirm, or tap Clear and the PIN protection will be removed.

Using the App

Don't forget to press the menu button on your handset to access extra options, almost every screen has this ability. If your handset does not have an options button, an icon consisting of three dots will appear in the top corner instead.

Android ss2.png

Common Problems

Invalid IP

This error means the API Access Key has not been added successfully to the configuration.php file. Please refer to step 7 above. The $api_access_key line should go before the closing ?> tag.

Access Denied

iWHMCS uses the API to communicate with your WHMCS installation. Therefore the Administrator Roles of staff using the app will require the "API Access" permission. To grant this permission:

  • Navigate to Setup > Staff Management > Administrator Roles
  • Edit the role to which your staff member belongs
  • Tick the API Access checkbox
  • Click Save Changes

404 URL Not Found

A Not Found error indicates that the /includes/api.php file cannot be found from the URL entered into the app's connection settings.

Ensure that the URL to your WHMCS client area is entered correctly "http://www.yourdomain.com/whmcs/".
Where http://www.yourdomain.com/whmcs/ is the URL of your WHMCS Client Area. WHMCS will then navigate up the folder tree from this URL to find the api.php file.

A common mistake is to enter the Administration Area URL. The app requires the Client Area URL instead.

aWHMCS features other than the home screen require the aWHMCS addon to be purchased

In order to view pages other than the app home screen it is necessary to purchase the aWHMCS addon for your main WHMCS licence. If you haven't done so already, this can be ordered by logging into our client area and selecting View Available Addons from the navigation bar.

If the addon has already been purchased, please ensure it is associated with the correct licence key. In our client area, navigate to Services > Licences & Services, click "View Details" next to your main WHMCS licence key, select the Addons tab, and ensure the aWHMCS addon is listed. If you're unsure which licence key you're using, navigate to Help > Licence Information inside your WHMCS installation's admin area.

Finally, remote licence checks are performed occasionally, so to have the purchase take immediate effect please force a remote licence check. To do this visit Help > Licence Information and click Force Licence Update. The action of loading the page will initiate a connection to our licensing server and update your local licence file.