Android

Important

Do not integrate on your own. The TikTok channel requires formal cooperation with TikTok before you can register an application and obtain the configuration required for integration. If you need to integrate, please consult your business contact first.

The purpose of this article is to explain how to set up TikTok authentication so that your Project can log in through the TikTok Channel using the Player Network login authentication Service.

Prerequisites

1. Configuring the application on the TikTok Developer Platform

1. Register and log in to the TikTok Developer Account

Use email to register and log in at the TikTok Developer Platform.

2. (Optional) Create Company Organization

TikTok recommends creating an organization for easier collaboration and role permission management.

1. Organization documentation
2. Create organization entry

3. Create TikTok App

1. Open Apps and click Connect an app.
2. Select Individual Developer or Company Organization.
3. Enter App name, and click Confirm to complete creation.

4. Configure App Basic Information

1. Fill in the application basic information: icon, name, app type, description, terms of service, privacy policy.
2. Check Android under Platforms.
3. Under Configure for Android, enter Android package-related information (provided by development team).

5. Terms of Service & Privacy Policy URL Domain Authentication

TikTok requires authentication of the domain for your ToS/privacy policy URLs. You must pass this verification to save and submit for review.

1. Click Verify URL properties.
2. In the popup, click Verify properties.
3. Choose URL prefix, enter the domain URL, and click Verify.
4. Download the signature file generated by TikTok (e.g., tiktokxxxx.txt).
5. Contact operations/website team to upload this file to the corresponding domain server so it can be directly downloaded via browser.
6. After uploading, return to the TikTok page and click Verify to complete final authentication.
   
   • If failed: please check whether the signature file can be downloaded in the browser (path/permission/CDN cache, etc.).

6. App Review Information

1. Describe in detail how the project uses the TikTok Login Kit login feature.
2. Record a complete video showing TikTok authentication login in the project. If TikTok integration is not yet complete, you may upload any video for now and replace it when submitting for review later.

7. Configure Products: Enable Login Kit

1. Go to Products, click Add products.
2. Click + Add to add Login Kit.
3. Configure for Login Kit:
   • Android App Link (provided by development team)
4. Replace the link with your project's Deep Link, but keep the callback path suffix: .../pnt/tiktok/logincallback

8. Scopes Configuration

• After adding Login Kit, TikTok will automatically include the user.info.basic permission.
• Usually, there is no need to add extra scopes unless explicitly required by business needs.

9. Save App Configuration

1. Click the top right Save to save configuration.
2. As integration and debugging are not completed yet, do not click “Submit for review” for now.
3. If saving fails, please complete any required fields indicated by error messages. (All previous steps are generally required.)

10. (Recommended) Create Sandbox and Add Test Users

It is recommended to conduct development and debugging in the Sandbox environment before submitting for review.

1. Switch to Sandbox in the top left corner, click Create Sandbox.
2. Enter the Sandbox name, check Clone from Production or an existing Sandbox, and click Confirm.
3. In Sandbox, click Add account to add test TikTok account:
   • After login, the account will appear in the Target Users list.
   • Only accounts in Target Users can participate in TikTok login testing

2. Get Player Network Console login account.
3. Create a new project for your game or join an existing one.
4. Download SDK.
5. Integrate SDK.
6. Add TikTok as the login authentication method for business in Player Network Console.

Step 1: Configure SDK for TikTok Login

1. Open the project INTLConfig.ini file:

   INTLConfig.ini

   [INTL environment]
   # WARNING: You should change this URL to the production environment when you release your project.
   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
   [Android LifeCycle]
   LIFECYCLE = TikTok
   [TikTok]
   TIKTOK_APP_ID = {INTL_TIKTOK_APP_ID}
   TIKTOK_CLIENT_KEY = {INTL_TIKTOK_CLIENT_KEY}
   TIKTOK_REDIRECT_URI = {INTL_TIKTOK_REDIRECT_URI}
   TIKTOK_REWARD_BIND_URI = {INTL_TIKTOK_REWARD_BIND_URI}
   TIKTOK_SCOPE = user.info.profile

   • Set the SDK backend environment INTL_URL to https://test.intlgame.com.
   • Replace {INTL_GAME_ID} and {INTL_SDK_KEY} with the GAME_ID and SDK_KEY values assigned by 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 and log files without encryption or compression.
   • Add TikTok to LIFECYCLE so the SDK initializes the TikTok module. For more information, see SDK Environment.
   • Replace {INTL_TIKTOK_APP_ID} with the App ID assigned by TikTok.
   • Replace {INTL_TIKTOK_CLIENT_KEY} with the Client Key assigned by TikTok, used to identify the project during the TikTok login flow.
   • Replace {INTL_TIKTOK_REDIRECT_URI} with the Redirect URI where TikTok will callback to your project after authorization, passing back the login result. The callback path must end with /pnt/tiktok/logincallback.
   • Replace {INTL_TIKTOK_REWARD_BIND_URI} with the Reward Bind URI used by the TikTok reward-bind flow. The callback path must end with /pnt/tiktok/rewardsbind. Leave this empty if you are not using reward bind.
   • The SDK automatically adds the default scopes user.info.basic, video.list, and game.entitlement.management on mobile. Use TIKTOK_SCOPE only for additional permissions required by your business, such as user.info.profile.

2. Configure Android manifest placeholders and the return Activity meta-data.

   The INTLSDK TikTok plugin registers two callback activities in its own manifest, but their intent filters rely on placeholders supplied by the host app. Make sure your Android Gradle configuration provides the following placeholders (Unity and Unreal build pipelines normally populate these from INTLConfig.ini):

   build.gradle

   android {
       defaultConfig {
           manifestPlaceholders = [
               "TIKTOK_REDIRECT_URI_HOST"      : "{INTL_TIKTOK_REDIRECT_URI_HOST}",
               "TIKTOK_REDIRECT_URI_PATH"      : "{INTL_TIKTOK_REDIRECT_URI_PATH}",
               "TIKTOK_REWARD_BIND_URI_HOST"   : "{INTL_TIKTOK_REWARD_BIND_URI_HOST}",
               "TIKTOK_REWARD_BIND_URI_PATH"   : "{INTL_TIKTOK_REWARD_BIND_URI_PATH}",
           ]
       }
   }

   • Replace {INTL_TIKTOK_REDIRECT_URI_HOST} and {INTL_TIKTOK_REDIRECT_URI_PATH} with the host and path of TIKTOK_REDIRECT_URI. For example, if TIKTOK_REDIRECT_URI = https://example.com/pnt/tiktok/logincallback, use example.com and pnt/tiktok/logincallback.
   • Replace {INTL_TIKTOK_REWARD_BIND_URI_HOST} and {INTL_TIKTOK_REWARD_BIND_URI_PATH} with the host and path of TIKTOK_REWARD_BIND_URI. For example, if TIKTOK_REWARD_BIND_URI = https://example.com/pnt/tiktok/rewardsbind, use example.com and pnt/tiktok/rewardsbind.

   After the TikTok authorization completes, the SDK returns to the game's main activity. Add the following <meta-data> inside your <application> tag so the SDK knows which activity to resume:

   AndroidManifest.xml

   <application ...>
       <meta-data
           android:name="INTL_GAME_ACTIVITY_CLASS_NAME"
           android:value="com.yourgame.YourMainActivity" />
   </application>

   • Replace com.yourgame.YourMainActivity with the fully-qualified class name of your game's main activity. If this meta-data is not provided, the SDK falls back to getLaunchIntentForPackage().

Step 2: Add TikTok Login

Player Network checks the application login status before starting the login process.

• If the TikTok application is installed, Player Network opens the TikTok application for login.
• If the TikTok application is not installed, the Player Network login page will not display the TikTok channel login entry.

1. Register login-related callbacks.

Unity

// Add callbacks
public void AddAuthObserver()
{
    INTLAPI.AddAuthResultObserver(OnAuthResultEvent);
}

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

// Process the INTLAuthResult callback
public void OnAuthResultEvent(INTLAuthResult AuthResult)
{
    Debug.Log($"MethodID: {AuthResult.MethodId}");
    
    string methodTag = "";
    switch (AuthResult.MethodId)
    {
        case (int)INTLMethodID.INTL_AUTH_LOGIN:
            methodTag = "Login";
            break;
        case (int)INTLMethodID.INTL_AUTH_BIND:
            methodTag = "Bind";
            break;
        case (int)INTLMethodID.INTL_AUTH_AUTOLOGIN:
            methodTag = "AutoLogin";
            break;
        case (int)INTLMethodID.INTL_AUTH_QUERY_USER_INFO:
            methodTag = "QueryUserInfo";
            break;
        case (int)INTLMethodID.INTL_AUTH_GET_AUTH_RESULT:
            methodTag = "GetAuthResult";
            break;
    }
}

Unreal Engine

C++ Event Handling (above v1.15)

//configure callback
FINTLAuthEvent authEvent;
authEvent.AddUObject(this, &OnAuthResult_Implementation);
UINTLSDKAPI::SetAuthResultObserver(authEvent);
// Remove callbacks
UINTLSDKAPI::GetAuthResultObserver().Clear();

void OnAuthResult_Implementation(FINTLAuthResult ret)
{ 
    UE_LOG(LogTemp, Warning, TEXT("MethodID: %d"), ret.MethodId);
}

2. Invoke the AutoLogin interface to log in automatically.

Unity

INTLAPI.AutoLogin();

Unreal Engine

UINTLSDKAPI::AutoLogin();

3. If automatic login fails, call the Login interface to allow the player to manually log in.

Unity

INTLAPI.Login(INTLChannel.TikTok); 

Unreal Engine

UINTLSDKAPI::Login(EINTLLoginChannel::kChannelTikTok); 

4. Synchronize the client's authentication status with the project backend and await the final validation result.

If you encounter problems during the integration process, please refer to Frequently Asked Questions.