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

From WHMCS Documentation

m
(Updated facebook steps)
Line 16: Line 16:
  
 
===Creating a Facebook App===
 
===Creating a Facebook App===
 +
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.
 +
<div class="docs-alert-warning">Please be aware that the Facebook account under which you create the app cannot be changed without requiring users to reauthenticate and re-link their accounts. Therefore it is important to create the app under an account that you will always have access to.</div>
 +
1. Visit https://developers.facebook.com/apps/.
  
−
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.
+
2. If not logged in, log in to your Facebook account.
  
−
<div class="docs-alert-warning">Be aware that the Facebook 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>
+
3. Click "'Create App'".
  
−
1. Visit https://developers.facebook.com/apps/ <br>
+
[[File:Facebook-1.png]]
−
2. If not logged in, login to your Facebook account <br>
 
  
−
3. Click "My Apps" and then click '''Add a New App'''
+
4. Select '''Consumer''' as the app type.
  
−
[[File:Fb1.png]]
+
[[File:Facebook-2.png|600px|border]]
  
−
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. Click '''Continue'''.
  
−
[[File:Facebooksignin2.png]]
+
6. Enter an '''App Display Name'''. This is the name people will see when authorising your app. We recommend using your company name here.
  
−
5. Enter a Contact Email - this email will be used for important communication about your app<br>
+
7. Enter an '''App Contact Email'''. This email will be used for important communication about your app.
−
6. Click '''Create App ID'''<br><br>
 
−
7. Next you will be asked to '''Select a Scenario'''. Locate the '''Integrate Facebook Login''' option, select it and click '''Confirm'''
 
  
−
[[File:Fb-2.png]]
+
[[File:Facebook-3.png|600px|border]]
  
−
8. You are now presented with your app "Dashboard". Click '''Finish Quickstart'''.
+
8. Click '''Create App'''.
  
−
[[File:Fb3.png]]
+
9. Locate the '''Facebook Login''' option and click '''Set Up'''.
  
−
9. Select '''Web''' when asked which Platform you require.
+
[[File:Facebook-4.png|600px|border]]
  
−
[[File:Fb4.png]]
+
10. Select '''Web''' when asked which platform you require.
  
−
10. Provide the URL of your website. You must enter the full URL to the root domain of your website. In the example below, we have entered https://demo.whmcs.com/
+
[[File:Facebook-5.png|600px|border]]
  
−
[[File:Fb5.png]]
+
11. Provide the URL of your website. You must enter the full URL to the root domain of your website. In the example below, we have entered https://demo.whmcs.com/.
  
−
11. Hit Save and then click Continue
+
[[File:Facebook-6.png|600px|border]]
  
−
<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>
+
12. Click '''Save'''.
  
−
12. Select the '''Settings''' menu. Select '''Basic'''.
+
13. Click '''Continue'''.
  
−
[[File:Fb6.png]]
+
<div class="docs-alert-info">The remaining steps provide information intended for developers who are integrating Facebook login for the first time. We've performed the integration work so this can be skipped.</div>
  
−
13. Provide your "App Domain". This must be the same domain you provided in Step 10.
+
14. Choose the '''Settings''' menu and then select '''Basic'''.
  
−
14. Provide a '''Privacy Policy URL''' and '''Data Deletion URL'''.
+
[[File:Facebook-7.png|800px|border]]
  
−
15. Provide a '''Terms of Service URL'''.
+
15. Provide your "App Domains". This must be the same domain you provided in Step 11.
  
−
16. Provide a '''Category'''. Typically, this would be '''Business and Pages'''.
+
16. Provide a '''Privacy Policy URL'''.
  
−
[[File:Fb7.png]]
+
17. Complete '''User Data Deletion'''.
  
−
17. Save the changes
+
18. Provide a  '''Terms of Service URL'''.
  
−
18. Toggle the '''Off''' switch in the top right corner to '''On'''
+
19. Provide a '''Category'''. Typically, this would be '''Business and Pages'''.
  
−
[[File:Fb8.png]]
+
20. Click '''Save Changes'''.
  
−
19. Confirm you'd like to make your App public.
+
21. Toggle the '''App Mode''' switch at the top to '''Live'''.
  
−
[[File:Fb9.png]]
+
[[File:Facebook-8.png|600px|border]]
  
 
====Permissions====
 
====Permissions====
  
−
The default process for creating an App at Facebook includes permissions for email, public profile and user friends list.
+
1. Choose the '''App Review''' menu and then select '''Permissions and Features'''.
  
−
WHMCS only requires the email and public profile permissions. The user friends list permission is not requested and users will not be asked to grant this permission when associating their account with WHMCS.
+
2. Locate the '''public_profile''' option and click '''Get Advanced Access'''.
 +
 
 +
[[File:Facebook-9.png|800px|border]]
 +
 
 +
3. Agree to the request and click '''Confirm'''.
  
 
===Retrieving the App Credentials===
 
===Retrieving the App Credentials===

Revision as of 10:59, 14 July 2021

This article is part of the Sign-In Integrations feature.

Purpose

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.

Signinintegrationslogin.png

Configuring Sign-In with Facebook

There are 3 steps required to setup Sign-In with Facebook:

  1. Create a Facebook App
  2. Retrieve the App Credentials
  3. Activate within WHMCS

Creating a Facebook App

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.

Please be aware that the Facebook account under which you create the app cannot be changed without requiring users to reauthenticate and re-link their accounts. Therefore it is important to create the app under an account that you will always have access to.

1. Visit https://developers.facebook.com/apps/.

2. If not logged in, 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 authorising 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 the Facebook Login option and click Set Up.

Facebook-4.png

10. Select Web when asked which platform you require.

Facebook-5.png

11. Provide the URL of your website. You must enter the full URL to the root domain of your website. In the example below, we have entered https://demo.whmcs.com/.

Facebook-6.png

12. Click Save.

13. Click Continue.

The remaining steps provide information intended for developers who are integrating Facebook login for the first time. We've performed the integration work so this can be skipped.

14. Choose the Settings menu and then select Basic.

Facebook-7.png

15. Provide your "App Domains". This must be the same domain you provided in Step 11.

16. Provide a Privacy Policy URL.

17. Complete User Data Deletion.

18. Provide a  Terms of Service URL.

19. Provide a Category. Typically, this would be Business and Pages.

20. Click Save Changes.

21. Toggle the App Mode switch at the top to Live.

Facebook-8.png

Permissions

1. Choose the App Review menu and then 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.

Retrieving the App Credentials

To retrieve the credentials for the app you just created, follow the steps below.

1. Navigate to the Dashboard
2. Select the Settings menu and select Basic
3. The App ID and Secret are shown here. The App Secret is masked by default. Click the Show button to reveal it.

Fb10.png

Activating within WHMCS

  1. Login to the WHMCS Admin Area
  2. Navigate to Configuration () > System Settings > Sign-In Integrations or, prior to WHMCS 8.0, Setup > Sign-In Integrations.
  3. Select Activate under the Facebook heading
  4. Enter your Facebook App ID and your Facebook App Secret where requested
  5. 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.

Troubleshooting

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

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