Authentication and API keys

Your dashboard login uses a browser session. Mobile SDKs do not use that session and do not ask an end user to sign in to Deeplinkly. Instead, the app supplies one active project API key during SDK initialization. The native SDK attaches that project credential to its Deeplinkly API requests.

1. Sign in to Deeplinkly and select the project you are integrating.
2. Open Dashboard → App Settings.
3. Scroll past the platform settings to the API Keys card.
4. Copy an existing key whose status is Active, or choose Add API Key and confirm Generate API Key.
5. Use Copy to copy the complete value. The eye control only changes whether the value is visibly masked in the dashboard.

Add the exact metadata name below inside <application> in AndroidManifest.xml. Replace only the value.

<application ...>
  <meta-data
      android:name="com.deeplinkly.sdk.api_key"
      android:value="your_api_key_here" />
</application>

Initialize the SDK from your application class:

class App : Application() {
    override fun onCreate() {
        super.onCreate()
        Deeplinkly.init(this)
    }
}

Continue with the Android SDK guide.

<key>DeeplinklyApiKey</key>
<string>your_api_key_here</string>

import Deeplinkly

Deeplinkly.initialize()

Native iOS can also call Deeplinkly.initialize(apiKey:) when the build supplies the key programmatically. Initialization is idempotent and the first call wins, so choose one source and keep it consistent.

Continue with the iOS SDK guide.

• Android: add com.deeplinkly.sdk.api_key to android/app/src/main/AndroidManifest.xml.
• iOS: add DeeplinklyApiKey to ios/Runner/Info.plist.

After both native configurations are present, initialize the plugin once before listening for links:

import 'package:flutter/widgets.dart';
import 'package:flutter_deeplinkly/flutter_deeplinkly.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  FlutterDeeplinkly.init();
  runApp(const MyApp());
}

Continue with the Flutter SDK guide.

• Android: add com.deeplinkly.sdk.api_key to the app manifest.
• iOS: add DeeplinklyApiKey to the app's Info.plist.
• Rebuild the native app after changing either file; a JavaScript reload is not enough.

During development, assert that the native module found its key:

import Deeplinkly from 'react-native-deeplinkly';

if (__DEV__ && !(await Deeplinkly.isAvailable())) {
  console.warn('Deeplinkly: no API key in AndroidManifest.xml / Info.plist');
}

Continue with the React Native SDK guide.

1. Confirm the key remains enabled in the selected project's API Keys card.
2. Build and install a fresh native binary after changing manifest or plist values.
3. Enable the SDK's debug logging only in development.
4. Open a Deeplinkly test link on a device and confirm the resolved payload reaches the app.
5. Check the same project in Deeplinkly for the resulting click, attribution, or event.

1. Generate a second key in App Settings and leave the current key active.
2. Update the native configuration in every supported platform build.
3. Release and verify the new build against the correct project.
4. After the migration window, disable the old key and monitor older app versions.
5. Delete the old key only when you are certain no supported build still uses it.