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

From WHMCS Documentation

(→‎Creating a Facebook App)
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
This article is part of the [[Sign-in Integrations]] feature.
+
Enabling the Facebook® [[Sign-In Integrations]] enables visitors and customers to register, sign in, and connect their Facebook accounts with your WHMCS installation for faster signup and automatic sign-in.
  
−
==Purpose==
+
[[File:Signinintegrationslogin.png]]
  
−
Enabling the Facebook Sign In Integration enables visitors and customers to register, sign in and connect their Facebook accounts with your WHMCS installation for faster sign-up and automatic sign-in.
+
== Configuring Sign-In with Facebook ==
  
−
==Configuring Sign-In with Facebook==
+
Facebook Sign-In Integration requires a Facebook app. You can create this using your existing Facebook account. Users will only see the app name you define and will not see anything relating to the account you use to create the app.
  
−
There are 3 steps required to setup Sign-In with Facebook:
+
<div class="docs-alert-warning">
 +
You can't change the Facebook account under which you create the app without requiring users to reauthenticate and re-link their accounts.
 +
</div>
  
−
# Create a Facebook App
+
To set up sign-in with Facebook:
−
# Retrieve the App Credentials
 
−
# Activate within WHMCS
 
  
−
===Creating a Facebook App===
+
# Create a Facebook App.
 +
## Visit [https://developers.facebook.com/apps/ the Facebook developer portal].
 +
## Log in to your Facebook account.
 +
## Click '''Create App'''. [[File:Facebook-1.png]]
 +
## Select '''Consumer''' as the app type. [[File:Facebook-2.png|600px|border]]
 +
## Click '''Continue'''.
 +
## Enter an '''App Display Name'''. This is the name people will see when authorizing your app. We recommend using your company name here.
 +
## Enter an '''App Contact Email'''. This email will be used for important communication about your app. [[File:Facebook-3.png|600px|border]]
 +
## Click '''Create App'''.
 +
## Locate '''Facebook Login''' and click '''Set Up'''. [[File:Facebook-4.png|600px|border]]
 +
## Select '''Web''' as your platform. [[File:Facebook-5.png|600px|border]]
 +
## Enter the full URL to the <tt>root</tt> domain of your website. [[File:Facebook-6.png|600px|border]]
 +
## Click '''Save'''.
 +
## Click '''Continue'''.
 +
# Configure the required permissions.
 +
## From the '''App Review''' menu, select '''Permissions and Features'''.
 +
## Locate the '''public_profile''' option and click '''Get Advanced Access'''. [[File:Facebook-9.png|800px|border]]
 +
##  Agree to the request and click '''Confirm'''.
 +
# Retrieve the App Credentials.
 +
## Navigate to the Dashboard.
 +
## From the '''Settings''' menu, select '''Basic'''.
 +
## Click '''Show''' to view the App ID and Secret. [[File:Fb10.png]]
 +
# Activate the app within WHMCS.
 +
# Log in 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'''.
 +
# Select '''Activate''' under the Facebook heading.
 +
# Enter your Facebook App ID and your Facebook App Secret.
 +
# Click '''Save & Activate'''.
  
−
Facebook Sign In Integration requires a Facebook App.  You can create this using your existing Facebook account. Users will only see the App Name you define and not see anything relating to the account you use to create the app.
+
WHMCS will attempt to validate and test the details you have entered. If the App ID and Secret are valid and successfully authenticate with the Facebook API, the values will be saved.
  
−
1. Visit https://developers.facebook.com/apps/ <br>
+
==Troubleshooting==
−
2. If not logged in, login to your Facebook account <br>
 
  
−
[[File:Facebooksignin1.png]]
+
For troubleshooting help, see [[Troubleshooting Sign-In using Facebook]].
−
 
 
−
3. Click '''Add a New App'''
 
−
 
 
−
[[File:Facebooksignin2.png]]
 
−
 
 
−
4. Enter a Display Name - this is the name people will see when authorizing your app - we recommend using your Company Name here<br>
 
−
5. Enter a Contact Email - this email will be used for important communication about your app<br>
 
−
6. Click '''Create App ID'''
 
−
 
 
−
[[File:Facebooksignin3.png]]
 
−
 
 
−
7. Next you will be asked to '''Select a product'''. Locate the '''Facebook Login''' product and click '''Set Up'''
 
−
 
 
−
[[File:Facebooksignin4.png]]
 
−
 
 
−
8. On the '''Platform''' screen choose '''Web'''
 
−
 
 
−
[[File:Facebooksignin5.png]]
 
−
 
 
−
9. Now you will be asked to provide the URL of your website. Here you should enter the full URL to the root domain of your website. In the example above, we have entered https://demo.whmcs.com/ <br>
 
−
 
 
−
10. Hit Save and then click Continue
 
−
 
 
−
<div class="docs-alert-info">The remaining steps provide information intended for developers who are integrating Facebook Login for the first time. We've done the integration work so you can skip all of this.</div>
 
−
 
 
−
11. Select the '''App Review''' tab
 
−
 
 
−
[[File:Facebooksignin7.png]]
 
−
 
 
−
12. Toggle the Yes/No toggle under the '''Make Public''' heading. You will be asked to provide a category for your app. We recommend selecting the category that most closely matches your business.
 
−
 
 
−
===Retrieving the App Credentials===
 
−
 
 
−
To retrieve the credentials for the app you just created, follow the steps below.
 
−
 
 
−
1. Navigate to the Dashboard<br>
 
−
2. The App ID is displayed here<br>
 
−
3. The App Secret is masked by default. Click the ''Show'' button to reveal it.<br>
 
−
 
 
−
[[File:Facebooksignin6.png]]
 
−
 
 
−
===Activating within WHMCS===
 
−
 
 
−
# Login to the WHMCS Admin Area
 
−
# Navigate to Setup > Sign-In Integrations
 
−
# Select Activate under the Facebook heading
 
−
# Enter your Facebook App ID and your Facebook App Secret where requested
 
−
# Click Save & Activate
 
−
 
 
−
WHMCS will attempt to validate and test the details you have entered. Assuming the App ID and Secret are valid and successfully authenticate with the Facebook API, the values will be saved and the modal will close.
 
−
 
 
−
Congratulations! Facebook Sign In is now enabled.
 

Latest revision as of 15:33, 20 April 2022

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

Signinintegrationslogin.png

Configuring Sign-In with Facebook

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

You can't change the Facebook account under which you create the app without requiring users to reauthenticate and re-link their accounts.

To set up sign-in with Facebook:

  1. Create a Facebook App.
    1. Visit the Facebook developer portal.
    2. Log in to your Facebook account.
    3. Click Create App. Facebook-1.png
    4. Select Consumer as the app type. Facebook-2.png
    5. Click Continue.
    6. Enter an App Display Name. This is the name people will see when authorizing your app. We recommend using your company name here.
    7. Enter an App Contact Email. This email will be used for important communication about your app. Facebook-3.png
    8. Click Create App.
    9. Locate Facebook Login and click Set Up. Facebook-4.png
    10. Select Web as your platform. Facebook-5.png
    11. Enter the full URL to the root domain of your website. Facebook-6.png
    12. Click Save.
    13. Click Continue.
  2. Configure the required permissions.
    1. From the App Review menu, select Permissions and Features.
    2. Locate the public_profile option and click Get Advanced Access. Facebook-9.png
    3.  Agree to the request and click Confirm.
  3. Retrieve the App Credentials.
    1. Navigate to the Dashboard.
    2. From the Settings menu, select Basic.
    3. Click Show to view the App ID and Secret. Fb10.png
  4. Activate the app within WHMCS.
  5. Log in to the WHMCS Admin Area.
  6. Navigate to Configuration () > System Settings > Sign-In Integrations or, prior to WHMCS 8.0, Setup > Sign-In Integrations.
  7. Select Activate under the Facebook heading.
  8. Enter your Facebook App ID and your Facebook App Secret.
  9. Click Save & Activate.

WHMCS will attempt to validate and test the details you have entered. If the App ID and Secret are valid and successfully authenticate with the Facebook API, the values will be saved.

Troubleshooting

For troubleshooting help, see Troubleshooting Sign-In using Facebook.

Retrieved from "http://3.17.75.209/index.php?title=Configuring_Sign-In_using_Facebook&oldid=32207"