Mobile App: Connecting to WHMCS - Revision history

SarahK at 19:17, 26 April 2022

2022-04-26T19:17:30Z

John at 09:12, 24 June 2020

2020-06-24T09:12:02Z

John at 09:11, 24 June 2020

2020-06-24T09:11:21Z

John at 09:11, 24 June 2020

2020-06-24T09:11:05Z

John at 09:08, 24 June 2020

2020-06-24T09:08:51Z

John at 09:07, 24 June 2020

2020-06-24T09:07:33Z

John at 11:00, 5 June 2020

2020-06-05T11:00:47Z

John at 09:40, 5 June 2020

2020-06-05T09:40:45Z

Matt at 11:48, 3 June 2020

2020-06-03T11:48:45Z

Matt at 11:47, 3 June 2020

2020-06-03T11:47:26Z

@@ Line 1: / Line 1: @@
 {{MobileApp}}
-This article refers to the WHMCS Mobile app available for download 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].
+== Connecting to WHMCS ==
-To use the WHMCS Mobile app with your WHMCS installation, you need to establish a connection profile using the steps below:
+To use the WHMCS Mobile app with your WHMCS installation, you must establish a connection profile.
 # 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 (+).
+# 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:
+# Enter the required profile details.
-#* ''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.
+#* 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'''.
-#* '''Admin Username''': Enter the username you use to login to the web based admin panel
+#* For '''Admin Username''', enter the username you use to log in to the web-based admin panel.
-#* '''Admin Password''': Enter the password you use to login to the web based admin panel
+#* For '''Admin Password''', enter the password you use to log in 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:
+#* 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:
-#** '''Creating an API Access Key for the first time'''
+#*# Open the <tt>configuration.php</tt> file in your WHMCS installation directory using a text editor.
-#** 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 a randomised series of letters and numbers. You can use the following special characters:<div class="source-cli">! @ # $ % . ( ) * [ ] - _</div>
-#** Add the following line to the end of the file:<div class="source-cli">$api_access_key = "YOUR_API_ACCESS_KEY";</div>
+#** Save the file and upload it to your server.
-#** Replace YOUR_API_ACCESS_KEY with a randomised series of letters and numbers.
+#* 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.

@@ Line 24: / Line 24: @@
 Upon success, the connection profile will be created and saved and you will be redirected to the app dashboard.
-[[File:Profile_creation.png|thumb|Profile Creation Screen]]
+[[File:Profile_creation.png|none|thumb|Profile Creation Screen]]
 {{MobileApp}}

@@ Line 24: / Line 24: @@
 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|thumb|Profile Creation Screen]]
 {{MobileApp}}

← Older revision		Revision as of 09:11, 24 June 2020
Line 25:		Line 25:

	[[File:Profile_creation.png\|left\|thumb\|Profile Creation Screen]]		[[File:Profile_creation.png\|left\|thumb\|Profile Creation Screen]]
		+
		+
		+	{{MobileApp}}

← Older revision		Revision as of 09:08, 24 June 2020
Line 1:		Line 1:
	{{MobileApp}}		{{MobileApp}}
		+
		+
	This article refers to the WHMCS Mobile app available for download 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].		This article refers to the WHMCS Mobile app available for download 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].

← Older revision		Revision as of 09:07, 24 June 2020
Line 1:		Line 1:
		+	{{MobileApp}}
	This article refers to the WHMCS Mobile app available for download 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].		This article refers to the WHMCS Mobile app available for download 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].

@@ Line 13: / Line 13: @@
 #** 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.
+#** Replace YOUR_API_ACCESS_KEY with a randomised series of letters and numbers
 #** Save changes to the ''configuration.php'' file and upload to your server
 #** Now enter the API Key you created in the field where requested

← Older revision		Revision as of 11:48, 3 June 2020
Line 1:		Line 1:
		+	This article refers to the WHMCS Mobile app available for download 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].
		+
	To use the WHMCS Mobile app with your WHMCS installation, you need to establish a connection profile using the steps below:		To use the WHMCS Mobile app with your WHMCS installation, you need to establish a connection profile using the steps below: