G Suite For WHMCS
About G Suite For WHMCS
|G Suite For WHMCS will enable all G Suite Authorized Resellers to provision and manage Google accounts in their very own WHMCS system.|
Authenticate through OAuth 2.0, create flexible products and let your clients order ready Google services directly from your website.
- Admin Area Features:
|✔ Create/Suspend/Unsuspend/Terminate Account|
|✔ Change Package|
|✔ Choose Plan Name|
|✔ Choose Renewal Type|
|✔ Choose Action On Termination|
|✔ Log API Requests|
|✔ Automatically Create Administrator Account|
|✔ Set Administrator Mailbox Name|
|✔ Set Configurable Options Per Product:|
|✔ Product SKU ID|
|✔ Number of Seats|
- Client Area Features:
|✔ View Customer Info|
|✔ Log In To Control Panel|
|✔ Log In To Webmail|
- Available Google Services:
|✔ G Suite Basic|
|✔ G Suite Business|
|✔ G Suite Enterprise|
|✔ Google Vault|
|✔ Google Drive Storage|
- General Info:
|✔ Requires G Suite Partner Program / Reseller Account|
|✔ Authentication And API Calls Utilize OAuth 2.0|
|✔ Multi-Language Support|
|✔ Supports PHP 5.6 Up To PHP 7|
|✔ Supports WHMCS Template Six|
|✔ Supports WHMCS V7|
Installation and Authentication
|This tutorial will show you how to successfully install and authenticate G Suite For WHMCS.|
We will guide you step by step through the whole installation and authentication process.
|1. Log in to our client area and download the module.|
|2. Extract the downloaded file into the main WHMCS directory.|
The content of the package should look like this.
|3. When you install G Suite For WHMCS for the first time you have to rename 'license_RENAME.php' file.|
File is located in 'modules/servers/googleapps/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.
|4. In order to configure your license key you have to edit a previously renamed 'license.php' file.|
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.
|5. Now you have to authenticate the module through setting up API Access.|
Create API Access in Google Console. You can do it here → https://code.google.com/apis/console/
|6. After you have logged in, create a new project.|
|7. You have just entered Google API Manager. Firstly, go to 'OAuth consent screen' under 'Credentials' section.|
Afterwards, enter email address and product name, they will be visible during your requests.
|8. To proceed, go to 'Google APIs' under 'Overview' tab.|
Find 'Google Apps Reseller API' among all applications.
|9. You have to enable 'Google Apps Reseller API' as shown on the following screen.|
|10. Now, switch to 'Credentials' tab and add new credentials .|
|11. Afterwards, tick 'Web application'. |
|12. Well done, now when you have all the necessary details you can proceed to authenticate Google Apps.|
|13. Now go back to your WHMCS system and create a new product for your GoogleApps.|
Move to 'Setup' → 'Products/Services' → 'Products/Services' and add a new product.
|14. Choose product type and product group from dropdown menus and enter your new product's name. 'Continue'.|
|15. Go to 'Module Settings' of your product and choose 'Googleapps' from a 'Module Name' dropdown menu.|
|16. Enter your previously obtained 'Client ID', 'Client Secret' and make sure that 'Callback URL' is correct.|
Then press 'Grant access with Google account'.
|17. If your entered data are correct, you will be redirected to the page with permission request. Press 'Allow access' button.|
|18. And that is all. You will be redirected back to your WHMCS and you will see a following screen.|
Move to 'Custom Fields' now.
|19. Move to 'Custom Fields' now. Fields called 'GoogleApps Domain' , 'GoogleApps PurchaseOrderID' , 'GoogleApps Alternate Email' and 'Mailbox Name' are added automatically.|
Configuration and Management
|Configuration and management of G Suite For WHMCS is very intuitive. Read the below sections to see how easy it is.|
|Let's begin the process of module configuration by choosing Default Product SKU ID. In other words, pick one of available Google services.|
As you can see on the following screen, our module supports G Suite Basic, G Suite Business and G Suite Enterprise, as well as Google Drive Storage and Google Vault.
| Plan Name allows you to select the method of payment. You can choose:
Note: Since the 1.1.5 version of G Suite For WHMCS module, the ANNUAL plan is equivalent to ANNUAL_MONTHLY_PAY in G Suite API.
| Rennewal Type - choose the method of renewing your plan when the current subscription expires. The available options are:
|Action On Terminate - here you can decide whether you want to suspend or cancel customer services upon the termination.|
|Create Admin Account & Mailbox Name - select this option to automatically create an administrator account with a given username for the G Suite domain.|
|In order to automatically generate configurable options, simply press button marked on the screen. |
|In your WHMCS system press 'Setup' → 'Products/Services' → 'Configurable Options'. |
Find 'GoogleApps' options on the list.
|Here you can manage and alter added configurable options.|
|Provide values for your new option and enter your desired price. 'Save Changes'.|
|At your product 'Module Settings' you can fill out the fields for ' Default Product SKU ID' and 'Default Number of Seats. |
Remember, however, that these values will be used only if configurable options are NOT generated.
|From now on you can easily and quickly change value of your product. Remember that you can add more configurable options for other values.|
|Let's check your new product in admin area product page. It should look like on the screen below.|
|This is how the module will look like in the client area. G Suite For WHMCS also allows your customers to quickly access Google account services.|
Update of Existing Customers
|You can link existing customers accounts by properly filling in the Custom Fields: 'GoogleApps Domain' and 'GoogleApps PurchaseOrderID'. |
After your customers order a new subscription, they should insert their primary Google account domain name in the 'GoogleApps Domain' field.
|1. Our module requires to use G Suite Reseller account.|
|2. Avoid using localhost and Raw IP during the authorization.|
|3. Callback URL is fetched from your WHMCS System URL. You can set it in the 'General Settings' of your system.|
|4. To change your API access and OAuth, go to product configuration page and add |
|5. If you want to better understand G Suite Reseller API and our module concept, visit this page|
|Essential guidance through the process of updating the module is offered here.|
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
|1. When you have problems with connection, check whether your SELinux or firewall does not block ports.|
|2. It is possible that while authenticating our module you will get an error:
If you do, make sure that URLs provided in Google account and your WHMCS system are same.
|3. In case you encounter error similar to the one below, you most probably disabled the output buffering in the PHP configuration.
Notice: ob_clean(): failed to delete buffer.
To solve the problem, please set the 'output_buffering' value to 'On' in the php.ini file.