Getting started
Getting started
New to qr3.app? This overview walks you through the essentials in roughly five minutes — whether you want dynamic short links, QR analytics, or an EU Digital Product Passport.
Recommended path
- Introduction — What qr3.app is, which products exist (codes, DPPs, resolver, agent skills) and how the stack is put together.
- Quickstart —
curlsteps from the first API key to a working QR code, including a redirect check. - Authentication — Creating API keys, setting the workspace header, handling local secrets.
- SDKs, CLI & MCP — The TypeScript SDK, the CLI (
npx @qr3/cli) and the MCP server for AI agents.
Jump straight to your use case
Create a dynamic QR code POST /v1/codes, verify the redirect and see the first scan event.
Build a Digital Product Passport Battery, textile and the EU compliance validator over one API.
Print-ready QR assets (SVG/PDF/EPS) Vector PDF (RGB), SVG, PNG and EPS under /v1/codes/:id/qr.*
Wire up an AI agent (MCP) create_dpp_qr and other tools — directly from Claude, Cursor or Codex.
What to have on hand
- An account at app.qr3.app/sign-up (a free test workspace is included).
- An API key (Dashboard → Settings → API keys) in the form
qr3_sk_…. - For DPPs: a GTIN plus a serial or lot number. Without your own GTIN, use the built-in
BYO-GTINmode (see GS1 onboarding).
Help & references
- API reference — every endpoint with request/response examples.
- Interactive OpenAPI — run real calls right in the browser, token stays in the frontmatter.
- Error reference — RFC 7807 problem types with resolution hints.
- Changelog — public release notes for the API.