Social Media Login For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About Social Media Login For WHMCS

Social Media Login For WHMCS will help you facilitate the process of logging in to your client area.
Enable any of the social media providers such as Facebook, Google, Microsoft or any other available platform.
Your clients will get a chance to register and then regularly log in with just a single click on their preferable external platform button.
  • Admin Area Features:
✔ Configure And Enable Social Media Platforms
✔ Load Your Own Sets Of Icons
✔ Define Custom Colors Of Login Buttons - Per Provider Or Global
✔ Define The Order Of Providers Available On Login Page
✔ View Statistics On Registered Accounts
✔ View Integration Instructions
✔ View Error Logs
  • Client Area Features:
✔ Register Account Using Social Media Platform - Available Details Are Filled In Automatically
✔ Link Existing WHMCS Account With Social Media Platform
✔ Log In Using Social Media Platform - Single Click Only
  • Supported Platforms:
✔ Amazon
✔ Dropbox
✔ Facebook
✔ GitHub
✔ Google
✔ Instagram
✔ LinkedIn
✔ Microsoft
✔ PayPal
✔ Pinterest
✔ Reddit
✔ Stripe
✔ Tumblr
✔ Twitch
✔ Twitter
✔ WordPress
✔ Yahoo!
  • General Info:
✔ Multi-Language Support
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation

This tutorial will show you how to successfully install and configure Social Media Login For WHMCS.

We will guide you step by step through the whole installation and configuration process.

1. Log in to your client area and download the module.
SML 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

SML 2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

Fgtry.png
4. When you install Social Media Login For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/SocialMediaLogin/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

SML 3.png
5. In order to configure your license key, you have to edit the 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 your client area → 'My Products'.

SML 4.png
6. Now you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' → 'Addon Modules'. Afterwards, find 'Social Media Login' and press 'Activate' button.

SML 5.png
7. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, select administrator roles and press 'Save Changes'.

SML 6.png
8. Now you need to correctly insert integration codes.

Move to 'Addons' → 'Social Media Login' → 'Integration Codes', you will find there detailed instruction on how to perform the integration.
The integration must be performed on three different files as logging with social media platform can be done from more than one place.
Please make sure you are pasting the code snippets in all of your currently used templates and order form.
Note: integration code for 'Login Pop-Up' is only applicable prior WHMCS V7.2.

SML 7.png
9. You have just successfully installed Social Media Login For WHMCS!

You can access your module under 'Addons' → 'Social Media Login'.

SML 8.png

Configuration and Management

Social Media Login For WHMCS brings modern, user-friendly and common solution to your WHMCS to make the usage more enjoyable for your clients.

Underneath, you will find a complete guide which will show you how to take full advantage of the module.

Configuration

The module is integrated with 17 external platforms.
Follow the instruction placed in configuration part of each provider to successfully create a link between the provider and the application that will allow quick login.

Providers

Under 'Settings' 'Providers' tab, there is a full list of supported providers. In this part you may select which of them you wish to enable.
However, before you enable any, first you must configure it.

Press appropriate button next to the desired provider.

SML 9.png
As you can see, all details that must be typed in are 'Application ID' and 'Application Secret'.
Above the form you will find a precise instruction on how to create the application and generate required data.
Please remember, that the process is individual for each provider. Follow the instructions carefully to successfully generate the application.
SML 10.png
Underneath we will show you an exemplary configuration of a Facebook provider. Take a while to read it and see how the process looks like in practice.

Exemplary Application

To show how to proceed with the authentication process, we will describe the registration of a new Facebook application.
SML 10 1.png
According to the instruction placed in the provider configuration, firstly you have to move to https://developers.facebook.com/apps site and log in if necessary.
Then, you will have to register as a Facebook developer if you are not one yet.
SML 11.png

Accept Facebook platform policy and Facebook privacy policy, then verify your account by providing your phone number or credit card.
Next, name your application and type in an email address for contact. Press 'Create App ID'.

SML 13.png
Under 'Settings' section you will find the details that you need the most.
Copy application ID and secret (press 'Show' to see it) and save for later use.
SML 14.png
Now, move to '+ Add Product' and find 'Facebook Login ' on the list. Choose 'Set Up' .
SML 15.png
On the next screen proceed directly to 'Facebook Login' → 'Settings' menu.
SML 12.png
Finally, provide 'Valid OAuth redirect URIs'. You will find a ready one in the addon under the configuration instructions of the provider.

Save the changes and come back to the addon.

SML 16.png
Paste the generated application ID and secret into the appropriate fields and save the changes.
SML 17.png
Now you can enable the provider. That is all! If you need more options, see the 'General' tab.
SML 18.png

General

'General' settings allow you to change default provider icon sets or colors of provider buttons to your own.
  • Icon Sets - you can use your own sets of icons. First you need to create your own icon class file based on the 'FontAwesome.php' located in '/modules/addons/SocialMediaLogIn/assets/classes' .
    Then place your own CSS styles in '/modules/addons/SocialMediaLogIn/assets/miniProviders' and '/modules/addons/SocialMediaLogIn/assets/providers' folders.
  • Default colors - select default button colors that will be used across all your configured providers. You can set up colors both in HEX or RGB format - eg: #000000 for HEX or rgba(0,0,0,1) for RGB format
  • Providers settings - there you can set custom color button per configured provider and change buttons order using drag & drop feature.
SML 19 2.png
An examplary result of such changes will be:
SML 19 3.png
If you would like to achieve a result similar to the above one, you may use the following colors:
Provider Button color Button color on hover Icon color
Amazon #e8aa4f #ffc266 #ffffff
Dropbox #007ee5 #038fff #ffffff
Facebook #3b5998 #4569b2 #ffffff
GitHub #464646 #5a5a5a #ffffff
Google #dd4b39 #fa503a #ffffff
Instagram #686868 #7f7f7f #ffffff
LinkedIn #007bb5 #0098e5 #ffffff
Microsoft #0078d7 #018eff #ffffff
PayPal #0070ba #0184d9 #ffffff
Pinterest #cb2027 #e62129 #ffffff
Reddit #ff4500 #fd8254 #ffffff
Stripe #3583cd #358adb #ffffff
Tumblr #35465c #358adb #ffffff
Twitch #613fab #8953f5 #ffffff
Twitter #55acee #58b4f8 #ffffff
WordPress #21759b #2898d1 #ffffff
Yahoo! #5bc0de #31b0d5 #ffffff

Other

Dashboard

'Dashboard' of the addon includes only a short guide that is placed to help you quickly move through the configuration.

There is also a box with the last five error log entries for your quick view and charts of accounts statistics.

SML 19.png

Logs

Under 'Logs' tab you will find all log entries.

There are details on any failed action in the module. Check it out any time you need to find some details on the actions taken.
Press 'Delete All Entries ' to clear all logs or delete single ones.

SML 20.png

Documentation

The last position in your navigation menu, when pressed, redirects to the article you are currently reading.
SML 21.png

Client Area

Social Media Login For WHMCS interferes with the client area login pages.
To allow a full and proper performance of the module you must have previously pasted the integration codes to display the 3rd party platform buttons.
Please make sure you have fulfilled step no 8 of our installation instructions.

Quick Login

Main page is the first place, where users may register and then log in with a single click on the application button.
Users may choose whether they wish to log in with standard details - WHMCS email address and password, or with their favorite platform.

SML 22.png
Logging in with a social media platform is also available from the login pop-up (prior WHMCS V7.2 template).
SML 23.png
Finally, users may log in with any allowed social media when placing an order.
SML 24.png
The process is extremely simple, for example press the 'Facebook' button (look at the screen above).
You will be redirected to the login page of the social media platform (if currently logged out) and you will have to log in there.
Next you will be asked if you agree to share your account details with the external platform.
SML 25.png

If you agree, then in WHMCS you may connect your Facebook account with the WHMCS account, press 'Connect With My Account'.
If you do not have a WHMCS account yet, create one now.

SML 28.png
If a user has no account in WHMCS, and chooses to 'Register New Account' , any available in the platform data is immediately transferred to WHMCS.
You may edit it and provide new information as well.
SML 26.png
Note: some providers may not share all personal data, for example Instagram email address. In this case, the user will be prompted to enter the email address manually.

If the email address returned by the provider already exists in WHMCS system, the client will be asked to enter a different address
or link their account with the existing e-mail address (sign in again and select 'Connect With My Account' ).

Tips

1. If you decided to use Login with Twitter option, make sure your application is whitelisted by the platform administrators.
2. Your customers may use several social media platforms to log in.

Since 1.2.0 module version it is no longer required for used in the platform email address to be the same as the one saved in user WHMCS account.

3. As this module supports templates system, any changes made in the module's templates files will be saved after the upgrade process.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
Social Media Login For WHMCS