Difference between revisions of "Configuring Sign-In using Google"

From WHMCS Documentation

(Activate Google Sign In within WHMCS)
Line 1: Line 1:
This article is part of the [[Sign-In Integrations]] feature.
+
Enabling the Google [[Sign-In Integrations]] enables visitors and customers to register, sign in, and connect their Google accounts with your WHMCS installation for faster signup and automatic sign-in.
 
 
==Purpose==
 
 
 
Enabling the Google Sign In Integration enables visitors and customers to register, sign in and connect their Google accounts with your WHMCS installation for faster sign-up and automatic sign-in.
 
  
 
[[File:Signinintegrationslogin.png]]
 
[[File:Signinintegrationslogin.png]]
  
==Configuring Sign-In with Google==
+
== Configuring Sign-In with Google ==
 
 
<html><a href="https://vimeo.com/236651329" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span>&nbsp;<img src="https://assets.whmcs.com/icons/youtube.png">&nbsp;</span></a></html>
 
  
There are 2 steps required to setup Sign-In with Google:
+
<html><a href="https://vimeo.com/236651329" class="docs-video-tutorial"><em>Watch the video tutorial for this feature.</em><span>&nbsp;<img src="https://assets.whmcs.com/icons/youtube.png">&nbsp;</span></a></html>
  
# Create a Google Developer Project and Retrieve API Credentials
+
Google Sign-In Integration requires a Google Developer Project and API credentials. You can create this using your existing Google account. Users will only see the app name you define and will not see anything relating to the account you use to create the project.
# Activate Google Sign In within WHMCS
 
  
===Create a Google Developer Project and Retrieve API Credentials===
+
To do this:
  
Google Sign In Integration requires a Google Developer Project and API Credential Set. You can create this using your existing Google account. Users will only see the App Name you define and not see anything relating to the account you use to create the project.
+
# Visit <tt>https://console.developers.google.com/</tt>.
 
+
# Log in to your Google account. <div class="docs-alert-warning">Changing the Google account you use to create the app requires users to re-authenticate and re-link their accounts.</div>
<div class="docs-alert-warning">Be aware that the Google account under which you create the app can not be changed without requiring users to re-authenticate and re-link their accounts so it is important to set the app up under an account that you will always have access to.</div>
+
# Choose '''Create project'''. [[File:Googlesignin1.png]]
 
+
# Enter a project name and click '''Create'''. [[File:Googlesignin2.png]]
1. Visit https://console.developers.google.com/ <br>
+
# On the project dashboard, select '''Credentials''' in the left sidebar.[[File:Googlesignin3.png]]
2. If not logged in, login to your Google account <br>
+
# For the '''OAuth consent screen''' configuration, enter a product name, homepage URL, and logo URL.
3. Under the Project selector, choose '''Create project'''
+
# Click '''Save'''. [[File:Googlesignin4.png]]
 
+
# Go back to the ''Credentials'' tab and select '''Create credentials > OAuth client ID'''. [[File:Googlesignin5.png]]
[[File:Googlesignin1.png]]
+
# Choose '''Web application'''. [[File:Googlesignin6.png]]
 
+
# Enter your full root domain in both the authorized JavaScript origin and redirect URI boxes.
4. Enter a Project Name and click '''Create''' (This name is private to you)
+
# Click '''Create'''. [[File:Googlesignin7.png]]
 
+
# Save your client ID and secret, which you will use to activate Google Sign-In within WHMCS. [[File:Googlesignin8.png]]
[[File:Googlesignin2.png]]
+
# Log in to the WHMCS Admin Area.
 
 
5. Next you will be taken to the project dashboard.  From here, select '''Credentials''' in the left sidebar.
 
 
 
[[File:Googlesignin3.png]]
 
 
 
6. Before creating credentials, you must complete the ''OAuth consent screen'' configuration. Select this tab and enter a product name, homepage url and logo url (the name and logo you define here will be what users see when being asked to authorize access). Once complete, hit '''Save'''.
 
 
 
[[File:Googlesignin4.png]]
 
 
 
7. If not returned automatically, now return to the ''Credentials'' tab and select '''Create credentials > OAuth client ID'''.
 
 
 
[[File:Googlesignin5.png]]
 
 
 
8. On the following screen, choose '''Web application'''
 
 
 
[[File:Googlesignin6.png]]
 
 
 
9. Next you will be asked to provide a name for the credential set (this is not visible to the public) and the authorized JavaScript origins and redirect URIs.  Enter your full root domain in both the authorized JavaScript origin and redirect URI boxes. In the example here we are using "https://demo.whmcs.com".  Then hit '''Create'''.
 
 
 
[[File:Googlesignin7.png]]
 
 
 
10. Your Client ID and secret will then be displayed. These are the values you will need to activate Google Sign In within WHMCS so store these in a safe place.
 
 
 
[[File:Googlesignin8.png]]
 
 
 
You can now proceed to Activate Google Sign In within WHMCS.
 
 
 
===Activate Google Sign In within WHMCS===
 
 
 
# Login to the WHMCS Admin Area
 
 
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Sign-In Integrations''' or, prior to WHMCS 8.0, '''Setup > Sign-In Integrations'''.
 
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Sign-In Integrations''' or, prior to WHMCS 8.0, '''Setup > Sign-In Integrations'''.
# Select Activate under the Google heading
+
# Select '''Activate''' under the Google heading.
# Enter your Google Client ID and secret where requested
+
# Enter your Google client ID and secret.
# Click Save & Activate
+
# Click '''Save & Activate'''.
 
 
WHMCS will attempt to validate and test the details you have entered. If the Client ID and secret are valid and successfully authenticate with the Google API, the values will be saved and the modal will close.
 
 
 
Congratulations! Google Sign In is now enabled.
 
  
==Troubleshooting==
+
WHMCS will attempt to validate the details you have entered. If the client ID and secret are valid and successfully authenticate with the Google API, the values will be saved.
  
 
For troubleshooting help, please refer to [[Troubleshooting Sign-In using Google]]
 
For troubleshooting help, please refer to [[Troubleshooting Sign-In using Google]]

Revision as of 18:09, 9 September 2021

Enabling the Google Sign-In Integrations enables visitors and customers to register, sign in, and connect their Google accounts with your WHMCS installation for faster signup and automatic sign-in.

Signinintegrationslogin.png

Configuring Sign-In with Google

Watch the video tutorial for this feature.  

Google Sign-In Integration requires a Google Developer Project and API credentials. You can create this using your existing Google account. Users will only see the app name you define and will not see anything relating to the account you use to create the project.

To do this:

  1. Visit https://console.developers.google.com/.
  2. Log in to your Google account.
    Changing the Google account you use to create the app requires users to re-authenticate and re-link their accounts.
  3. Choose Create project. Googlesignin1.png
  4. Enter a project name and click Create. Googlesignin2.png
  5. On the project dashboard, select Credentials in the left sidebar.Googlesignin3.png
  6. For the OAuth consent screen configuration, enter a product name, homepage URL, and logo URL.
  7. Click Save. Googlesignin4.png
  8. Go back to the Credentials tab and select Create credentials > OAuth client ID. Googlesignin5.png
  9. Choose Web application. Googlesignin6.png
  10. Enter your full root domain in both the authorized JavaScript origin and redirect URI boxes.
  11. Click Create. Googlesignin7.png
  12. Save your client ID and secret, which you will use to activate Google Sign-In within WHMCS. Googlesignin8.png
  13. Log in to the WHMCS Admin Area.
  14. Navigate to Configuration () > System Settings > Sign-In Integrations or, prior to WHMCS 8.0, Setup > Sign-In Integrations.
  15. Select Activate under the Google heading.
  16. Enter your Google client ID and secret.
  17. Click Save & Activate.

WHMCS will attempt to validate the details you have entered. If the client ID and secret are valid and successfully authenticate with the Google API, the values will be saved.

For troubleshooting help, please refer to Troubleshooting Sign-In using Google