tiktok_business_sdk #

A Flutter plugin that provides easy integration with TikTok Business SDK for Android and iOS platforms.

Features #

• 🔧 SDK Initialization: Initialize TikTok Business SDK with your app credentials
• 👤 User Identification: Set user identity for personalized tracking
• 📊 Event Tracking: Track custom events and user actions
• 🔐 Authentication: Handle user login/logout states
• 🎯 Cross-Platform: Works on both Android and iOS
• 🐛 Debug Mode: Enable debug mode for development and testing

Getting Started #

Prerequisites #

• Flutter SDK: >=3.3.0
• Dart SDK: ^3.9.0
• Android: API level 21+
• iOS: iOS 11.0+

Installation #

Add this to your package's pubspec.yaml file:

dependencies:
  tiktok_business_sdk: ^0.0.1

Then run:

flutter pub get

Platform Setup #

Android

Add the following to your android/app/build.gradle:

android {
    defaultConfig {
        minSdkVersion 21
    }
}

Ensure required permissions in android/app/src/main/AndroidManifest.xml:

<manifest ...>
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <!-- Add any additional permissions as required by your integration -->
    <application ...>
        <!-- Your existing configuration -->
    </application>
</manifest>

For the latest Android integration requirements, refer to TikTok Business documentation: Android Integration Guide.

iOS

Set platform in your ios/Podfile:

platform :ios, '11.0'

Add the tracking usage description in your Info.plist:

<key>NSUserTrackingUsageDescription</key>
<string>We need your permission to track your usage of this app</string>

In your AppDelegate (which extends FlutterAppDelegate), request tracking authorization, e.g.:

import UIKit
import Flutter
import TikTokBusinessSDK

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    GeneratedPluginRegistrant.register(with: self)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }

  override func applicationDidBecomeActive(_ application: UIApplication) {
    super.applicationDidBecomeActive(application)
    TikTokBusiness.requestTrackingAuthorization()
  }
}

For the latest iOS integration requirements, refer to TikTok Business documentation: iOS Integration Guide.

After making changes, run:

cd ios && pod install

Usage #

1. Initialize the SDK #

import 'package:tiktok_business_sdk/tiktok_business_sdk.dart';

final tiktokSdk = TiktokBusinessSdk();

// Initialize the SDK
await tiktokSdk.initTiktokBusinessSdk(
  accessToken: 'your_access_token',
  appId: 'your_app_id',
  ttAppId: 'your_tiktok_app_id',
  openDebug: true, // Enable debug mode
  enableAutoIapTrack: true, // Enable automatic in-app purchase tracking
);

2. Set User Identity #

// Identify a user
await tiktokSdk.setIdentify(
  externalId: 'user_123',
  externalUserName: 'john_doe',
  phoneNumber: '+1234567890',
  email: '[email protected]',
);

3. Track Events #

// Track a login event
await tiktokSdk.trackTTEvent(
  event: EventName.login,
  eventId: 'login_123',
);

// Track a purchase event
await tiktokSdk.trackTTEvent(
  event: EventName.addPaymentInfo,
  eventId: 'purchase_456',
);

// Track without event ID
await tiktokSdk.trackTTEvent(
  event: EventName.completeTutorial,
);

4. Logout #

// Logout user
await tiktokSdk.logout();

Available Events #

The plugin provides a comprehensive set of predefined events:

API Reference #

TiktokBusinessSdk #

Methods

• initTiktokBusinessSdk() - Initialize the TikTok Business SDK
• setIdentify() - Set user identity information
• trackTTEvent() - Track custom events
• logout() - Logout current user
• getPlatformVersion() - Get platform version information

Parameters

initTiktokBusinessSdk

• accessToken (required): Your TikTok Business SDK access token
• appId (required): Your application ID
• ttAppId (required): Your TikTok application ID
• openDebug (optional): Enable debug mode (default: false)
• enableAutoIapTrack (optional): Enable automatic in-app purchase tracking (default: true)

setIdentify

• externalId (required): External user identifier
• externalUserName (optional): External username
• phoneNumber (optional): User phone number
• email (optional): User email address

trackTTEvent

• event (required): Event type from EventName enum
• eventId (optional): Custom event identifier

Error Handling #

The plugin provides error handling through Flutter's standard error mechanisms:

try {
  await tiktokSdk.initTiktokBusinessSdk(
    accessToken: 'invalid_token',
    appId: 'app_id',
    ttAppId: 'tt_app_id',
  );
} catch (e) {
  print('Initialization failed: $e');
}

Platform-Specific Notes #

Android #

• Requires minimum API level 21
• Refer to TikTok docs for proguard/proguard-rules and advanced setup: Android Integration Guide

iOS #

• Requires iOS 11.0+
• Ensure NSUserTrackingUsageDescription is provided and request tracking authorization in AppDelegate
• See: iOS Integration Guide

Contributing #

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License #

This project is licensed under the MIT License - see the LICENSE file for details.

Support #

If you encounter any issues or have questions, please:

1. Check the existing issues
2. Create a new issue with detailed information
3. Include your Flutter version, platform, and error logs

Changelog #

See CHANGELOG.md for a list of changes and version history.

Acknowledgments #

• TikTok Business SDK team for the native SDKs
• Flutter team for the excellent plugin framework
• Community contributors for feedback and improvements