Backend SDK - Lite Deferred Deep Linking

A lightweight, framework-agnostic TypeScript/JavaScript SDK client to interact with the Core Redirect Service from your backend applications. It simplifies link creation and embedding metadata.

Installation

Install the package via npm:

npm install @mantiqh/deferred-links-backend

Initialization

Initialize the DeferredLinkingClient with the base URL of your deployed redirect service and the API authorization key.

import { DeferredLinkingClient } from '@mantiqh/deferred-links-backend';

const client = new DeferredLinkingClient(
  'https://core.yourdomain.com', // Base URL of your Core Service
  'your_secret_api_key'          // API Key configured in your Core Service
);

Usage

Use the client to generate short referral links with custom metadata.

Creating a Link

async function createInviteLink(userId: string) {
  try {
    const response = await client.createLink({
      iosUrl: 'https://apps.apple.com/app/id123456789',
      androidUrl: 'https://play.google.com/store/apps/details?id=com.example.app',
      fallbackUrl: 'https://yourdomain.com/download-fallback', // Desktop users
      metadata: {
        referrerId: userId,
        campaign: 'spring_promo_2026',
        rewardEligible: true
      }
    });

    console.log('Short Link:', response.shortLink); // e.g. https://lnk.yourdomain.com/a1b2c3d4
    console.log('Slug:', response.slug);           // e.g. a1b2c3d4
    return response.shortLink;
  } catch (error) {
    console.error('Failed to create deep link:', error);
  }
}

API Reference

DeferredLinkingClient

constructor(baseUrl: string, apiKey: string)

Creates an instance of the API client.

• baseUrl: The root URL of the core redirect service. Trailing slashes are automatically trimmed.
• apiKey: The authentication token checked by the core service middleware.

createLink(options: CreateLinkOptions): Promise<{ slug: string; shortLink: string }>

Sends a request to create a short link with metadata.

• Throws an Error if the response is not OK.

Type Definitions

export interface CreateLinkOptions {
  iosUrl: string;                  // Target App Store URL (required)
  androidUrl: string;              // Target Google Play Store URL (required)
  fallbackUrl?: string;            // Redirect URL for desktop/unknown environments (optional)
  metadata?: Record<string, any>;  // JSON metadata to attach to the referral link (optional)
}