README

A lightweight Laravel package for deep link routing, fallback handling, and link generation. It serves the required .well-known files, provides a fallback page, and centralizes deep link URL creation.

Install

composer require uttam-official/laravel-deeplink

Publish config/views

php artisan vendor:publish --tag=deeplink-config
php artisan vendor:publish --tag=deeplink-views

Basic usage

• Generate a deep link:

$inviteUrl = deeplink_url('invite', ['referral_code' => 'ABC123']);

• Direct invite URL:

https://your-domain.com/invite/ABC123

Helpers

deeplink_url('invite', ['referral_code' => 'ABC123']);
deeplink_web_url('product', ['id' => 99]);
deeplink_invite_url('ABC123');

Routes

• /deeplink/{type}
• /deeplink?type=invite&referral_code=ABC123
• /invite/{code}
• /.well-known/apple-app-site-association
• /.well-known/assetlinks.json

Configure

Set these in .env:

DEEP_LINK_IOS_STORE_URL=
DEEP_LINK_ANDROID_STORE_URL=
DEEP_LINK_APP_SCHEME=ubeku
DEEP_LINK_IOS_TEAM_ID=
DEEP_LINK_IOS_BUNDLE_ID=
DEEP_LINK_ANDROID_PACKAGE=
DEEP_LINK_ANDROID_SHA256=

Example values:

DEEP_LINK_IOS_STORE_URL=https://apps.apple.com/app/id1234567890
DEEP_LINK_ANDROID_STORE_URL=https://play.google.com/store/apps/details?id=com.example.app
DEEP_LINK_APP_SCHEME=example
DEEP_LINK_IOS_TEAM_ID=ABCD1234EF
DEEP_LINK_IOS_BUNDLE_ID=com.example.app
DEEP_LINK_ANDROID_PACKAGE=com.example.app
DEEP_LINK_ANDROID_SHA256=12:34:56:78:90:AB:CD:EF:12:34:56:78:90:AB:CD:EF:12:34:56:78:90:AB:CD:EF:12:34:56:78:90:AB:CD:EF

Config options

The config file is config/deeplink.php and allows:

• Route prefix and invite path
• Route middleware and toggles
• Query resolver param name
• Fallback strategy and timeout
• Android store open mode
• Type → web path mappings
• Optional web URL resolver callback

Production setup

iOS (Universal Links):

• Enable Associated Domains in Xcode.
• Add applinks:your-domain.com.
• Ensure /.well-known/apple-app-site-association is reachable via HTTPS.

Android (App Links):

• Add an intent-filter in AndroidManifest.xml for your domain.
• Host /.well-known/assetlinks.json on your domain via HTTPS.
• Use your release keystore SHA256 fingerprint in DEEP_LINK_ANDROID_SHA256.

Android intent filter example

<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" />
</intent-filter>

iOS Associated Domains

applinks:your-domain.com

Fallback strategy

Configure fallback_strategy in config/deeplink.php:

• app_store_web (default)
• app_web
• web_only

Android store open mode:

• web (default)
• market (market://details?id=...)
• intent (intent://details?id=...#Intent;scheme=market;package=com.android.vending;end)

Well-known endpoints

• /.well-known/apple-app-site-association
• /.well-known/assetlinks.json

.well-known examples

Example /.well-known/apple-app-site-association response:

{
  "applinks": {
    "apps": [],
    "details": [
      {
        "appID": "TEAMID.com.example.app",
        "paths": ["*"]
      }
    ]
  }
}

Example /.well-known/assetlinks.json response:

[
  {
    "relation": ["delegate_permission/common.handle_all_urls"],
    "target": {
      "namespace": "android_app",
      "package_name": "com.example.app",
      "sha256_cert_fingerprints": [
        "12:34:56:78:90:AB:CD:EF:12:34:56:78:90:AB:CD:EF:12:34:56:78:90:AB:CD:EF:12:34:56:78:90:AB:CD:EF"
      ]
    }
  }
]

Testing

From the package root:

composer install
vendor/bin/phpunit

Notes

• App Links / Universal Links require HTTPS and a real domain (not localhost).
• Deferred deep linking requires native support (Android Install Referrer, iOS workaround).