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

From WHMCS Documentation

(→‎Configuring Sign-In with Twitter)
Line 1: Line 1:
−
This article is part of the [[Sign-In Integrations]] feature.
+
Enabling the Twitter [[Sign-In Integrations]] enables visitors and customers to register, sign in, and connect their Twitter accounts with your WHMCS installation for faster signup and automatic sign-in.
−
 
 
−
==Purpose==
 
−
 
 
−
Enabling the Twitter Sign In Integration enables visitors and customers to register, sign in and connect their Twitter accounts with your WHMCS installation for faster sign-up and automatic sign-in.
 
  
 
[[File:Signinintegrationslogin.png]]
 
[[File:Signinintegrationslogin.png]]
Line 9: Line 5:
 
==Configuring Sign-In with Twitter==
 
==Configuring Sign-In with Twitter==
  
−
<html><a href="https://vimeo.com/231458433" 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>
+
<html><a href="https://vimeo.com/231458433" 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 set up Sign-In with Twitter:
+
Twitter Sign In Integration requires a Twitter app and API credentials. You can create this using your existing Twitter account. Users will only see the app name you define.
  
−
# [[Configuring_Sign-In_using_Twitter#Create a Twitter App and Retrieve API Credentials|Create a Twitter App and Retrieve API Credentials]]
+
To do this:
−
# [[Configuring_Sign-In_using_Twitter#Activate Twitter Sign In within WHMCS|Activate Twitter Sign In within WHMCS]]
 
  
−
===Create a Twitter App and Retrieve API Credentials===
+
# Go to <tt>https://developer.twitter.com/en/portal/dashboard</tt>.
−
 
+
# Log in to your Twitter account. <div class="docs-alert-warning">If you change the Twitter account under which you create the app, users must re-authenticate and re-link their accounts.</div>
−
Twitter Sign In Integration requires a Twitter App and API Credential Set.  You can create this using your existing Twitter account. Users will only see the App Name you define and not see anything relating to the account you use to create the project.
+
# Click '''Create Project'''.
−
 
+
# Select a project name.
−
<div class="docs-alert-warning">Be aware that the Twitter account under which you create the app cannot 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>
+
# Select an app name. [[File:Screenshot-3.png|thumb]]
−
 
+
# Save the '''API Key''' and '''API secret key'''.
−
1. Visit https://developer.twitter.com/en/portal/dashboard <br>
+
# Go to app settings and click '''Edit''' in the '''Authentication Settings''' section.
−
2. If not logged in, log in to your Twitter account <br>
+
# Enable '''3-legged OAuth'''.
−
3. Click the '''Create Project''' button <br>
+
# Enter your WHMCS Client Area URL for the callback URLs and website URL.
−
4. Select a project name. This can be anything such as "WHMCS Login"<br>
+
#* You '''must''' enter a valid callback URL.
−
5. Select an app name. This can be anything such as "WHMCS Client Area Login"<br>
+
#* We recommend adding all three possible callback URLs, replacing <tt><nowiki>http://demo.whmcs.com/whmcs/</nowiki></tt> with your WHMCS installation URL:
−
 
+
#** <tt><nowiki>http://demo.whmcs.com/whmcs/index.php</nowiki></tt>
−
[[File:Screenshot-3.png|thumb]]
+
#** <tt><nowiki>http://demo.whmcs.com/whmcs/index.php/auth/provider/twitter_oauth/callback</nowiki></tt>
−
 
+
#** <tt><nowiki>http:///demo.whmcs.com/whmcs/auth/provider/twitter_oauth/callback</nowiki></tt> <div class="docs-alert-warning">Make sure that the '''WHMCS System URL''' in WHMCS and the Twitter '''Website''' and '''Callback URLs''' all include the same subdomain '''or''' all do not include a subdomain.</div>
−
6. You will now be presented with your API keys. You should take note of the '''API Key''' and '''API secret key'''<br>
+
# Click '''Save'''.
−
7. Go to app settings and scroll down and click '''Edit''' on Authentication Settings section<br>
+
# Log in to the WHMCS Admin Area.
−
8. Enable '''3-legged OAuth'''<br>
 
−
9. Enter your WHMCS Client area URL for the callback URLs and Website URL and click '''Save'''<br>
 
−
 
 
−
You must also enter a valid URL in the Callback URL fields. The URL you enter here is not used, but the valid URL of the callback file must be defined to enable WHMCS to utilize callbacks.  
 
−
 
 
−
Because there are three possible callback URLs depending upon the '''Friendly URLs''' feature settings, we suggest adding all three:
 
−
 
 
−
* http://demo.whmcs.com/whmcs/index.php
 
−
* http://demo.whmcs.com/whmcs/index.php/auth/provider/twitter_oauth/callback
 
−
* http:///demo.whmcs.com/whmcs/auth/provider/twitter_oauth/callback
 
−
 
 
−
Replace <i><nowiki>http://demo.whmcs.com/whmcs/</nowiki></i> with the actual URL of your WHMCS installation
 
−
 
 
−
<div class="docs-alert-warning">Ensure that the '''WHMCS System URL''' in WHMCS, Twitter "Website" and Twitter "Callback URLs" either all contain www subdomain or not, or matching subdomain. Failing to do so will result in an Invalid Details error when trying to activate the Twitter sign-in integration in WHMCS. </div>
 
−
 
 
−
You can now proceed to Activate Twitter Sign In within WHMCS.
 
−
 
 
−
===Activate Twitter Sign In 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 Integration''' 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 Integration''' or, prior to WHMCS 8.0, '''Setup > Sign-In Integrations'''.
−
# Select '''Activate''' under the Twitter heading
+
# Select '''Activate''' under the Twitter heading.
−
# Enter your Twitter '''API Key''' in to the '''ConsumerKey''' field and the '''API Secret''' into the '''ConsumerSecret''' field
+
# Enter your Twitter '''API Key''' in the '''ConsumerKey''' field and the '''API Secret''' into the '''ConsumerSecret''' field.
−
# Click '''Save & Activate'''
+
# Click '''Save & Activate'''.
−
 
 
−
WHMCS will attempt to validate and test the details you have entered. If the API Key and Secret are valid and successfully authenticate with the Twitter API, the values will be saved and the modal will close.
 
−
 
 
−
Congratulations! Twitter Sign In is now enabled.
 
  
−
==Troubleshooting==
+
WHMCS will attempt to validate and test the details you have entered. If the API key and secret are valid and successfully authenticate with the Twitter API, the values will be saved.
  
 
For troubleshooting help, please refer to [[Troubleshooting Sign-In using Twitter]]
 
For troubleshooting help, please refer to [[Troubleshooting Sign-In using Twitter]]

Revision as of 18:24, 9 September 2021

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

Signinintegrationslogin.png

Configuring Sign-In with Twitter

Watch the video tutorial for this feature.  

Twitter Sign In Integration requires a Twitter app and API credentials. You can create this using your existing Twitter account. Users will only see the app name you define.

To do this:

  1. Go to https://developer.twitter.com/en/portal/dashboard.
  2. Log in to your Twitter account.
    If you change the Twitter account under which you create the app, users must re-authenticate and re-link their accounts.
  3. Click Create Project.
  4. Select a project name.
  5. Select an app name.
    Screenshot-3.png
  6. Save the API Key and API secret key.
  7. Go to app settings and click Edit in the Authentication Settings section.
  8. Enable 3-legged OAuth.
  9. Enter your WHMCS Client Area URL for the callback URLs and website URL.
    • You must enter a valid callback URL.
    • We recommend adding all three possible callback URLs, replacing http://demo.whmcs.com/whmcs/ with your WHMCS installation URL:
      • http://demo.whmcs.com/whmcs/index.php
      • http://demo.whmcs.com/whmcs/index.php/auth/provider/twitter_oauth/callback
      • http:///demo.whmcs.com/whmcs/auth/provider/twitter_oauth/callback
        Make sure that the WHMCS System URL in WHMCS and the Twitter Website and Callback URLs all include the same subdomain or all do not include a subdomain.
  10. Click Save.
  11. Log in to the WHMCS Admin Area.
  12. Navigate to Configuration () > System Settings > Sign-In Integration or, prior to WHMCS 8.0, Setup > Sign-In Integrations.
  13. Select Activate under the Twitter heading.
  14. Enter your Twitter API Key in the ConsumerKey field and the API Secret into the ConsumerSecret field.
  15. Click Save & Activate.

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

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

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