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

From WHMCS Documentation

m
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:
+
To use the WHMCS Mobile app with your WHMCS installation, you need to establish a connection profile using the steps below:
  
−
# Open the ''configuration.php'' file found 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 the key you'd like to use.
 
−
#* A tool such as https://passwordsgenerator.net/ can be used to generate a random key
 
−
# Save changes to the ''configuration.php'' file and upload to your server
 
 
# Open the mobile WHMCS application
 
# Open the mobile WHMCS application
−
# Upon the first login, you will be asked to enter your authentication details:
+
# 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 (+).
−
#* The ''WHMCS Installation URL'' should be set to the ''System URL'' found on your admin area '''Setup > General Settings > General tab'''
+
# Enter the profile details as follows:
−
#* Enter your admin username and password
+
#* ''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.
−
#* Enter the '''API Access Key''' created above
+
#* '''Admin Username''': Enter the username you use to login to the web based admin panel
−
#* Finally, click the '''Save''' button
+
#* '''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:
 +
#** '''Creating an API Access Key for the first time'''
 +
#** Open the ''configuration.php'' file found 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 the key you'd like to use.
 +
#** A tool such as https://passwordsgenerator.net/ can be used to generate a random key
 +
#** Save changes to the ''configuration.php'' file and upload to your server
 +
#** Now enter the API Key you created in the field where requested
 +
#* Finally, click the '''Validate Credentials''' button to test the connection
  
−
If everything was done correctly, you will be taken to the mobile app home screen and can begin using the app.
+
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|left|thumb|Profile Creation Screen]]

Revision as of 11:47, 3 June 2020

To use the WHMCS Mobile app with your WHMCS installation, you need to establish a connection profile using the steps below:

  1. Open the mobile WHMCS 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 profile details as follows:
    • 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
    • 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:
      • Creating an API Access Key for the first time
      • Open the configuration.php file found in your WHMCS installation directory using a text editor
      • Add the following line to the end of the file:
        $api_access_key = "YOUR_API_ACCESS_KEY";
      • 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
      • Save changes to the configuration.php file and upload to your server
      • Now enter the API Key you created in the field where requested
    • Finally, 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.

Profile Creation Screen
Retrieved from "http://3.17.75.209/index.php?title=Mobile_App:_Connecting_to_WHMCS&oldid=28556"