Skip to main content

iOS

This article aims to introduce how to set up X authentication, enabling your game to use the Player Network login authentication service to log in through the X channel.

Important

从 2024 年春季开始，对于需更新或上传至 Apple App Store Connect 的应用，开发者需明确 注明使用原因，以展示该应用如何使用 required reason API（需提交使用原因的 API）。更多信息，请参见 即将发布的第三方 SDK 要求。

Since the X privacy manifest has not been released yet, the Player Network SDK privacy manifest does not include corresponding content. For details, refer to iOS 17 Privacy Manifest.

note

Since the Player Network SDK only supports X web login, the INTLTwitter plugin relies on the WebView component's INTLWKWebViewJavascriptBridge to obtain the login information returned from the X login webpage.

Prerequisites​

1. Set up your game on X Developer website

1. Create X Application​

tip

It is recommended to register your account using a Tencent email to improve the success rate of future applications.

Follow the prompts to register a team or personal developer account on the X Developer website.After obtaining a developer account, you can create an application on the Developer Portal.

  1. Create a new project.

    Image: Create X project

  2. Select a use case.Click Next.

    Image: X project use case

  3. Enter a project description.Click Next.

    Image: X project description

  4. Select the application environment.Click Save.

    Image: X application environment

  5. Enter the application name.Click Save.

    Image: X app name

  6. After creating the application, obtain the API key and API secret key.Store this information.Click App Settings.

Important

This page will not be displayed again. Please make sure to save this information.

Image: X API key and API secret key 7. Click Set up.

Image: X setup 8. Enable OAuth2.0 and OAuth1.0a.Select Web App in the application type.

Image: X OAuth 9. Select Read And Write in the application permissions.

Image: X app permissions 10. Enter the test and production URLs for the callback URL.You will be directed to the official website of the game.Click Save.

caution

If the game is already live, you cannot delete the existing callback URL; you can only add new ones.

For Player Network SDK V1.15 and earlier versions

https://image.intlgame.com/v2/test/jssdk/twitterlogincallback.html
https://image.intlgame.com/v2/release/jssdk/twitterlogincallback.html

For Player Network SDK V1.16 and later versions

https://test-common-web.intlgame.com/jssdk/twitterlogincallback.html
https://common-web.intlgame.com/jssdk/twitterlogincallback.html

When TWITTER_CONSUMER_USE_SDK is 1, to use the X SDK login in INTLConfig.ini, please add the following callback URLs:

twittersdk://
twitterkit-{API Key}://

{API Key} needs to be replaced with your game's API Key, excluding the curly brackets .

Image: X callback URLs

2. Retrieve Application Information​

You need the X App ID and password to add X as a login channel in Player Network.

Image: X app information

  1. Go to the Player Network console to create a new project for your game or join an existing project.
  2. Download SDK.
  3. Integrate SDK.
  4. Add X as a business login authentication method in the Player Network console.

Step 1: Configure SDK for X login​

  1. Open the INTLConfig.ini file.

    INTLConfig.ini
    [INTL environment]
    # WARNING: You should change this URL to the production environment when you release your game.
    INTL_URL = https://test.intlgame.com
    GAME_ID = {INTL_GAME_ID}
    SDK_KEY = {INTL_SDK_KEY}
    [INTL Log]
    LOG_LEVEL = 1
    LOG_CONSOLE_OUTPUT_ENABLE = 1
    LOG_FILE_OUTPUT_ENABLE = 1
    LOG_ENCRYPT_ENABLE = 0
    LOG_COMPRESS_ENABLE = 0
    [X]
    TWITTER_CONSUMER_KEY = {INTL_TWITTER_CONSUMER_KEY}
    TWITTER_CONSUMER_SECRET =  {INTL_TWITTER_CONSUMER_SECRET}
    • Set the SDK backend environment to INTL_URL = https://test.intlgame.com.
    • Replace {INTL_GAME_ID} and {INTL_SDK_KEY} with the values of GAME_ID and SDK_KEY assigned by the Player Network console.
    • Set LOG_LEVEL = 1, LOG_CONSOLE_OUTPUT_ENABLE = 1, LOG_FILE_OUTPUT_ENABLE = 1, LOG_ENCRYPT_ENABLE = 0, and LOG_COMPRESS_ENABLE = 0 to output console logs and log files without encryption or compression.
    • Replace {INTL_TWITTER_CONSUMER_KEY} and {INTL_TWITTER_CONSUMER_SECRET} with the X API key and API Key Secret.

  2. Add X to the Info.plist file.

Before exporting the Xcode project from Unity, check the predefined values in INTLTwitterKit.projmods and replace {INTL_TWITTER_CONSUMER_KEY} with the X API key.

{
    "group": "INTL",
    "Info.plist":{
    "LSApplicationQueriesSchemes":
    [
        "twitter",
        "twitterauth",
    ],
    "CFBundleURLTypes" :
    [
        {
            "CFBundleTypeRole":"Editor",
            "CFBundleURLSchemes":["twitterkit-{INTL_TWITTER_CONSUMER_KEY}"]
        }
    ]
    }
}

Replace {INTL_TWITTER_CONSUMER_KEY} with the X API key.

If you need to call X friends, find the BuildPhrases configuration in the INTLTwitter iOS plugin for the Xcode project and add or modify the following configuration:

MapKit.framework
Accounts.framework
CoreData.framework

Step 2: Add X login​

After the user logs in, choose the X channel to proceed with binding.If the user has already used a bound X account, a server error will be prompted.Invoking the Bind interface again will require the user to log in to X again.

  1. Register login-related callbacks.
// Add callbacks
public void AddAuthObserver()
{
    INTLAPI.AddAuthResultObserver(OnAuthResultEvent);
}

// Remove callbacks
public void RemoveAuthObserver()
{
    INTLAPI.RemoveAuthResultObserver(OnAuthResultEvent);
}

// Process the INTLAuthResult callback
public void OnAuthResultEvent(INTLAuthResult ret)
{
    Debug.Log($"MethodID: {ret.MethodId}");
    
    string methodTag = "";
    if (authRet.MethodId == (int)INTLMethodID.INTL_AUTH_LOGIN)
    {
        methodTag = "Login";
    }
    else if (authRet.MethodId == (int)INTLMethodID.INTL_AUTH_BIND)
    {
        methodTag = "Bind";
    }
    else if (authRet.MethodId == (int)INTLMethodID.INTL_AUTH_AUTOLOGIN)
    {
        methodTag = "AutoLogin";
    }
    else if (authRet.MethodId == (int)INTLMethodID.INTL_AUTH_QUERY_USER_INFO)
    {
        methodTag = "QueryUserInfo";
    }
    else if (authRet.MethodId == (int)INTLMethodID.INTL_AUTH_GET_AUTH_RESULT)
    {
        methodTag = "GetAuthResult";
    }
}
  1. Invoke the AutoLogin interface to log in automatically.
INTLAPI.AutoLogin();
  1. When automatic login fails, invoke the Login interface to allow players to log in manually.
INTLAPI.Login(INTLChannel.Twitter);
  1. Synchronize the client's authentication status with the game backend and await the final validation result.

[Optional] Set email permissions​

To obtain the player's email during X login, you must first enable the corresponding permission. After enabling, email will be returned in the ChannelInfo of AuthResult.

  • For compliance considerations, you can mask the returned email for specific sources. If needed, please contact Player Network Assistant to enable.
  • You can report base64(sha256(email)) in backend logs after hashing. If needed, please contact Player Network Assistant to enable.
  • Can be used to verify whether player information or the bind list contains email information. If needed, please contact Player Network Assistant to enable.
  • Can be used for iOS Firebase's Private Set Membership (PSM) feature. See Firebase iOS Project Configuration.

  1. On the X Developer Platform, under User authentication settings, check Request email from users.

    Image: OAUTH1.OA SETTINGS

  2. Enable email return in the Player Network Console by setting return_email to YES. For details, please see Third-party channel configuration.

Step 3: Acceptance of Login Functionality​

Search for the keyword "AuthResult" in the Player Network SDK log to confirm whether the channel name and OpenID are returned correctly.If they are correct, it means the integration is successful and the login function has been successfully added.

If you encounter problems during integration, refer to FAQs.

Privacy PolicyTerms of ServiceDPAOpen Source Licenses
©2025 Proxima Beta Pte. Ltd. All rights reserved.