Skip to main content

Getting Started

OpenLynk is a dynamic link management platform built for mobile apps. It lets you create deep links that route users to specific screens in your iOS and Android apps, with automatic fallbacks to the App Store, Play Store, or a custom web URL when the app is not installed. Links survive the install flow, so users always land on the right content.

Beyond linking, OpenLynk provides click analytics with device and campaign breakdowns and custom domain support for branded short URLs. Manage multiple apps under a single organization with role-based access from the dashboard or programmatically through native SDKs.

Documentation Map

Tutorials

Step-by-step guides to get you up and running. Start here if you are new to OpenLynk.

How-To Guides

Task-oriented instructions for specific goals: managing apps, configuring domains, handling edge cases.

Reference

Technical specifications, SDK API details, configuration options, and data model definitions.

Concepts

Understand how OpenLynk works under the hood: link resolution, deferred deep linking, and domain verification.

Quick Start

  1. Sign up at openlynk.io/auth/signup and create your organization.
  2. Create an app in the dashboard. Choose an app slug (e.g. myapp) -- this becomes your link subdomain (myapp.openlynk.to).
  3. Generate an API key from the app settings page. You will need this to authenticate SDK calls.
  4. Integrate the SDK into your mobile project. Add the OpenLynk SDK for Flutter, iOS, or Android and initialize it with your App ID and API key.
  5. Create your first link from the dashboard or from code, then test it on a device.
tip

For a detailed walkthrough of steps 1-3 without writing any code, see the Quick Start tutorial.

After install from the store, the SDK automatically restores the pending link so the user lands on the right screen. This is called deferred deep linking -- the link destination is preserved across the entire install flow.

SDK Support

PlatformLanguageTutorialReference
FlutterDartFlutter IntegrationFlutter SDK Reference
iOSSwiftiOS IntegrationiOS SDK Reference
AndroidKotlinAndroid IntegrationAndroid Kotlin Reference
AndroidJava--Android Java Reference

What's Next?