Twitter Sign Up/Log In

Users can log in/register the system through their Twitter account

API Usage Instructions

Before calling the API, please ensure you have thoroughly read the relevant API documentation. Below are specific instructions for different login methods:

一、 Setting Up Twitter Login Configuration

For more detailed steps, please refer to the Twitter developer documentation: Twitter Developer Documentation

Before using the third-party login service, you need to register as a developer on the respective platform and create an application. The registration steps for Twitter are as follows:

1. Visit Twitter Developer: Log in to the Twitter Developer platform using your Twitter account.

2. Create a New Application: Create a new application and obtain your API key and API secret key.

3. Obtain App ID and App Secret: After successful creation, obtain the Client ID (Client ID) and Client Secret (Client Secret).

4. Configure the Client ID and Client Secret in the White Label Management Backend.

二、Retrieve Third-Party Login Configuration Information

Call the third-party configuration API to obtain the ClientId registered in the first step.

Request Parameters:

{
    // Third-party source: Supported third-party login sources
    // Optional values include: google, facebook, twitter, telegram, apple, metamask, separated by commas
    "thirdSource": "google,twitter"  // Example: using Google and Twitter login
}

Response Structure:

{
    // Third-party source: Supported third-party login sources, e.g., "google", "facebook", "twitter", "telegram", "apple", "metamask"
    "thirdSource": "twitter",  // Example: using Twitter login

    // Client ID: The unique identifier for the third-party application
    "clientId": "abcesddff",    // Example: your application's client ID on Twitter

    // Developer Account: The developer's email associated with the third-party source
    "developerAccount": "[email protected]" // Example: developer's email address
}

三、Login Code Implementation

Refer to the documentation: Hello.js Documentation

1. Install Hello.js via NPM:

npm install hellojs

2. Initialize Hello.js:

hello.init({
  'twitter': 'YOUR_TWITTER_CLIENT_ID' // Use the clientId obtained in the previous step
});

3. Initiate Login Authorization Request:

function loginWithTwitter() {
    hello('twitter').login().then(function(res) {
        // Handle successful login
        console.log('Logged in to Twitter!');
        // After login, call the Twitter third-party login verification interface
        twitterVerify({
            authResponse: res.authResponse
        });
    }, function(e) {
        // Handle errors
        console.error('Login failed:', e);
    });
}

4. Twitter Access Token Verification

Call the Twitter third-party login verification API.

Request Parameters:

{
    // Channel source: Supported channel types, e.g., "h5", "pc"
    "channelSource": "h5",  // Example: indicates from H5 end

    // User authorization information
    "authResponse": "accessToken"  // Example: replace with the actual accessToken
}

Response Structure:

{
    // Next operation action: Supported action types, such as "login", "bind", "register"
    "action": "login",  // Example: indicates the user is performing a login operation

    // User's email returned by the third party
    "email": "[email protected]",  

    // Reason for verification failure (if any)
    "failReason": "Invalid credentials", 

    // User's phone number returned by the third party
    "phone": "[phone]", 

    // Verification result: indicates whether verification was successful, true for success, false for failure
    "result": true,  // Example: indicates verification success

    // Third-party login source: Supported sources, e.g., "google", "facebook", "twitter"
    "thirdSource": "twitter",  

    // Verification token: token for identity verification
    "token": "exampleToken123",

    // Third-party user ID: unique identifier for the user on the third-party platform
    "userId": "thirdPartyUserId",

    // Third-party authorization credential: credential for accessing third-party APIs
    "authToken": "authToken123" 
}

5. Complete Login/Register: Based on the information returned in the previous step, call the third-party login or registration API.

const twitterVerify = (data: UserService.LoginVerifyRes) => {
    // Retrieve action type, failure reason, and third-party source
    let { action, failReason, thirdSource } = data;

    // Handle different processes based on action type
    if (action === 'register') {
        // Registration operation
        register(data);
    } else if (action === 'login') {
        // Login operation
        login(data); 
    } else if (action === 'bind') {
        // Binding operation
        login(data);
    } else {
        // Operation is not as expected, show failure reason
        Toast.error(failReason);
    }
};

Through the above steps, you can successfully integrate Twitter login functionality and obtain the user's authorized Access Token. If you encounter issues during integration, please check the network connection or the configuration of your Twitter application to ensure all steps are correctly followed. For more information, please refer to the Twitter developer documentation.