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

From WHMCS Documentation
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
To use the WHMCS Mobile app with your WHMCS installation, you need to establish a connection profile using the steps below:
+
{{MobileApp}}
  
−
# Open the mobile WHMCS application
+
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].
−
# 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 profile details as follows:
+
== Connecting to WHMCS ==
−
#* ''WHMCS Installation URL'': should be the URL to the client area of your WHMCS installation - also the same as the ''System URL'' found in '''Setup > General Settings > General''' within the admin area.
+
 
−
#* '''Admin Username''': Enter the username you use to login to the web based admin panel
+
To use the WHMCS Mobile app with your WHMCS installation, you must establish a connection profile.
−
#* '''Admin Password''': Enter the password you use to login to the web based admin panel
+
 
−
#* '''API Access Key''': Enter your '''API Access Key''' or if this is the first time using an API Access key, create one using the steps below:
+
To do this:
−
#** '''Creating an API Access Key for the first time'''
+
 
−
#** Open the ''configuration.php'' file found in your WHMCS installation directory using a text editor
+
# Open the WHMCS Mobile application
−
#** Add the following line to the end of the file:<div class="source-cli">$api_access_key = "YOUR_API_ACCESS_KEY";</div>
+
# 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 (+).
−
#** Replace YOUR_API_ACCESS_KEY with the key you'd like to use.
+
# Enter the required profile details.
−
#** A tool such as https://passwordsgenerator.net/ can be used to generate a random key
+
#* 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'''.
−
#** Save changes to the ''configuration.php'' file and upload to your server
+
#* For '''Admin Username''', enter the username you use to log in to the web-based admin panel.
−
#** Now enter the API Key you created in the field where requested
+
#* For '''Admin Password''', enter the password you use to log in to the web-based admin panel.
−
#* Finally, click the '''Validate Credentials''' button to test the connection
+
#* 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.
 
Upon success, the connection profile will be created and saved and you will be redirected to the app dashboard.
  
−
[[File:Profile_creation.png|left|thumb|Profile Creation Screen]]
+
[[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"