Skip to main content

Changelog

This document provides a versioned summary of all public API updates for QRForge.
Only production‑ready, developer‑facing changes are listed here.

2025‑11‑14 — API v1 (Initial Public Release)​

New Endpoints​

  • POST /v1/qr-codes
    Create a new QR code programmatically.

    • GET /v1/qr-codes/{id}
      Retrieve a QR code by its document ID.

  • GET /v1/qr-codes/by-slug
    Retrieve a QR code using its public slug.

  • GET /v1/qr-codes
    List QR codes with pagination and filtering.

    • PATCH /v1/qr-codes/{id}
      Update QR label or redirect URL (with secure field‑level controls).

  • POST /v1/projects
    Create a new project.

  • GET /v1/projects
    List all accessible projects with pagination.

Core Features​

  • Secure API Key authentication using x-api-key.
  • Per‑user quota metering (minute/day API rate limits).
  • Strong ownership checks (QR and project scoping).
  • Integration with QRForge Rendering Pipeline (Cloud Run).
  • Slug‑based QR retrieval.
  • Immutable audit trail for created_via and timestamps.

2025‑11‑20 — Developer Portal Enhancements​

  • Fully documented API reference for v1.
  • Added topics:
    • Authentication
    • Projects
    • QR Codes
    • Pagination
    • Rate Limits
    • Errors
    • API Keys
    • Analytics (v1 reality + v2 roadmap)

Upcoming in v2​

(Estimated Q1 2026 — subject to change)

Planned Additions​

  • Analytics Export API
    Generate downloadable CSV/JSON exports powered by BigQuery.

  • Webhook System
    Events: qr.scan, qr.updated, project.updated, more.

  • OAuth2 Client Credentials (Enterprise tier)
    Machine‑to‑machine secure authentication.

  • QR Templates API
    Create/update style presets for batch QR creation.

  • Bulk Operations API
    Batch create and batch update QR codes.

If you need a versioned OpenAPI spec section here as well, I can add it.