Difference between revisions of "Configuring Sign-In using Twitter"
From WHMCS Documentation
| (3 intermediate revisions by 3 users not shown) | |||
| Line 5: | Line 5: | ||
==Configuring Sign-In with Twitter== | ==Configuring Sign-In with Twitter== | ||
| − | < | + | <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. | ||
| + | </div> | ||
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. | 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. | ||
| Line 11: | Line 13: | ||
To do this: | To do this: | ||
| − | + | # Log in to your Twitter account. | |
| − | # 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> | + | #: <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'''. |
| − | # Save | + | # Enter an App name. [[File:Screenshot-3.png|thumb]] |
| − | # Go to app settings and | + | # Save the '''API Key''' and API '''Secret Key'''. |
| − | # Enable ''' | + | # 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. | # 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, | + | #*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'''. | # Click '''Save'''. | ||
# Log in to the WHMCS Admin Area. | # Log in to the WHMCS Admin Area. | ||
| − | # Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Sign-In | + | # 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. | # Select '''Activate''' under the Twitter heading. | ||
# Enter your Twitter '''API Key''' in 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. | ||
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.
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:
- 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.
-
- 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.
- 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:
- Click Save.
- Log in to the WHMCS Admin Area.
- Navigate to Configuration () > 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.
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.