Quickstart

This guide walks you through creating your first WarpLink deep link and testing it on a device.

1. Create an Account

2. Register Your App

In the dashboard, go to Apps and click Create App. Fill in your platform details:

{
  "name": "My App",
  "ios_bundle_id": "com.example.myapp",
  "ios_team_id": "ABCDE12345",
  "ios_app_store_url": "https://apps.apple.com/app/id123456789"
}

{
  "name": "My App",
  "android_package_name": "com.example.myapp",
  "android_sha256_fingerprints": ["AA:BB:CC:..."],
  "android_play_store_url": "https://play.google.com/store/apps/details?id=com.example.myapp"
}

{
  "name": "My App",
  "ios_bundle_id": "com.example.myapp",
  "ios_team_id": "ABCDE12345",
  "android_package_name": "com.example.myapp",
  "android_sha256_fingerprints": ["AA:BB:CC:..."]
}

3. Create Your First Link

Go to Links and click Create Link, or use the API:

curl -X POST https://api.warplink.app/v1/links \
  -H "Authorization: Bearer wl_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "destination_url": "https://example.com/promo",
    "ios_url": "myapp://promo",
    "android_url": "myapp://promo",
    "app_id": "YOUR_APP_ID"
  }'

You'll get back a short link like https://aplnk.to/abc123.

4. Install the SDK

Add WarpLink via Swift Package Manager:

https://github.com/ApolloLinks/warplink-ios-sdk.git

Configure in your AppDelegate:

import WarpLink

func application(
  _ application: UIApplication,
  didFinishLaunchingWithOptions options: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
  WarpLink.configure(apiKey: "wl_live_YOUR_KEY")
  return true
}

Add to your build.gradle.kts:

dependencies {
  implementation("app.warplink:sdk:1.0.0")
}

Initialize in your Application class:

import app.warplink.sdk.WarpLink

class MyApp : Application() {
  override fun onCreate() {
    super.onCreate()
    WarpLink.initialize(this, "wl_live_YOUR_KEY")
  }
}

Install the package:

npm install @warplink/react-native

Configure in your app entry:

import { WarpLink } from '@warplink/react-native';

WarpLink.configure({ apiKey: 'wl_live_YOUR_KEY' });

5. Test Your Link

Open https://aplnk.to/abc123 on a device with your app installed
The link should open your app directly via Universal Links (iOS) or App Links (Android)
If the app isn't installed, the user is redirected to the app store

Next Steps

Deep Linking Concepts — Understand how deep links work
Deferred Deep Links — Preserve context through installs
API Reference — Full endpoint documentation