AWHMCS Android App

From WHMCS Documentation

Acceptable Password Characters
Don't use the following characters in an administrator password: & " ' < > (ampersand, double quotes, single quotes, less than or greater than). Any other symbols (for example, # ! £ $ % ^ * ( ) . , /) are perfectly acceptable.

aWHMCS is the Official Android App for WHMCS. For the iOS App, see IWHMCS iPhone App.

The app is available for either $2.99 monthly or $29.99 per year. After you purchase a license, all of your staff can use aWHMCS in conjunction with your WHMCS installation on any of their Android devices (the same licensing scheme as with all our mobile editions).

For more information, see the aWHMCS website.

Setup Instructions

To set up the app:

  1. If you haven't already done so, order the Android App addon from our client area. It's available as an addon to a license and you can order it by logging into our client area and selecting "'View Available Addons'" from the navigation bar. When you pay, we will instantly activate the addon.
  2. Perform a local key update by going to Help > License Information inside your WHMCS installation and clicking on the Force License Update button.
  3. Download the aWHMCS App. You can download this from the Google Play Store by searching for "aWHMCS".
  4. Find and open the app on your Android device. The first time that you open the app, you will see a configuration screen to fill out your WHMCS connection details.
    • For the URL, use the URL to your WHMCS directory without a trailing slash. For example, if you installed WHMCS at http://demo.whmcs.com/ then the URL setting would be http://demo.whmcs.com/ and the admin username and password would be the same as your login for the main admin area. Remember that your Admin account role needs to have API Access permission.
    • For the access key, open the configuration.php file for your WHMCS installation and add a line to it like the one below:
      $api_access_key = "abc123";
      Replace abc123 with a random series of letters and numbers. You will also need to enter that value in the Access Key field on your phone.
  5. Click Save and the system will test the connection. If you entered any of the details incorrectly, you'll receive an Access Denied (username and password failure) or Invalid Access Key error message. Otherwise, the home page will appear and you will be able to start using the app.

Security PIN

The app offers a security Personal Identification Number (PIN) feature. When you configure a PIN, you will need to enter it when starting or returning to the aWHMCS app. If your device is lost, stolen, or friends or family use it, they won't be able to access your business data.

Edit Security PIN

To configure the PIN:

  1. From the Home screen, tap the options icon.
  2. Tap Settings.
  3. Tap PIN code.
  4. Follow the onscreen instructions to choose your four-digit PIN and confirm it.

To change or remove the security PIN:

  1. From the Home screen, tap the options icon.
  2. Tap Settings.
  3. Tap PIN code.
  4. Enter your current PIN.
  5. Enter the new PIN and press OK to confirm, or tap Clear to remove the PIN protection.

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

An Invalid IP error indicates that you didn't add the API Access Key to the configuration.php file successfully. For help with this, see the instructions above. The $api_access_key line should go before the closing ?> tag.

Access Denied

iWHMCS uses the API to communicate with your WHMCS installation. The Administrator Roles of staff using the app will require the "API Access" permission.

To grant this permission:

  1. Navigate to Configuration () > Admin Users or, prior to WHMCS 8.0, Setup > Staff Management > Administrator Roles.
  2. Edit the role to which your staff member belongs.
  3. Check the API Access checkbox.
  4. Click Save Changes.

404 URL Not Found

A Not Found error indicates that the system can't find the /includes/api.php file from the URL that you entered into the app's connection settings.

Make sure that the URL to your WHMCS client area is correct. It should be the same as 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, you must purchase the aWHMCS addon for your main WHMCS license. If you haven't done so already, log in to our client area and select View Available Addons from the navigation bar.

If you have already purchased the addon, make sure you associated it with the correct license key. In our client area, navigate to Services > Licences & Services, click "View Details" next to your main WHMCS license key, select the Addons tab, and check whether the list includes the aWHMCS addon. If you're unsure which license key you're using, navigate to Help > Licence Information inside your WHMCS installation's admin area.

To ensure the purchase takes immediate effect, 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 license file.