Difference between revisions of "Mobile App: Connecting to WHMCS"

From WHMCS Documentation

(Created page with "To use the mobile app with your WHMCS installation, you'll need to establish a connection to it by following these steps: # Open the ''configuration.php'' file found in your...")
 
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
To use the mobile app with your WHMCS installation, you'll need to establish a connection to it by following these steps:
+
{{MobileApp}}
  
−
# Open the ''configuration.php'' file found in your WHMCS installation directory in a text editor
+
You can download the WHMCS Mobile app from the [https://apps.apple.com/us/app/whmcs/id1516241118?ls=1 App Store] and [https://play.google.com/store/apps/details?id=app.whmcs.mobile.android Google Play].
−
# Add the following line to the end of the file:<div class="source-cli">$api_access_key = "YOUR_API_ACCESS_KEY";</div>
 
−
# Replace YOUR_API_ACCESS_KEY with the key you'd like to use.
 
−
#* A tool such as https://passwordsgenerator.net/ can be used to generate a random key[[File:Profile_creation.png|thumb|Profile Creation Screen]]
 
−
# Save changes to the ''configuration.php'' file and upload to your server
 
−
# Open the mobile WHMCS application
 
−
# Upon the first login, you will be asked to enter your authentication details:
 
−
#* The ''WHMCS Installation URL'' should be set to the ''System URL'' found on your admin area '''Setup > General Settings > General tab'''
 
−
#* Enter your admin username and password
 
−
#* Enter the '''API Access Key''' created above
 
−
#* Finally, click the '''Save''' button
 
  
−
If everything was done correctly, you will be taken to the mobile app home screen and can begin using the app.
+
== Connecting to WHMCS ==
 +
 
 +
To use the WHMCS Mobile app with your WHMCS installation, you must establish a connection profile.
 +
 
 +
To do this:
 +
 
 +
# Open the WHMCS Mobile application
 +
# Upon the first launch, you will be automatically asked to create a new connection profile. Alternatively, navigate to '''Settings > Manage/Switch Profiles''' and click the New icon (+).
 +
# Enter the required profile details.
 +
#* For '''WHMCS Installation URL''', enter the URL for the Client Area of your WHMCS installation. You can find this as '''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 > General'''.
 +
#* For '''Admin Username''', enter the username you use to log in to the web-based admin panel.
 +
#* For '''Admin Password''', enter the password you use to log in to the web-based admin panel.
 +
#* For '''API Access Key''', enter your '''API Access Key'''. If this is the first time using an API Access key, create one using the steps below and then enter it:
 +
#*# Open the <tt>configuration.php</tt> file in your WHMCS installation directory using a text editor.
 +
#*# Add the following line to the end of the file:<div class="source-cli">$api_access_key = "YOUR_API_ACCESS_KEY";</div>Replace YOUR_API_ACCESS_KEY with a randomised series of letters and numbers. You can use the following special characters:<div class="source-cli">! @ # $ % . ( ) * [ ] - _</div>
 +
#** Save the file and upload it to your server.
 +
#* Click '''Validate Credentials''' to test the connection.
 +
 
 +
Upon success, the connection profile will be created and saved and you will be redirected to the app dashboard.
 +
 
 +
[[File:Profile_creation.png|none|thumb|Profile Creation Screen]]
 +
 
 +
 
 +
{{MobileApp}}

Latest revision as of 19:17, 26 April 2022

You can download the WHMCS Mobile app from the App Store and Google Play.

Connecting to WHMCS

To use the WHMCS Mobile app with your WHMCS installation, you must establish a connection profile.

To do this:

  1. Open the WHMCS Mobile application
  2. Upon the first launch, you will be automatically asked to create a new connection profile. Alternatively, navigate to Settings > Manage/Switch Profiles and click the New icon (+).
  3. Enter the required profile details.
    • For WHMCS Installation URL, enter the URL for the Client Area of your WHMCS installation. You can find this as System URL in the General tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings > General.
    • For Admin Username, enter the username you use to log in to the web-based admin panel.
    • For Admin Password, enter the password you use to log in to the web-based admin panel.
    • For API Access Key, enter your API Access Key. If this is the first time using an API Access key, create one using the steps below and then enter it:
      1. Open the configuration.php file in your WHMCS installation directory using a text editor.
      2. Add the following line to the end of the file:
        $api_access_key = "YOUR_API_ACCESS_KEY";
        Replace YOUR_API_ACCESS_KEY with a randomised series of letters and numbers. You can use the following special characters:
        ! @ # $ % . ( ) * [ ] - _
      • Save the file and upload it to your server.
    • Click Validate Credentials to test the connection.

Upon success, the connection profile will be created and saved and you will be redirected to the app dashboard.

Profile Creation Screen


Retrieved from "http://3.17.75.209/index.php?title=Mobile_App:_Connecting_to_WHMCS&oldid=32419"