Skip to content
QubeRoute
Sign inCreate an account

Documentation

Documentation

How the SDK, the links and the attribution report work, with the code to paste and the figures to check it against.

npm install @quberoute/sdk

Version 0.2.2, on npm. MIT licensed.

Getting started

  • Every language and framework

    Capacitor, Ionic, Cordova, React Native, Flutter, native Swift, native Kotlin and the web. For each: whether the SDK covers it, what you write, and what you do yourself.

  • Quickstart

    Install the SDK and handle an incoming link on Capacitor, Cordova, React Native, Flutter or the web. The shared path is identical; only the framework step differs.

  • Live and test environments

    How the two environments are kept apart, and why it is enforced by the shape of an API key rather than by a filter.

iOS

  • iOS universal links setup

    What a universal link is, the association file iOS fetches, the entitlement your app needs, and how to handle the incoming URL.

Android

  • Android setup

    App Links, the assetlinks.json file Google fetches, why you need every signing certificate rather than one, and the deterministic install match that iOS cannot do.

The SDK

  • Capacitor, in depth

    The Capacitor path in full, once the quickstart has you running. The plugin it reads, what happens on a cold start, and what to check first.

  • Deferred matching, and how well it works

    What happens when somebody installs your app from a link — and the measured match and false positive rates, including the bad case.

  • Clipboard matching

    Exact deferred attribution, at the cost of a visible paste banner on iOS. What your users see, and what it is worth.

  • Testing it before you ship

    Prove a deferred install is matched to the right link BEFORE your app reaches the App Store — through TestFlight and through a local build — with a live view of every click and match as it happens.

  • When it does not work

    Every failure state, what it means, and what to do about it. Including the Apple caching delay that makes a correct setup look broken for up to 24 hours.

  • What to declare in your privacy manifest

    Exactly what the SDK collects, what that means for your App Store submission, and how to handle an erasure request.

  • Versioning and the stability guarantee

    What we will never change inside a major version, how long a version is supported, and how you find out. The promise a shipped app depends on.

  • Cordova, React Native, Flutter and the web

    Cordova and React Native use the same package by a different route; Flutter has no Dart package and uses the REST API instead; and web is what the SDK does in a browser today.

  • Native Swift, Kotlin and Dart, without the SDK

    There is no package for these languages and the product works. The two calls the SDK makes, written out in Swift, Kotlin and Dart, plus the deferred first-launch sequence you would build yourself.

API

  • API reference

    Authentication, the endpoints that exist today, and the error responses you should expect.

  • Webhooks

    Being told when something happens, rather than polling for it. Signature verification with working code, the retry schedule, and the replayable delivery log.

Accounts

Something missing or wrong? Write to [email protected].