softlink_flutter 0.0.11

SoftLink Flutter SDK for deep linking, deferred deep linking, and install attribution.

softlink_flutter

Official Flutter SDK for SoftLink — a deep link management platform.

Features

• 🔗 Deep linking (when app is already installed)
• 📦 Deferred deep linking (when app is not installed)
• 📱 Device-level install attribution (Android ID / iOS IDFV)
• 🎯 Snapchat CAPI integration support
• 🔄 Automatic duplicate URI handling
• 💾 Persistent storage via GetStorage

Installation

dependencies:
  softlink_flutter: ^0.0.11

Usage

Initialize the SDK in your main.dart:

import 'package:softlink_flutter/softlink_flutter.dart';

void main() {
  runApp(MyApp());
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
    SoftLink.init(
      baseUrl: 'https://your-softlink-backend.com',
      apiKey: 'sl_your_api_key',
      onDeepLink: (deepLink) {
        if (deepLink == null) return;
        print('Screen: ${deepLink.screen}');
        print('Params: ${deepLink.params}');
      },
    );
  }
}

Generating Referral Links (Dynamic Links)

Use SoftLink.generateReferralLink() to generate shareable deep links at runtime:

// Without token (finds first dynamic link matching screenKey):
final url = await SoftLink.generateReferralLink(
  screenKey: 'PRODUCT_DETAIL',
  values: {'productId': '209', 'categoryId': '220'},
  referrerId: currentUser.id, // optional
);

// With token (targets a specific dynamic link):
final url = await SoftLink.generateReferralLink(
  screenKey: 'PRODUCT_DETAIL',
  values: {'productId': '209', 'categoryId': '220'},
  token: 'PARENT_TOKEN', // from SoftLink portal
  referrerId: currentUser.id,
);

if (url != null) {
  Share.share(url); // share via any app
}

Notes:

• Same values always return the same link (deduplication) ✅
• Generated link inherits expiry from parent dynamic link ✅
• referrerId is stored as ref param for referral tracking ✅

SoftLinkDeepLink

Property	Type	Description
token	String	Unique link token
screen	String	Screen key (e.g. DOCTOR_PROFILE)
params	Map<String, dynamic>	Link parameters
linkType	String	static or dynamic

Android Setup

Add to android/app/src/main/AndroidManifest.xml inside <activity>:

<intent-filter android:autoVerify="true">
  <action android:name="android.intent.action.VIEW"/>
  <category android:name="android.intent.category.DEFAULT"/>
  <category android:name="android.intent.category.BROWSABLE"/>
  <data android:scheme="https" android:host="your-domain.com" android:pathPrefix="/l/"/>
</intent-filter>
<intent-filter>
  <action android:name="android.intent.action.VIEW"/>
  <category android:name="android.intent.category.DEFAULT"/>
  <category android:name="android.intent.category.BROWSABLE"/>
  <data android:scheme="yourscheme" android:host="l"/>
</intent-filter>

Add to MainActivity.kt:

override fun onNewIntent(intent: Intent) {
    super.onNewIntent(intent)
    setIntent(intent)
}

iOS Setup

Add to Runner.entitlements:

<key>com.apple.developer.associated-domains</key>
<array>
  <string>applinks:your-domain.com</string>
</array>

Add to Info.plist:

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>yourscheme</string>
    </array>
  </dict>
</array>

Add to AppDelegate.swift:

// Handle Universal Links when app is already running
override func application(
  _ application: UIApplication,
  continue userActivity: NSUserActivity,
  restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void
) -> Bool {
  return super.application(application, continue: userActivity, restorationHandler: restorationHandler)
}

// Handle custom scheme URLs when app is already running
override func application(
  _ app: UIApplication,
  open url: URL,
  options: [UIApplication.OpenURLOptionsKey: Any] = [:]
) -> Bool {
  return super.application(app, open: url, options: options)
}

iOS Deferred Deep Linking (IDFA)

By default, SoftLink uses IDFV (Identifier for Vendor) for iOS deferred deep linking. For improved accuracy, you can pass the IDFA (Identifier for Advertisers) when the user grants App Tracking Transparency (ATT) permission.

Why IDFA improves accuracy

• IDFV — available without permission but resets when all vendor apps are uninstalled
• IDFA — persistent unique device identifier, works even when IP changes (CGNAT), much more reliable for install attribution

Implementation

Step 1 — Add ATT package to your app:

dependencies:
  app_tracking_transparency: ^2.0.6

Step 2 — Add to ios/Runner/Info.plist:

<key>NSUserTrackingUsageDescription</key>
<string>We use this identifier to improve your app experience and provide relevant content.</string>

Step 3 — Request ATT and pass IDFA to SDK:

import 'dart:io';
import 'package:app_tracking_transparency/app_tracking_transparency.dart';
import 'package:softlink_flutter/softlink_flutter.dart';

@override
void initState() {
  super.initState();
  WidgetsBinding.instance.addPostFrameCallback((_) async {
    String? idfa;

    if (Platform.isIOS) {
      try {
        final status = await AppTrackingTransparency.trackingAuthorizationStatus;
        if (status == TrackingStatus.notDetermined) {
          await Future.delayed(const Duration(milliseconds: 500));
          final result = await AppTrackingTransparency.requestTrackingAuthorization();
          if (result == TrackingStatus.authorized) {
            idfa = await AppTrackingTransparency.getAdvertisingIdentifier();
            if (idfa == '00000000-0000-0000-0000-000000000000') idfa = null;
          }
        } else if (status == TrackingStatus.authorized) {
          idfa = await AppTrackingTransparency.getAdvertisingIdentifier();
          if (idfa == '00000000-0000-0000-0000-000000000000') idfa = null;
        }
      } catch (_) {}
    }

    await SoftLink.init(
      baseUrl: 'https://your-softlink-backend.com',
      apiKey: 'sl_your_api_key',
      idfa: idfa, // pass IDFA when available
      onDeepLink: (deepLink) {
        if (deepLink == null) return;
        // handle navigation
      },
    );
  });
}

Notes:

• ATT permission is optional — SDK falls back to IDFV if IDFA is unavailable ✅
• Show ATT prompt at the right time — avoid conflicts with notification permission dialogs ✅
• Apple requires NSUserTrackingUsageDescription in Info.plist — App Store will reject without it ✅
• IDFA is only available on iOS — Android uses Android ID automatically ✅

License

Apache