Console
Taqlyn Docs/Start/Quickstart
API v1.43 min read

Quickstart

Create an account, bind a platform, mint a link, and resolve on first open.

LIVE SPECIMEN
Universal & Deferred Link Simulator
URLhttps://taqlyn.com/shop/checkout?cartId=cart_9841&promo=WELCOME20&aff=partner_8
Route: /shop/checkoutMode: Deferred Install

Go from a new workspace to a deferred open in your app. Stop after step 5 if you only need website short links.

#1. Create an account

On the Taqlyn site, choose Get started. Use a real mailbox, verify the email, then open the dashboard.

Forgot the password? Use Forgot password on the same site.

Marketing signup: work email, password, organization
Marketing signup: work email, password, organization

#2. Create an app

Dashboard → Apps → New. Name the app and choose iOS, Android, and/or Web. Sandbox and production each have their own credentials and link host.

Dashboard: create app and choose platforms
Dashboard: create app and choose platforms

#3. Bind the platform

PlatformYou provide
AndroidPackage name + SHA-256 fingerprints (upload key and Play App Signing)
iOSBundle ID, Team ID, numeric Apple App ID
WebSite origin, how in-app paths map to URLs

Taqlyn assigns a link host for that app and environment. Use your own hostname later with custom domains.

Dashboard: bind iOS, Android, and Web
Dashboard: bind iOS, Android, and Web

#4. Copy sandbox credentials

Dashboard → Credentials. Rotate sandbox if you need a new key. You will see:

  • client_id (app_test_… or app_live_…) — mobile and server
  • public_key_id (pk_test_…) — mobile only
  • private PEM once — server only (owner / admin / developer)

Dashboard Credentials: public ids; rotate from the sandbox button
Dashboard Credentials: public ids; rotate from the sandbox button

In Dashboard → Links, or from your backend with a server SDK:

TypeScript
import { TaqlynClient } from "@taqlyn/sdk-node";

const client = new TaqlynClient({
  baseUrl: process.env.TAQLYN_BASE_URL,
  clientId: process.env.TAQLYN_CLIENT_ID,
  privateKey: process.env.TAQLYN_PRIVATE_KEY,
});

const link = await client.createShortLink({
  destinationWeb: "https://example.com/offer",
  destinationPath: "/offer",
  params: { sku: "123" },
  mode: "deferred_app",
});

Share link.shortUrl (campaigns, QR, ads). Do not share only the long website URL if you need a deferred match.

#6. Resolve in the app

Configure the mobile SDK with clientId + publicKeyId. After splash and sign-in:

  1. resolveDeferred()
  2. setReadyForNavigation(true) when your navigator is on screen
  3. Map path / params to a route, then consume(linkId)

Guides: Android · iOS · React Native · Flutter.

Optional next: turn on 2FA · dashboard map.