ZipQuantum Documentation

Everything you need to use Smart Links, Deferred Deep Linking, and QR Smart Codes — safely.

No proprietary SDK · No fingerprinting · Privacy-first

Create your first Smart Link in minutes

API integration, parameters, and error handling

Endpoints, parameters, and platform behavior.

Docs

Manage Links

Manage account links through the dashboard, authenticated REST API, or remote MCP server.

Dashboard

The Links module lists, searches, creates, edits, deletes, and opens statistics for account Smart Links.

ZipQuantum Links inventory containing three synthetic demonstration Smart Links
The demo inventory covers a routed product link, a limited offer and a QR entry point.
ZipQuantum analytics dashboard populated with synthetic demonstration sessions
Synthetic sessions make device, operating-system and link-performance views reproducible for documentation.

Public short addresses

An account-owned Smart Link can receive a plan-controlled https://zq.tn/s/{reference} address through /v1/short-links. Free uses automatic 10-character references and stops after 30 days or 30 redirects; Starter uses 6 characters or a custom alias; Pro uses 4 characters or a custom alias. Claiming a guest address preserves its exact reference, and served references are never reassigned.

Create through REST or MCP

Send exactly one source: an owned link_id, or destination_url plus supported Smart Link options. Destination mode creates the Smart Link and short address atomically and leaves no orphan on failure; both or neither sources return 422. The server chooses namespace, length, ownership, lifecycle and test classification.

State and metrics

Disable accepts only documented stable reason codes, never free-text URLs, destinations, tokens or personal data. redirects counts all human clicks; internal_redirects is the authenticated ZQ staff subset to exclude from campaign reporting. Namespace and viewer classifications are separate.

REST API

With X-Api-Key, use GET/POST /v1/links, GET/PATCH/DELETE /v1/links/{link}, link and account analytics, account usage, capabilities, and verified-domain discovery. Use GET/POST /v1/short-links plus its read, metadata, state, availability and metrics routes for public short addresses. The API returns only resources owned by the key’s account and enforces plan capabilities and quotas.

MCP for AI assistants

The remote Streamable HTTP endpoint is /mcp. Authentication uses OAuth 2.1 authorization code flow with PKCE: the client opens the ZipQuantum login and initial consent screen, so no API key is copied manually. After consent, an agent can act autonomously only inside the granted short_links:* scopes; a customer may opt into a stricter confirmation policy and can revoke or suspend the connection at any time. Laravel remains authoritative for namespace, allocation, ownership, lifecycle, current-plan permissions and destination safety. Caller-controlled is_test is rejected. Agents never permanently delete links: they disable or tombstone them, and the reference stays reserved.

Authentication

Users can review and revoke OAuth clients under AI assistant connections. Never expose API keys or OAuth tokens in a public client, URL, prompt, log, or source repository.

Get Started

Create your first ZipQuantum Smart Link in minutes — no proprietary SDK, no fingerprinting, and no attribution stack.

ZipQuantum links are install-aware by design.
They work before install, during install, and after install — using standard platform mechanisms only.

What You’ll Do Here

In this section, you’ll learn how to:

  • Create a Smart Link from the dashboard

  • Configure install-safe routing

  • Verify correct behavior across install states

  • Deploy links to production safely

No SDK integration is required.
No runtime interception.
No background services.

Prerequisites

Before you begin, make sure you have:

  • A ZipQuantum account

  • Access to your app’s App Store / Play Store listing

  • A destination URL or in-app route you want users to reach

That’s it.

Next Step

Create Your First Smart Link

This guide walks you through:

  • Creating a link

  • Testing install vs non-install behavior

  • Sharing it safely across channels