Documentation

Quickstart

Create an account, add an app, configure iOS and make your first authenticated API call. About ten minutes.

This gets you from nothing to an authenticated API call. Everything on this page works today.

1. Create an account

Sign up at /signup with an email address and a password of at least twelve characters. There are no rules about capitals or symbols — length and not being on a list of known passwords is what is asked for, which is current NCSC and NIST guidance.

You will be sent a confirmation link. Opening it confirms the address and sends you to sign in; it does not sign you in by itself, because a link that arrives by email and hands out a session is a session available to anybody who can read the inbox.

2. Add an app

An app is one mobile application. Creating one allocates it a five character host of its own, permanently:

Your app's link hosthttp

71k8c.qbrt.app

That host is never reused, even if you delete the app. Links printed on physical things outlive the accounts that made them, so recycling a host would mean somebody else’s links resolving into your app.

3. Enter your iOS details

On the app’s iOS settings page:

Bundle identifier — reverse-DNS, such as com.northwind.retail. In Xcode under Signing & Capabilities.
Apple Team ID — exactly ten letters and digits. Top right of the Apple Developer portal, under Membership details.
URI scheme and App Store details — optional.

Two organisations claiming the same bundle identifier is allowed — it happens legitimately, for example when an agency and a client both have an account — but it is recorded in the audit log, because it is also what impersonation would look like.

4. Create an API key

Keys live on the app’s API keys page. Check the live/test switch in the bar at the top first: a key belongs to one app and one environment and cannot be moved between them.

The key is shown once. We store a hash and a short display prefix, so there is no mechanism by which we could show it again — which is what the rotate button is for.

Your first authenticated callbash

curl https://app.quberoute.com/api/v1/app \
  -H "Authorization: Bearer qr_sk_test_YOUR_KEY"

{
  "app": {
    "id": "0d6f1a3c-2f4b-4c8e-9a1d-7b2c6e5f0a11",
    "name": "Northwind Retail",
    "subdomainKey": "71k8c",
    "linkHost": "71k8c.qbrt.app"
  },
  "environment": "test"
}

If this returns your app, everything is wired up correctly.

5. What comes next

Read iOS universal links setup for the Apple side: the association file, the entitlement, and handling the incoming URL in your app.

The honest gap

Not built yet. You cannot create a link yet. Link creation and the redirect service are the next thing being built, so today you can register an app, configure it and authenticate against it — but not yet make a link with it. The changelog is where that will be announced.

Ask the documentation

It answers from these pages only, and links what it used. If the answer is not here it says so rather than guessing — then email [email protected].

← All documentation