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

Authentication

Select the credential required by each current ZipQuantum endpoint.

User API key

Send X-Api-Key to authenticated link and domain endpoints. The key belongs to one account and inherits that account’s plan and ownership.

curl 'https://a.zq.tn/api/v1/custom-domains' \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: YOUR_API_KEY'

MCP OAuth

Do not paste an API key into an MCP client. It uses OAuth 2.1 with PKCE, sends the user through ZipQuantum login and consent, and receives a token restricted to https://a.zq.tn/mcp and the mcp scope. Users can revoke it from AI assistant connections.

Internal secret

X-Api-Secret protects administrative /v1 operations. It must remain on trusted servers and is not part of the customer API contract.

Public endpoints

Availability checks, public catalogue, anonymous creation, and public platform settings do not require a user key, but still validate input and may be rate- or feature-limited.

Rotation and revocation

Regenerate a user API key only when necessary. Revoke an MCP connection when it is no longer trusted. Never include credentials in URLs, logs, screenshots, prompts, browser JavaScript, or mobile bundles.

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