API Reference
API Reference
The qr3.app REST API is available at https://qr3.app/v1/ and follows the conventions described in the API overview (authentication via Authorization: Bearer, RFC 7807 error format, cursor pagination).
Getting started
API overview Versioning, request/response format, idempotency and pagination.
Authentication API keys, workspace header, test vs. live mode.
Error reference RFC 7807 error types with status codes and examples.
Interactive reference OpenAPI 3.1 + Scalar playground — plug in a token and run real calls.
Resource areas
QR codes Create, update and track dynamic & static codes with safe redirects.
Organizations & workspaces Accounts, workspaces, memberships and plan limits.
Webhooks Subscribe to events, verify signatures, inspect delivery logs.
MCP & agents Model Context Protocol — generate QR codes and DPPs from AI agents.
Privacy endpoints GDPR export, account deletion, IP hashing, consents.
Versioning & deprecation How new fields are introduced and what triggers breaking changes.
DPP-specific endpoints
All Digital Product Passport endpoints are documented under Digital Product Passport — including schema references for battery and textile, the EU compliance validator and the public GS1 resolver.
Base URLs per environment
| Environment | Base URL | Purpose |
|---|---|---|
| Production | https://qr3.app/v1/ | Public live API |
| Stage | https://qr3-api-stage.<account>.workers.dev/v1/ | Pre-production pilot (see ENVIRONMENTS.md) |
| Local | http://localhost:8787/v1/ | pnpm --filter api dev |
The OpenAPI specification is published at https://qr3.app/v1/openapi.json and is refreshed on every deploy.