Difference between revisions of "Apps and Integrations"

From WHMCS Documentation

m (→‎How Do I Use This?)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
This feature allows you to browse available modules and integrations, including all apps and integrations shipped with WHMCS by default as well as selected apps and integrations from the WHMCS Marketplace.
+
WHMCS includes a large number of apps and integrations that we ship with WHMCS by default, and you can find more apps and integrations from the WHMCS Marketplace. The '''Apps & Integrations''' feature allows you to access these from within the Admin Area.
−
 
+
−
==Where Do I Find This?==
+
You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or, prior to WHMCS 8.0, '''Setup > Apps & Integrations'''.
−
 
+
−
Apps and Integrations can be found by navigating to Setup > Apps & Integrations. It can also be accessed by clicking the "Addons" tab, and via Addons > Apps & Integrations. Once there there will be four tabs that you can utilise:  
+
==Finding Apps and Integrations==
−
 
+
−
* Featured
+
When you look for an application, you can use one of the tabs at the top of the page:
−
* Browse
+
−
* Active
+
* The '''Featured''' tab displays popular and recommended applications.
−
* Search
+
* The '''Browse''' tab displays all of the available apps and integrations. You can use the category list in the left-side menu to sort applications by category.
−
[[File:Apps-integrations.JPG|thumb|Apps & Integrations Home]]
+
* The '''Active''' tab displays active applications that you already use.
−
The Featured tab will display a selection of recommended applications, including the most popular and feature rich. The Browse tab allows you browse the full selection of apps and integrations available to you by navigating through each category list on the left. Any modules listed under the Active tab are ones that are already active and therefore in use on your installation. Finally, the Search tab can be used to search for a specific module.
+
* The '''Search''' tab allows you to search for a specific application by name.
−
 
+
−
==How Do I Use This?==
+
Clicking on an application displays the following information:
−
 
+
−
To use this feature, once you are within the Apps & Integrations section of the admin user interface, you will want to select on the module you wish to utilise. This will open up a modal which will present you with a "Manage" option if the module is already active on your installation, an "Active" option if the module is shipped with the WHMCS software by default but is not yet active, or a "Get it from the WHMCS Marketplace" option if the module first needs to be downloaded. In cases where it's a provisioning module, there will be two options, one being "Create New Server" and the other "Create New Product".  
+
[[File:App-integrations-cpanel-detail.JPG|thumb|Apps & Integrations Module Detail]]
−
 
+
* The application name and a brief description.
−
In cases where you are activating or managing a module that is already present within WHMCS, upon selection of "Activate" or "Manage" you will redirected to the configuration page within WHMCS where that module resides. For example, selecting "Manage" on the PayPal module from within the Apps & Integrations page will redirect you to Payment Gateways page, displaying PayPal's current configuration and settings in the Manage Existing Gateways tab. The helps you active and configure modules, expediting the process of navigating through each section of WHMCS to locate them.
+
* The module category (for example, '''Payments''' or '''Domains''').
−
 
+
* Links to relevant documentation for the module.
−
Where the module needs to be downloaded from the WHMCS Marketplace, you will be redirected to the Marketplace, displaying the specific module that relates to the module you selected.
+
* The developer of the module.
−
 
+
* The version of the module.
−
==What Information Is Shown?==
+
−
 
+
== Working with an Application ==
−
When viewing a module within the Apps & Integrations feature, the following information is displayed (where that information is available):
+
−
 
+
When you click on an application, you will see an option depending on the application's status:
−
* The name and a brief description of the module
+
−
* The category of module you are viewing (VPS/Cloud, Payments, Domains etc)
+
=== Activate ===
−
* Links to relevant documentation for the module
+
−
* The developer of the module
+
'''Activate''' only appears if you do not already use the application and it is ready to activate. Clicking this will redirect you to the applicable configuration page for that application or module.
−
* The version of the module
+
−
* The logo of the module
+
For example, clicking '''Activate''' for the '''Stripe''' payment gateway will redirect you to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payment Gateways'''.
 +
 +
=== Manage ===
 +
 +
'''Manage''' displays if you have already activated the application. Clicking this will redirect you to the applicable configuration page for that application or module.
 +
 +
For example, clicking '''Activate''' for the '''Stripe''' payment gateway will redirect you to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payment Gateways'''.
 +
 +
<div class="docs-alert-info">
 +
If the application is a provisioning module, it will instead display '''[[Servers|Create New Server]]''' and the other '''[[Products_and_Services|Create New Product]]'''.
 +
</div>
 +
 +
=== Get it from the WHMCS Marketplace ===
 +
 +
'''Get it from the WHMCS Marketplace''' displays if you have not activated the application and would need to download it before activating it. Clicking this will redirect you to the applicable module's page in the WHMCS Marketplace.
 +
 +
To enable an application, find it using the available tabs and categories, click on it, and then click '''Activate'''.

Latest revision as of 16:08, 25 January 2024

WHMCS includes a large number of apps and integrations that we ship with WHMCS by default, and you can find more apps and integrations from the WHMCS Marketplace. The Apps & Integrations feature allows you to access these from within the Admin Area.

You can access this feature at Configuration () > Apps & Integrations or, prior to WHMCS 8.0, Setup > Apps & Integrations.

Finding Apps and Integrations

When you look for an application, you can use one of the tabs at the top of the page:

  • The Featured tab displays popular and recommended applications.
  • The Browse tab displays all of the available apps and integrations. You can use the category list in the left-side menu to sort applications by category.
  • The Active tab displays active applications that you already use.
  • The Search tab allows you to search for a specific application by name.

Clicking on an application displays the following information:

Apps & Integrations Module Detail
  • The application name and a brief description.
  • The module category (for example, Payments or Domains).
  • Links to relevant documentation for the module.
  • The developer of the module.
  • The version of the module.

Working with an Application

When you click on an application, you will see an option depending on the application's status:

Activate

Activate only appears if you do not already use the application and it is ready to activate. Clicking this will redirect you to the applicable configuration page for that application or module.

For example, clicking Activate for the Stripe payment gateway will redirect you to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payment Gateways.

Manage

Manage displays if you have already activated the application. Clicking this will redirect you to the applicable configuration page for that application or module.

For example, clicking Activate for the Stripe payment gateway will redirect you to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payment Gateways.

If the application is a provisioning module, it will instead display Create New Server and the other Create New Product.

Get it from the WHMCS Marketplace

Get it from the WHMCS Marketplace displays if you have not activated the application and would need to download it before activating it. Clicking this will redirect you to the applicable module's page in the WHMCS Marketplace.

To enable an application, find it using the available tabs and categories, click on it, and then click Activate.

Retrieved from "http://3.17.75.209/index.php?title=Apps_and_Integrations&oldid=34356"