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

From WHMCS Documentation

(→‎Activate Twitter Sign In within WHMCS)
 
(6 intermediate revisions by 4 users not shown)
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>
+
<div class="docs-alert-info">
−
 
+
WHMCS uses Twitter API v1.1. Some Twitter accounts will require [https://developer.twitter.com/en/portal/products/elevated Elevated access] to use this version of the Twitter API.
−
There are 2 steps required to setup Sign-In with Twitter:
+
</div>
−
 
 
−
# Create a Twitter App and Retrieve API Credentials
 
−
# Activate Twitter Sign In within WHMCS
 
−
 
 
−
===Create a Twitter App and Retrieve API Credentials===
 
−
 
 
−
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.
 
−
 
 
−
<div class="docs-alert-warning">Be aware that the Twitter 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>
 
−
 
 
−
1. Visit https://developer.twitter.com/en/apps/ <br>
 
−
2. If not logged in, login to your Twitter account <br>
 
−
3. Click the '''Create New App''' button
 
−
 
 
−
[[File:Twittersign1revised.png]]
 
−
 
 
−
4. Enter a Name, Description and Website URL for your App.
 
−
 
 
−
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 setting, 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>
 
−
 
 
−
[[File:Twittersign2revised.png]]
 
−
 
 
−
5. Tick the "Enable sign in with Twitter" box, fill out the box explaining what the app will be used for (sign in integration from WHMCS) and click "Create".
 
−
 
 
−
6. If you do not yet have a phone number defined inside your Twitter account, you will see the following error upon submitting. To create an App, Twitter requires that you have a valid phone number registered in your account with them. You must do this before continuing.
 
−
 
 
−
[[File:Twittersign3.png]]
 
−
 
 
−
7. After submitting the App Creation form, you should see a success confirmation page that looks as follows.
 
−
 
 
−
[[File:Twittersign4revised.png]]
 
−
 
 
−
8. Select the '''Permissions''' tab.  WHMCS only requires Read permissions so you can click the "Edit" button, change the default Access permission level to ''Read-only''. Then hit '''Save'''.
 
−
 
 
−
[[File:Twittersign5revised.png]]
 
−
 
 
−
9. Now select the '''Keys and tokens''' tab. Your API Key and Secret will then be displayed. These are the values you will need to activate Twitter Sign In within WHMCS so store these in a safe place.
 
−
 
 
−
[[File:Twittersign6revised.png]]
 
−
 
 
−
You can now proceed to Activate Twitter Sign In within WHMCS.
 
−
 
 
−
===Activate Twitter Sign In within WHMCS===
 
  
−
# Login to the WHMCS Admin Area
+
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.
−
# 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
 
−
# Enter your Twitter API Key and API Secret where requested
 
−
# 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.
+
To do this:
  
−
Congratulations! Twitter Sign In is now enabled.
+
# 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>
 +
# Go to https://developer.twitter.com/en/portal/dashboard .
 +
# Select '''Projects & Apps''' and then '''Overview''' from the left sidebar.
 +
# Click '''Create App'''.
 +
# Enter an App name. [[File:Screenshot-3.png|thumb]]
 +
# Save the '''API Key''' and API '''Secret Key'''.
 +
# Go to '''app settings''' and click '''Set Up''' in the '''User Authentication Settings''' section.
 +
# Enable '''OAuth 2.0'''.
 +
# Set '''Type of App''' to '''Web App'''.
 +
# 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://example.com/whmcs/ with your WHMCS installation URL:
 +
#** http://example.com/whmcs/index.php
 +
#** http://example.com/whmcs/index.php/auth/provider/twitter_oauth/callback
 +
#** http://example.com/whmcs/auth/provider/twitter_oauth/callback
 +
# Click '''Save'''.
 +
# 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 Twitter heading.
 +
# Enter your Twitter '''API Key''' in the '''ConsumerKey''' field and the '''API Secret''' into the '''ConsumerSecret''' field.
 +
# Click '''Save & Activate'''.
  
−
==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, see [[Troubleshooting Sign-In using Twitter]].

Latest revision as of 13:38, 19 April 2023

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

WHMCS uses Twitter API v1.1. Some Twitter accounts will require Elevated access to use this version of the Twitter API.

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. 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.
  2. Go to https://developer.twitter.com/en/portal/dashboard .
  3. Select Projects & Apps and then Overview from the left sidebar.
  4. Click Create App.
  5. Enter an App name.
    Screenshot-3.png
  6. Save the API Key and API Secret Key.
  7. Go to app settings and click Set Up in the User Authentication Settings section.
  8. Enable OAuth 2.0.
  9. Set Type of App to Web App.
  10. Enter your WHMCS Client Area URL for the callback URLs and website URL.
  11. Click Save.
  12. Log in to the WHMCS Admin Area.
  13. Navigate to Configuration () > System Settings > Sign-In Integrations or, prior to WHMCS 8.0, Setup > Sign-In Integrations.
  14. Select Activate under the Twitter heading.
  15. Enter your Twitter API Key in the ConsumerKey field and the API Secret into the ConsumerSecret field.
  16. 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, see Troubleshooting Sign-In using Twitter.

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