Difference between revisions of "IWHMCS iPhone App"
m (→Setup Instructions) |
m |
||
| (20 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <div class="docs-alert-warning"> | |
| + | <span class="title">Acceptable Password Characters</span><br /> | ||
| + | You cannot use the following characters in an administrator password: | ||
| + | & " ' < > | ||
| + | (ampersand, double quotes, single quotes, less than or greater than). | ||
| + | You can use other symbols without restrictions. | ||
| + | </div> | ||
| + | For more information, see [https://www.whmcs.com/mobile-apps/ the iWHMCS website]. | ||
==Setup Instructions== | ==Setup Instructions== | ||
| − | 1. To begin with (if you haven't already done so), you will need to order the iPhone addon from our client area. It's available as an addon to a license and can be ordered by logging into our client area | + | 1. To begin with (if you haven't already done so), you will need to order the iPhone addon from our client area. It's available as an addon to a license and can be ordered by logging into our client area at [http://www.whmcs.com/members/clientarea.php 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 | + | 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 clicking '''Force License Update''' at '''Help > [[License Information]]''' inside your WHMCS installation to have it take effect. |
| − | 3. Now, you're ready to download the iWHMCS app from the Apple iTunes App Store which you can do by | + | 3. Now, you're ready to download the iWHMCS app from the Apple iTunes App Store which you can do by [http://itunes.apple.com/gb/app/iwhmcs/id343647658?mt=8 finding iWHMCS in iTunes]. |
| − | 4. Once downloaded, | + | 4. Once downloaded, sync your phone to install the app. |
5. Now locate and open the app on your iphone's home screen | 5. Now locate and open the app on your iphone's home screen | ||
| Line 15: | Line 22: | ||
6. The first time you start it, you'll be asked to enter your authentication details. These consist of your WHMCS URL, admin username & password and an access key. | 6. The first time you start it, you'll be asked to enter your authentication details. These consist of your WHMCS URL, admin username & password and an access key. | ||
| − | 7. The WHMCS URL should be the URL to the frontend (client area), for example "http://demo.whmcs.com/" or "http://www. | + | 7. The WHMCS URL should be the URL to the frontend (client area), for example "http://demo.whmcs.com/" or "http://www.example.com/whmcs/" and the admin username & password the same as you use to login to the main admin area. |
| − | 8. | + | 8. For the access key, 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"> | <source lang="php"> | ||
| Line 28: | Line 35: | ||
10. If all was correct, you'll be taken straight to the homepage overview. | 10. If all was correct, you'll be taken straight to the homepage overview. | ||
| + | |||
| + | ===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: | ||
| + | [[File:android_pin.png|thumb|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. | ||
==Common Problems== | ==Common Problems== | ||
| − | |||
===Invalid IP=== | ===Invalid IP=== | ||
This error means the API Access Key has not been added successfully to the configuration.php file. Please refer to step 8 above. The $api_access_key line should go before the closing ?> tag. | This error means the API Access Key has not been added successfully to the configuration.php file. Please refer to step 8 above. The $api_access_key line should go before the closing ?> tag. | ||
| + | |||
| + | ===No Server Response/Invalid URL=== | ||
| + | Seeing either the "No Server Response" or "Invalid URL" error suggests an empty or malformed response was received by the server. This is often caused by a blank space in user modifiable files. Please refer to [[Blank_Pages#Blank_Pages_Elsewhere]] for steps to resolve this error. | ||
| + | |||
| + | ===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 '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Administrator Roles]]''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Administrator Roles'''. | ||
| + | * Edit the staff member's role. | ||
| + | * Check the ''API Access'' checkbox. | ||
| + | * Click '''Save Changes'''. | ||
| + | |||
| + | ===iWHMCS features other than the home screen require the iWHMCS addon to be purchased=== | ||
| + | In order to view pages other than the app home screen it is necessary to purchase the iWHMCS 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. | ||
| + | |||
| + | 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 iWHMCS addon is listed. If you're unsure which licence 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 > [[License 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. | ||
Latest revision as of 15:02, 19 May 2023
Acceptable Password Characters
You cannot use the following characters in an administrator password:
& " ' < >
(ampersand, double quotes, single quotes, less than or greater than). You can use other symbols without restrictions.
For more information, see the iWHMCS website.
Contents
Setup Instructions
1. To begin with (if you haven't already done so), you will need to order the iPhone addon from our client area. It's available as an addon to a license and can be ordered by logging into our client area at 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 clicking Force License Update at Help > License Information inside your WHMCS installation to have it take effect.
3. Now, you're ready to download the iWHMCS app from the Apple iTunes App Store which you can do by finding iWHMCS in iTunes.
4. Once downloaded, sync your phone to install the app.
5. Now locate and open the app on your iphone's home screen
6. The first time you start it, you'll be asked to enter your authentication details. These consist of your WHMCS URL, admin username & password and an access key.
7. The WHMCS URL should be the URL to the frontend (client area), for example "http://demo.whmcs.com/" or "http://www.example.com/whmcs/" and the admin username & password the same as you use to login to the main admin area.
8. For the access key, 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 created by you, and that same value is what you'll need to enter into the Access Key field of the iWHMCS configuration screen.
9. 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.
10. If all was correct, you'll be taken straight to the homepage overview.
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:
- 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.
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 8 above. The $api_access_key line should go before the closing ?> tag.
No Server Response/Invalid URL
Seeing either the "No Server Response" or "Invalid URL" error suggests an empty or malformed response was received by the server. This is often caused by a blank space in user modifiable files. Please refer to Blank_Pages#Blank_Pages_Elsewhere for steps to resolve this error.
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 Configuration () > System Settings > Administrator Roles or, prior to WHMCS 8.0, Setup > Staff Management > Administrator Roles.
- Edit the staff member's role.
- Check the API Access checkbox.
- Click Save Changes.
iWHMCS features other than the home screen require the iWHMCS addon to be purchased
In order to view pages other than the app home screen it is necessary to purchase the iWHMCS 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 iWHMCS addon is listed. If you're unsure which licence 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 > License 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.