Skip to main content

Using the QRForge API

The QRForge API lets software talk to QRForge directly. Your developer, or a tool such as an automation platform, can create and manage QR codes without anyone clicking in the app.

You do not need the API to use QRForge. Everything in this Help Center works in the app. The API is for connecting QRForge to your own systems.

What can the API do?​

Typical uses:

  • Create QR codes in bulk, for example one code per product in your shop or one per table in a restaurant chain.
  • Update destinations automatically, for example when a product page moves.
  • Read your projects and QR codes to show them in your own system.
  • Read a QR code's total scan count. Full scan analytics are not in the API yet; use the app and its CSV export for reports.

For the full and current list of what the API can do, see the developer portal.

What you need​

  1. A plan that includes the API. Pro includes 1 API key, Agency 3 and Enterprise unlimited. See Plans and what's included.
  2. An API key. It works like a password for software. See Manage API keys.
  3. Someone who can write a little code, or a tool that can send web requests.

How to get started​

  1. Create an API key: Subscription → Manage Plan → API Keys → Create key. Copy it straight away. It is shown only once.
  2. Give the key to your developer in a safe way, for example through a password manager. Do not send it by email or chat.
  3. Your developer follows the API quickstart on the developer portal.

Good to know​

  • Limits apply. Each plan allows a certain number of API requests per minute and per day. QR codes created through the API count towards your plan's QR code limit, just like codes created in the app. See Rate limits.
  • The API works on your whole account. Anything your key can do, anyone holding the key can do. Keep it secret.
  • Codes created by the API appear in the app, in the project they were created in.

Where to get help​

Troubleshooting​

I don't see API Keys Open Subscription, then the Manage Plan tab. The API Keys section is at the bottom.

My developer gets "too many requests" errors Your plan's request limit was reached. Ask your developer to slow down the requests, or consider a higher plan.

The key stopped working It may have been revoked. Check its Status under API Keys, and create a new key if needed.