QR kódy pre vývojárov: REST API, SDK a CLI

Ako programovo generovať QR kódy, integrovať ich do svojej aplikácie a reagovať na skenovania cez webhooky — technický hĺbkový pohľad.

autor qr3.app Team

QR kódy pre vývojárov: REST API, SDK a CLI

Ako vývojár nechcete vytvárať QR kódy ručne cez dashboard — chcete ich generovať automaticky, integrovať do svojej build pipeline a reagovať na skenovania cez webhooky. Presne na to je qr3.app postavený.

Technologický stack

qr3.app je plne natívny pre Cloudflare:

  • API Worker: Hono na Cloudflare Workers (V8 runtime, nulové závislosti od Node.js)
  • Redirect Worker: ultra odľahčený worker, presmerovania s KV cache do < 5 ms p50
  • Databáza: Cloudflare D1 (SQLite) s multi-tenancy cez workspace_id
  • Queue: skenovacie udalosti oddelené cez Cloudflare Queues

Autentifikácia

Všetky API požiadavky vyžadujú Bearer token a ID workspace:

POST https://qr3.app/v1/codes
Authorization: Bearer qr3_sk_...
Content-Type: application/json

API kľúče si vytvoríte na app.qr3.app/dashboard/api-keys.

TypeScript SDK

npm install @qr3/sdk
# alebo
pnpm add @qr3/sdk
import { QR3 } from "@qr3/sdk";

const client = new QR3({
  apiKey: process.env.QR3_API_KEY!,
  workspaceId: process.env.QR3_WORKSPACE_ID!,
});

// Create a QR code
const { data: code } = await client.codes.create({
  type: "url",
  url: "https://my-shop.com/product/42",
  title: "Product 42",
  tags: ["shop", "product"],
});

console.log(code.short_code);       // "r7f3Kx"
console.log(code.image_svg_url);    // SVG image URL
console.log(code.redirect_url);     // https://qr3.app/r7f3Kx

// Change URL later (dynamic codes only)
await client.codes.update(code.id, {
  url: "https://my-shop.com/product/42-new",
});

// Query analytics
const stats = await client.codes.stats(code.id, {
  from: "2026-01-01",
  to: "2026-03-31",
});
console.log(stats.data.total_scans); // e.g. 1247

REST API priamo

Žiadna závislosť od SDK? REST API sa dá použiť priamo:

# Create a QR code
curl -X POST https://qr3.app/v1/codes \
  -H "Authorization: Bearer $QR3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "url",
    "url": "https://my-site.com",
    "title": "My Site",
    "is_dynamic": true
  }'

# List all QR codes
curl https://qr3.app/v1/codes?limit=20 \
  -H "Authorization: Bearer $QR3_API_KEY"

# Download QR code as SVG (with logo overlay)
curl "https://qr3.app/v1/codes/r7f3Kx/qr.svg?size=8&logo_url=https://mylogo.com/logo.png" \
  -o qrcode.svg

CLI

Pre skriptovanie a CI/CD je tu @qr3/cli:

npm install -g @qr3/cli
qr3 login

# Create QR code and save as SVG
qr3 codes create --url "https://my-site.com" --title "CI Deploy" --output qr.svg

# Batch creation from CSV
qr3 codes batch import urls.csv --format svg --output ./qr-codes/

Webhooky: reagujte na skenovania

Webhooky sú najsilnejšou funkciou: na každé skenovanie môžete reagovať v reálnom čase.

// Register a webhook
const { data: webhook } = await client.webhooks.create({
  url: "https://your-app.com/webhooks/qr3",
  events: ["scan.created", "code.updated"],
});

Webhook payload

{
  "event": "scan.created",
  "timestamp": "2026-03-15T14:30:00Z",
  "data": {
    "code_id": "code_abc123",
    "short_code": "r7f3Kx",
    "country": "DE",
    "city": "Berlin",
    "device": "mobile",
    "os": "iOS",
    "browser": "Safari"
  }
}

Overovanie webhookov (HMAC)

import { createHmac } from "crypto";

export async function verifyWebhook(
  payload: string,
  signature: string,
  secret: string,
): Promise<boolean> {
  const expected = createHmac("sha256", secret)
    .update(payload)
    .digest("hex");
  return `sha256=${expected}` === signature;
}

Obmedzovanie počtu požiadaviek (rate limiting)

Plán Kódy/deň API požiadavky/min
Free 10 60
Pro 100 300
Business 1 000 1 200
Enterprise Neobmedzene Na mieru

Hlavičky s rate limitom v každej odpovedi:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 247
X-RateLimit-Reset: 1710510060

Formát chýb (RFC 7807)

Všetky chyby sa riadia štandardom RFC 7807 Problem Details:

{
  "type": "https://docs.qr3.app/errors/validation",
  "title": "Validation Error",
  "status": 422,
  "detail": "url is required for type 'url'",
  "errors": [
    { "field": "url", "message": "Required" }
  ]
}

Záver

qr3.app je od základov postavený ako nástroj pre vývojárov: otvorené REST API, SDK s prístupom TypeScript-first, CLI, webhooky a kompletná OpenAPI dokumentácia. Pozrite si API dokumentáciu alebo začnite v Dashboarde.