Page tree
Skip to end of metadata
Go to start of metadata

This section is designed to show you how to connect your OnApp VSP Account to the WHMCS User module. This page also shows you how a user orders a product, logs into OnApp and sees their usage.

 

On this page:

 

 

OnApp Users module for WHMCS


 

To begin with, you need to ensure you download the correct module. The OnApp Users module for WHMCS allows you to create, suspend and activate users directly from WHMCS. Clients then log directly into OnApp to build and manage their VSs with WHMCS handling billing.

You can download the WHMCS OnApp Users module from GitHub.

For information on the WHMCS OnApp Users module, refer to the OnApp WHMCS Users Module Guide.


Installation


 

For information on installing the OnApp Users module for WHMCS, refer to the installation instructions.

 

Configuring the Integration


Before you can create a product, you need to add an OnApp server to WHMCS.

You can also place your servers into a particular server group. This step is optional. For more information, refer to Creating a Server Group.

Add a Server


 

 

Get Adobe Flash player

To add a server:

  1. Go to Setup > Products/Services > Servers
  2. Click Add Server.
  3. Give a name to your server.
  4. Add your VSP UI IP.
  5. Proceed to Server Details.

  6. Choose Onappusers as the Type.
  7. Add your Username and Password to your OnApp VSP UI.
  8. Click Save Changes.
  9. Look for the notice 'Server Added Successfully!'

When you create a product based on the OnApp users module, you connect WHMCS to the OnApp server, and specify the properties and settings of the user which will be created in OnApp once the product has been ordered and activated. Each product must be assigned to a group which can either be visible or hidden from the order page (products may also be hidden individually). 

Now proceed to creating a group.

 

Create a Group


 

 

Get Adobe Flash player

To create a group:

  1. Go to Setup > Product/Services > Product/Services in your WHMCS Control Panel.
  2. Click the Create a New Group link.
  3. Fill in the form that appears.
  4. Click Create Group button.

Next you will need to create a new product and assign it to the already created product group.

 

Create a Product


 

 

Get Adobe Flash player

To create a product:

  1. Go to Setup > Product/Services > Product/Services in your WHMCS Control Panel.
  2. Click the Create a New Product link and fill in the form that appears.
  3. Choose the type of product. We recommend to use Other type.

    The Reseller Account product type is not applicable for OnApp module.

  4. Go to Module Settings.
  5. Add the module called Onappusers.
  6. Add a Server Group. You can select when a product is set up, there are 4 options:
    • Automatically setup the product as soon as an order is placed
    • Automatically setup the product as soon as the first payment is received
    • Automatically setup the product when you manually accept a pending order
    • Do not automatically setup this product

    After you select an option, the system will require some time to save your setting.


  7. Add a Billing plan.
  8. Set a Role.
  9. Feel free to set Time Zones/Locales.

 


 

Get Adobe Flash player

After you create a product, you can retrieve links you can use for your sales webpage:

  1. Once you have created a product, click Back to Product List. You will see a list of products you’ve created.
  2. Click the Edit icon.
  3. Click the Links tab, here you will see links you can use for your sales webpage.

 

How an End User Signs Up via WHMCS


Get Adobe Flash player

From the Shopping Cart page, your user selects the Product and starts the Order Now process:

  • They click Order Now which takes them to the Choose a Domain section.
  • Once they have entered a domain they are taken to a Review & Checkout page.
  • Here they can go to the Checkout, Apply a Promo Code or Empty Cart.
  • Next they will be asked to add payment details.
  • Once Complete Order is clicked they will be shown their Order Confirmation.

Next they can elect to Continue To Client Area where they will see an overview of their purchases.

 

How the End User Logs into OnApp


Get Adobe Flash player

From the Customer Portal within WHMCS the user can directly access OnApp:

  • The user starts by clicking Services.
  • The user then selects the relevant Product/Service.
  • Next they scroll down to the Open Control Panel button. OnApp will open in their window.
  • Next they will see the UI for the first time, this offers a Quick Tutorial.

Now your User can begin provisioning Virtual Servers through the Build Wizard.

 

How Usage is Reported in WHMCS


 

Get Adobe Flash player

From the Customer Portal within WHMCS the user can see their Usage:

  • The User starts by clicking Services.
  • The User then needs to select the relevant Product/Service.
  • Next they scroll down to the Outstanding Details section.
  • Users can select a date range, click Apply and their spend will appear.
  • No labels