Organizácie a workspacy
Prehľad
qr3.app využíva dvojúrovňovú hierarchiu:
Organization (Firma/Agentur) └── Workspace 1 (Kunde A) └── Workspace 2 (Kunde B) └── Workspace 3 (Internes Team)- Organizácia — najvyššia úroveň, priradená k Stripe účtu a plánu
- Workspace — izolovaná oblasť pre QR kódy, skeny a API kľúče
Organizations API
GET /v1/organizations
Vráti organizáciu, ku ktorej patrí aktuálny API kľúč.
curl https://qr3.app/v1/organizations \ -H "Authorization: Bearer qr3_sk_..."GET /v1/organizations/usage
Vráti aktuálne využitie organizácie voči limitom plánu — sčítané za všetky workspacy a počítané naživo: scans pre aktuálny fakturačný mesiac (voči max_scans_per_month) a dynamic_codes, počet aktívnych dynamických kódov (voči max_dynamic_codes). Oba parametre nie sú pri dosiahnutí limitu nikdy blokované; tento endpoint využite na zobrazenie využitia a upozornenia na upgrade.
curl https://qr3.app/v1/organizations/usage \ -H "Authorization: Bearer qr3_sk_..."{ "data": { "scans": { "used": 4120, "limit": 5000, "usage_pct": 82, "remaining": 880, "period": "2026-06", "period_start": "2026-06-01T00:00:00.000Z" }, "dynamic_codes": { "used": 142, "limit": 500, "usage_pct": 28, "remaining": 358 } }}POST /v1/organizations
Vytvorí novú organizáciu.
curl -X POST https://qr3.app/v1/organizations \ -H "Authorization: Bearer qr3_sk_..." \ -H "Content-Type: application/json" \ -d '{ "name": "Digital Heroes GmbH", "slug": "digital-heroes", "billing_email": "[email protected]" }'Polia:
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ✅ | Zobrazovaný názov (max. 255 znakov) |
slug | string | ✅ | URL-priateľský, unikátny (min. 2, max. 63 znakov, iba a-z0-9-) |
billing_email | string | — | Fakturačný e-mail |
PATCH /v1/organizations/:id
curl -X PATCH https://qr3.app/v1/organizations/org_a1b2c3 \ -H "Authorization: Bearer qr3_sk_..." \ -H "Content-Type: application/json" \DELETE /v1/organizations/:id
Soft-delete (mäkké vymazanie) organizácie. Všetky prislúchajúce workspacy a QR kódy zostanú zachované, ale už nebudú prístupné.
Workspaces API
GET /v1/workspaces
Zoznam všetkých workspaceov danej organizácie.
curl https://qr3.app/v1/workspaces \ -H "Authorization: Bearer qr3_sk_..."POST /v1/workspaces
Vytvoriť nový workspace.
curl -X POST https://qr3.app/v1/workspaces \ -H "Authorization: Bearer qr3_sk_..." \ -H "Content-Type: application/json" \ -d '{ "name": "Kunde Bäckerei Schmidt", "slug": "baeckerei-schmidt", "default_locale": "de", "primary_color": "#8B4513", "approval_required": false }'Polia:
| Pole | Typ | Predvolené | Popis |
|---|---|---|---|
name | string | — | Zobrazovaný názov (povinné) |
slug | string | — | URL-priateľský, unikátny v rámci organizácie (povinné) |
default_locale | string | de | Predvolený jazyk |
approval_required | boolean | false | Aktivovať schvaľovací proces (workflow) |
primary_color | string | — | Brandingová farba (#RRGGBB) |
Limity plánov:
| Plán | Max. počet workspaceov |
|---|---|
| Free | 1 |
| Pro | 3 |
| Business | 10 |
| Agency | Neobmedzene |
PATCH /v1/workspaces/:id
curl -X PATCH https://qr3.app/v1/workspaces/ws_xyz789 \ -H "Authorization: Bearer qr3_sk_..." \ -H "Content-Type: application/json" \ -d '{ "name": "Neuer Name", "approval_required": true, "custom_domain": "qr.baeckerei-schmidt.de" }'DELETE /v1/workspaces/:id
Archivuje workspace. Nemožno použiť na vlastný workspace.
Audit-Logs
GET /v1/audit-logs
Sledovateľný záznam (audit log) všetkých zmien vo workspace.
curl "https://qr3.app/v1/audit-logs?resource_type=codes&limit=50" \ -H "Authorization: Bearer qr3_sk_..."Query parametre:
| Parameter | Typ | Popis |
|---|---|---|
resource_type | string | Filter podľa prostriedku (resource): codes, api_keys, webhooks, workspaces |
resource_id | string | Filter podľa konkrétneho ID prostriedku |
action | string | Filter podľa akcie (napr. codes.created) |
cursor | string | Kurzor stránkovania (pagination cursor) |
limit | integer | Max. 100 (predvolené: 50) |
Príklad odpovede (Response):
{ "data": [ { "id": "aud_a1b2c3", "actor_type": "api", "action": "codes.created", "resource_type": "codes", "resource_id": "qr_xyz123", "changes": {}, "created_at": "2026-03-15T10:00:00.000Z" } ]}