Difference between revisions of "AWHMCS Android App"

Latest revision as of 15:01, 19 May 2023

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:

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 in to our Client Area and selecting View Available Addons from the navigation bar. When you pay, we will instantly activate the addon.
Perform a local key update by going to Help > License Information inside your WHMCS installation and clicking Force License Update.
Download the aWHMCS App. You can download this from the Google Play Store by searching for "aWHMCS".
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.
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:

From the Home screen, tap the options icon.
Tap Settings.
Tap PIN code.
Follow the onscreen instructions to choose your four-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 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.

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:

Navigate to Configuration () > Admin Users or, prior to WHMCS 8.0, Setup > Staff Management > Administrator Roles.
Edit the role to which your staff member belongs.
Check the API Access checkbox.
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 your account in WHMCS's members area, navigate to Services > Licences & Services.
Click View Details next to your main WHMCS license key.
Select the Addons tab.
Check whether the list includes the aWHMCS addon.

If you're unsure which license key you're using, navigate to Help > License 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.

@@ Line 1: / Line 1: @@
 <div class="docs-alert-warning">
 <span class="title">Acceptable Password Characters</span><br />
-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.
+Don't use the following characters in an administrator password: <tt>& " ' < ></tt> (ampersand, double quotes, single quotes, less than or greater than). Any other symbols (for example, <tt># ! £ $ % ^ * ( ) . , /</tt>) are perfectly acceptable.
 </div>
-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).
+aWHMCS is the Official Android App for WHMCS. For the iOS App, see [[IWHMCS iPhone App]].
-Please visit www.awhmcs.com for more information.
+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 [https://www.whmcs.com/mobile-apps/ aWHMCS website].
 ==Setup Instructions==
-. 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 @ [http://www.whmcs.com/members/clientarea.php www.whmcs.com/members/clientarea.php] and selecting "View Available Addons" from the navigation bar.
+To set up the app:
-. 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.
+# 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 in to our [http://www.whmcs.com/members/clientarea.php Client Area] and selecting '''View Available Addons''' from the navigation bar. When you pay, we will instantly activate the addon.
+# Perform a local key update by going to '''Help > [[License Information]]''' inside your WHMCS installation and clicking '''Force License Update'''.
+# Download the aWHMCS App. You can download this from the Google Play Store [https://play.google.com/store/apps/details?id=com.whmcs.awhmcs2 by searching for "aWHMCS"].
+# 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 <tt><nowiki>http://demo.whmcs.com/</nowiki></tt> then the URL setting would be <tt><nowiki>http://demo.whmcs.com</nowiki></tt> 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 <tt>configuration.php</tt> file for your WHMCS installation and add a line to it like the one below:<div class="source-cli">$api_access_key = "abc123";</div>Replace <tt>abc123</tt> with a random series of letters and numbers. You will also need to enter that value in the Access Key field on your phone.
+# 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.
-. 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
+===Security PIN===
-. Now locate and open the app on your Android device
+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.
-. 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.
+[[File:android_pin.png|thumb|Edit Security PIN]]
-. 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.
-. 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:
-<source lang="php">
-$api_access_key = "abc123";
-</source>
-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
-. 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.
-. If all was correct, you'll be taken to the home screen and can begin using the app.
-===Security PIN===
+To configure the 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:
-[[File:android_pin.png|thumb|Edit Security PIN]]
-*From the Home screen, tap the options icon,
+#From the '''Home''' screen, tap the '''options''' icon.
-*Tap Settings
+#Tap '''Settings'''.
-*Tap PIN code
+#Tap '''PIN code'''.
-*Follow on on screen instructions to choose your 4 digit PIN and confirm it.
+#Follow the onscreen instructions to choose your four-digit PIN and confirm it.
 To change or remove the security PIN:
-*From the Home screen, tap the options icon,
+#From the '''Home''' screen, tap the options icon.
-*Tap Settings
+#Tap '''Settings'''.
-*Tap PIN code
+#Tap '''PIN code'''.
-*Enter your current PIN
+#Enter your current PIN.
-*Enter the new PIN and press OK to confirm, or tap Clear and the PIN protection will be removed.
+#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.
+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.
@@ Line 63: / Line 50: @@
 ==Common Problems==
-The common error responses from the API can be found at [[API:Responses]]
 ===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.
+An ''Invalid IP'' error indicates that you didn't add the API Access Key to the <tt>configuration.php</tt> file successfully. For help with this, see the instructions above. The <tt>$api_access_key</tt> line should go before the closing <tt>?></tt> 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:
+iWHMCS uses the API to communicate with your WHMCS installation. The Administrator Roles of staff using the app will require the "API Access" permission.
-* Navigate to '''Setup > Staff Management > Administrator Roles'''
-* Edit the role to which your staff member belongs
+To grant this permission:
-* Tick the ''API Access'' checkbox
+#Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[Administrator Users|Admin Users]]''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Administrator Roles'''.
-* Click ''Save Changes''
+#Edit the role to which your staff member belongs.
+#Check 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.
+A ''Not Found'' error indicates that the system can't find the <tt>/includes/api.php</tt> file from the URL that you entered into the app's connection settings.
-Ensure that the URL to your WHMCS client area is entered correctly "http://www.yourdomain.com/whmcs/".<br/>
+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 <tt>api.php</tt> file.
-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.
+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 [http://www.whmcs.com/members client area] and selecting '''View Available Addons''' from the navigation bar.
+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 [http://www.whmcs.com/members 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 your account in WHMCS's members area, navigate to '''Services > Licences & Services'''.
+# Click '''View Details''' next to your main WHMCS license key.
+# Select the '''Addons''' tab.
+# Check whether the list includes the aWHMCS addon.
-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.
+If you're unsure which license key you're using, navigate to '''Help > [[License 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.
+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.

Documentation