Mobile App: Connecting to WHMCS

From WHMCS Documentation

Revision as of 19:17, 26 April 2022 by SarahK (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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