Difference between revisions of "Mobile App: Troubleshooting"
From WHMCS Documentation
(→Viewing and Managing Clients) |
|||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{MobileApp}} | {{MobileApp}} | ||
==Connection and Access== | ==Connection and Access== | ||
| + | |||
===You must configure an API Access Key to use WHMCS Mobile=== | ===You must configure an API Access Key to use WHMCS Mobile=== | ||
| + | |||
This error indicates that you didn't add the API Access Key to the configuration.php file successfully. Please ensure you've added the API Access Key to your configuration.php file and then enter that value in the Access Key field into the WHMCS Mobile app. | This error indicates that you didn't add the API Access Key to the configuration.php file successfully. Please ensure you've added the API Access Key to your configuration.php file and then enter that value in the Access Key field into the WHMCS Mobile app. | ||
| − | + | For step-by-step instructions, see [[Mobile App: Connecting to WHMCS]]. | |
===Invalid special character in Access Key=== | ===Invalid special character in Access Key=== | ||
| − | + | ||
| + | This indicates that your access key includes one or more unsupported characters. The mobile app '''only''' supports numbers, letters, and the following special characters: | ||
<div class="source-cli">
! @ # $ % . ( ) * [ ] - _
</div> | <div class="source-cli">
! @ # $ % . ( ) * [ ] - _
</div> | ||
| − | + | To resolve this issue: | |
| + | |||
| + | #Open the configuration.php file found in your WHMCS installation directory using a text editor. | ||
| + | #Look for the $api_access_key variable. | ||
| + | #Remove or replace any unsupported characters. | ||
| + | #Save changes to the ''configuration.php'' file and upload to your server | ||
| + | #Return to the WHMCS Mobile App and re-enter the updated API Access Key value | ||
| + | #Click the '''Validate Credentials''' button to test the connection | ||
| + | |||
| + | Upon success, the connection profile will be created and saved and you will be redirected to the app dashboard. | ||
===Access Denied=== | ===Access Denied=== | ||
| + | |||
Our mobile app uses the API to communicate with your WHMCS installation. The Administrator Roles of staff using the app will require the "API Access" permission. | Our mobile app 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: | To grant this permission: | ||
| − | # | + | # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[Administrator Roles|Manage Admins]]''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Administrator Roles'''. |
| − | #Edit the role | + | # Edit the desired role. |
| − | # | + | # Check '''API Access'''. |
| − | #Click ''Save Changes'' | + | # Click '''Save Changes'''. |
===Unable to connect. Please check the installation and device are online and try again=== | ===Unable to connect. Please check the installation and device are online and try again=== | ||
| − | |||
| − | The WHMCS URL should be the URL to the frontend (client area) | + | Please ensure that you are entering the URL as "https://whmcs.example.com/" or "https://example.com/whmcs/ with the trailing slash at the end. |
| + | |||
| + | The WHMCS URL should be the URL to the frontend (client area) in '''System URL''' in the '''[[General Tab|General]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. | ||
===Authentication Failed=== | ===Authentication Failed=== | ||
| + | |||
Authentication Failed indicates that the admin user name or password supplied in the profile are being rejected. Type your username and password again to make sure that they are correct. | Authentication Failed indicates that the admin user name or password supplied in the profile are being rejected. Type your username and password again to make sure that they are correct. | ||
==Viewing and Managing Clients== | ==Viewing and Managing Clients== | ||
| + | |||
===Error generating JSON encoded response=== | ===Error generating JSON encoded response=== | ||
| − | This error has two typical causes; an invalid (non-utf-8) character in the client's profile/service data, or the WHMCS installation is using a non-utf-8 character set. The following sections show how to identify | + | |
| + | This error has two typical causes; an invalid (non-utf-8) character in the client's profile/service data, or the WHMCS installation is using a non-utf-8 character set. The following sections show how to identify the cause and the corresponding solutions: | ||
====Invalid Character in Profile/Service Data==== | ====Invalid Character in Profile/Service Data==== | ||
| + | |||
If the "Error generating JSON encoded response" error is encountered only when accessing certain clients: | If the "Error generating JSON encoded response" error is encountered only when accessing certain clients: | ||
| − | #Navigate to '''Clients > View/Search Clients''' | + | |
| − | #Select the client in question | + | #Navigate to '''Clients > View/Search Clients'''. |
| − | #Click on their '''Profile | + | #Select the client in question. |
| − | #Examine all the fields and ensure all the fields contain valid letters, numbers and symbols | + | #Click on their '''[[Clients:Profile Tab|Profile]]''' tab. |
| − | #Next click on the '''Products/Services | + | #Examine all the fields and ensure all the fields contain valid letters, numbers and symbols. |
| − | #Examine each of the client's service records and ensure all the fields contain valid letters, numbers and symbols | + | #Next click on the '''[[Clients:Products/Services Tab|Products/Services]]''' tab. |
| + | #Examine each of the client's service records and ensure all the fields contain valid letters, numbers and symbols. | ||
[[File:corrupt_password.png|thumb|Service Password with Invalid Characters]] | [[File:corrupt_password.png|thumb|Service Password with Invalid Characters]] | ||
| − | The most common cause of this error is a non-decryptable service password | + | The most common cause of this error is a non-decryptable service password. |
<br/> <br/> | <br/> <br/> | ||
To resolve: | To resolve: | ||
| − | #Re-enter the service password (or clear out the field if a password is no longer required) | + | |
| − | #Click | + | # Re-enter the service password (or clear out the field if a password is no longer required). |
| − | #Repeat the process for any other clients experiencing the same error to ensure they all contain a valid service password. | + | # Click '''Save Changes'''. |
| + | # Repeat the process for any other clients experiencing the same error to ensure they all contain a valid service password. | ||
| + | |||
The client's details should now load successfully in the WHMCS Mobile App. | The client's details should now load successfully in the WHMCS Mobile App. | ||
====Non UTF-8 Character Set==== | ====Non UTF-8 Character Set==== | ||
| + | |||
If the "Error generating JSON encoded response" error is encountered immediately upon accessing the Clients tab in the Mobile App or when accessing all clients: | If the "Error generating JSON encoded response" error is encountered immediately upon accessing the Clients tab in the Mobile App or when accessing all clients: | ||
| − | # | + | |
| − | # | + | # Go to the '''[[Localisation Tab|Localisation]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. |
| − | #Click ''Save Changes'' | + | # Make certain that '''System Charset''' is '''utf-8'''. Change the value if necessary. |
| − | # | + | # Click '''Save Changes'''. |
| − | + | # Ensure that the following line is present in the WHMCS <tt>configuration.php</tt> file:<div class="source-cli">$mysql_charset = 'utf8';</div>If it is not present, add the line and save the file. | |
| + | |||
The client's details should now load successfully in the WHMCS Mobile App. | The client's details should now load successfully in the WHMCS Mobile App. | ||
{{MobileApp}} | {{MobileApp}} | ||
Latest revision as of 20:20, 11 May 2022
Connection and Access
You must configure an API Access Key to use WHMCS Mobile
This error indicates that you didn't add the API Access Key to the configuration.php file successfully. Please ensure you've added the API Access Key to your configuration.php file and then enter that value in the Access Key field into the WHMCS Mobile app.
For step-by-step instructions, see Mobile App: Connecting to WHMCS.
Invalid special character in Access Key
This indicates that your access key includes one or more unsupported characters. The mobile app only supports numbers, letters, and the following special characters:
! @ # $ % . ( ) * [ ] - _
To resolve this issue:
- Open the configuration.php file found in your WHMCS installation directory using a text editor.
- Look for the $api_access_key variable.
- Remove or replace any unsupported characters.
- Save changes to the configuration.php file and upload to your server
- Return to the WHMCS Mobile App and re-enter the updated API Access Key value
- Click the Validate Credentials button to test the connection
Upon success, the connection profile will be created and saved and you will be redirected to the app dashboard.
Access Denied
Our mobile app 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:
- Go to Configuration () > Manage Admins or, prior to WHMCS 8.0, Setup > Staff Management > Administrator Roles.
- Edit the desired role.
- Check API Access.
- Click Save Changes.
Unable to connect. Please check the installation and device are online and try again
Please ensure that you are entering the URL as "https://whmcs.example.com/" or "https://example.com/whmcs/ with the trailing slash at the end.
The WHMCS URL should be the URL to the frontend (client area) in System URL in the General tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.
Authentication Failed
Authentication Failed indicates that the admin user name or password supplied in the profile are being rejected. Type your username and password again to make sure that they are correct.
Viewing and Managing Clients
Error generating JSON encoded response
This error has two typical causes; an invalid (non-utf-8) character in the client's profile/service data, or the WHMCS installation is using a non-utf-8 character set. The following sections show how to identify the cause and the corresponding solutions:
Invalid Character in Profile/Service Data
If the "Error generating JSON encoded response" error is encountered only when accessing certain clients:
- Navigate to Clients > View/Search Clients.
- Select the client in question.
- Click on their Profile tab.
- Examine all the fields and ensure all the fields contain valid letters, numbers and symbols.
- Next click on the Products/Services tab.
- Examine each of the client's service records and ensure all the fields contain valid letters, numbers and symbols.
The most common cause of this error is a non-decryptable service password.
To resolve:
- Re-enter the service password (or clear out the field if a password is no longer required).
- Click Save Changes.
- Repeat the process for any other clients experiencing the same error to ensure they all contain a valid service password.
The client's details should now load successfully in the WHMCS Mobile App.
Non UTF-8 Character Set
If the "Error generating JSON encoded response" error is encountered immediately upon accessing the Clients tab in the Mobile App or when accessing all clients:
- Go to the Localisation tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.
- Make certain that System Charset is utf-8. Change the value if necessary.
- Click Save Changes.
- Ensure that the following line is present in the WHMCS configuration.php file:$mysql_charset = 'utf8';If it is not present, add the line and save the file.
The client's details should now load successfully in the WHMCS Mobile App.