QR kodai programuotojams: REST API, SDK ir CLI

Kaip programuotojas, jūs nenorite kurti QR kodų rankiniu būdu per valdymo skydelį — norite juos generuoti automatiškai, integruoti į savo kūrimo procesą ir reaguoti į nuskaitymus per webhooks. Būtent tam ir sukurtas qr3.app.

Technologijų rinkinys

qr3.app yra visiškai Cloudflare-native:

• API Worker: Hono ant Cloudflare Workers (V8 vykdymo aplinka, jokių Node.js priklausomybių)
• Redirect Worker: itin lengvas worker, KV talpykloje saugomos peradresavimai per < 5 ms p50
• Duomenų bazė: Cloudflare D1 (SQLite) su daugianuomininkyste per workspace_id
• Eilė: nuskaitymo įvykiai atsiejami per Cloudflare Queues

Autentifikacija

Visiems API užklausoms reikia Bearer prieigos rakto ir darbo srities ID:

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

Sukurkite API raktus adresu app.qr3.app/dashboard/api-keys.

TypeScript SDK

npm install @qr3/sdk
# arba
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 tiesiogiai

Nenorite SDK priklausomybės? REST API galima naudoti tiesiogiai:

# 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"

# Upload a logo — embedded automatically in SVG and PNG from here on
curl -X POST https://qr3.app/v1/codes/qr_abc123/logo \
  -H "Authorization: Bearer $QR3_API_KEY" \
  -F "[email protected]"

# Download QR code as SVG (now includes the logo)
curl "https://qr3.app/v1/codes/r7f3Kx/qr.svg?size=8" \
  -o qrcode.svg

CLI

Skriptams ir CI/CD yra @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/

Webhooks: reaguokite į nuskaitymus

Webhooks yra galingiausia funkcija: galite realiu laiku reaguoti į kiekvieną nuskaitymą.

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

Webhook naudingoji apkrova

{
  "id": "evt_4f0c2a91d7e84b3c9a1f",
  "type": "qr.scanned",
  "created": "2026-03-15T14:30:00.000Z",
  "data": {
    "code_id": "qr_abc123",
    "short_code": "r7f3Kx",
    "scanned_at": "2026-03-15T14:30:00.000Z",
    "country": "DE",
    "device_type": "mobile",
    "os": "iOS",
    "browser": "Safari",
    "language": "de",
    "ab_variant": null,
    "redirected_to": "https://example.com/landing"
  }
}

Webhooks tikrinimas (HMAC)

import { createHmac, timingSafeEqual } from "crypto";

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

Užklausų ribojimas

Kiekvienas API raktas gali siųsti 60 užklausų per minutę, taikant bet kurį planą. Kodų kūrimui taip pat taikomas dienos limitas vienai darbo sričiai, vienodas visiems planams: POST /v1/codes priima naujus kodus, kol tą dieną sukuriama 200 kodų, o POST /v1/codes/batch – iki 10 000.

Kiekviename autorizuotame atsakyme pateikiama X-RateLimit-Limit antraštė. 429 atsakyme papildomai nurodomas laikas, kada galima bandyti vėl:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1710510060
Retry-After: 60

Klaidų formatas (RFC 7807)

Visos klaidos atitinka 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" }
  ]
}

Išvada

qr3.app nuo pat pagrindų sukurtas kaip įrankis programuotojams: atviras REST API, TypeScript-first SDK, CLI, webhooks ir išsami OpenAPI dokumentacija. Peržiūrėkite API dokumentaciją arba pradėkite valdymo skydelyje.