Skip to Content
Engineering11 Documentation 🔥
BackendServer API PackagesDynamic Link

Dynamic Link API

Firebase Dynamic Links generation for smart deep linking and URL shortening.

What It Does

The Dynamic Link API provides a simplified interface for generating Firebase Dynamic Links—smart URLs that route users to appropriate app experiences (web, iOS, Android) based on their platform. It enables deep linking with App Store fallback and analytics tracking.

Key Capabilities

  • URL Shortening: Convert long URLs to short Firebase Dynamic Links
  • Multi-Platform Routing: Automatic routing to web, iOS, or Android apps
  • App Store Integration: Redirect to App Store/Play Store if app not installed
  • Version Control: Minimum app version requirements
  • Deep Linking: Link to specific content within apps
  • Analytics Ready: Supports Firebase Analytics tracking

Main Function

async function getDynamicLink(
  link: string,
  options?: DynamicLinkOptions
): Promise<string>

Parameters:

  • link: The long URL to shorten
  • options: Platform-specific configuration

Returns: Short Firebase Dynamic Link URL

DynamicLinkOptions

{
  domainUriPrefix?: string        // Firebase domain (e.g., https://app.page.link)
  android?: {
    packageName?: string          // Android app package
    minimumVersion?: string       // Min Android version
  }
  ios?: {
    bundleId?: string             // iOS bundle ID
    minimumVersion?: string       // Min iOS version (not yet supported)
    appStoreId?: string          // App Store ID for routing
  }
}

Environment Variables

  • DYNAMIC_LINK_URI_PREFIX: Firebase domain prefix
  • DYNAMIC_LINK_API_KEY: Firebase API key (safe to commit per Firebase docs)
  • ANDROID_PACKAGE_NAME: Default Android package
  • IOS_APP_STORE_ID: Default App Store ID

Common Use Cases

  • Social media sharing with smart routing
  • Email campaign links with app fallback
  • QR codes for mobile app deep linking
  • Marketing attribution with platform detection
  • User invitation links to apps

Roadmap

Multi-Cloud Support

This API currently supports Google Cloud Platform. Future versions will add support for additional cloud providers and container-based deployment options, enabling greater flexibility in infrastructure choices.

What Customers Don’t Have to Build

  • Firebase Dynamic Links integration
  • Platform detection and routing
  • App Store fallback logic
  • Link shortening infrastructure
  • Deep linking configuration
  • Analytics integration
  • Multi-platform URL generation
Last updated on
VideoAI