Skip to main content

Creating an API Key

API keys let you authenticate requests to the ProLinksQR API without a user login. Each key belongs to your account and carries a set of scopes that determine which endpoints it can call.

Create a key in the dashboard​

  1. Sign in to your ProLinksQR dashboard.
  2. Open the API Keys page (top-right Developers menu → or go directly to /apikeys).
  3. Click Create API Key.
  4. Give the key a descriptive name (e.g. Zapier integration, CI bot).
  5. Select the scopes the key needs (see below). Grant the minimum required.
  6. Click Create.

:::warning Copy your key now The full key (it starts with key-) is shown only once, immediately after creation. Copy it and store it somewhere safe — a password manager or your app's secret store. After you close the dialog, only a masked version and a short prefix are visible, and you cannot recover the full key. If you lose it, delete the key and create a new one. :::

Choosing scopes​

Scopes follow a resource.action pattern. Grant only what your integration needs:

ScopeGrants
allFull access to every API-key endpoint.
links.readList and read links.
links.createCreate and duplicate links.
links.updateUpdate links and patch QR options.
links.deleteArchive/delete links.
links.pause / links.resumePause / resume links.
folders.read / folders.create / folders.update / folders.deleteManage folders.
templates.read / templates.create / templates.update / templates.deleteManage QR templates.
bulk.createBulk-generate links.
cafe.read / cafe.create / cafe.update / cafe.deleteManage Cafe (digital menu) resources.

A key with no matching scope for an endpoint receives a 403 Forbidden.

Managing keys​

From the API Keys page you can also:

  • View a key's name, short prefix, scopes, and created date.
  • Update a key's name, scopes, or active state.
  • Deactivate / delete a key. A deactivated or deleted key immediately stops authenticating — requests using it return 401 Unauthorized.

Next steps​

Head to Authentication to learn how to send your key with each request, then jump into the API Reference.