Organizzazioni e Workspace
Panoramica
qr3.app utilizza una gerarchia a due livelli:
Organization (Firma/Agentur) └── Workspace 1 (Kunde A) └── Workspace 2 (Kunde B) └── Workspace 3 (Internes Team)- Organizzazione — livello superiore, associato a un account Stripe e a un piano
- Workspace — area isolata per codici QR, scansioni e API key
API Organizzazioni
GET /v1/organizations
Restituisce l’organizzazione a cui appartiene l’attuale API key.
curl https://qr3.app/v1/organizations \ -H "Authorization: Bearer qr3_sk_..."GET /v1/organizations/usage
Restituisce l’utilizzo in tempo reale dell’organizzazione rispetto ai limiti del piano — sommato su tutti i workspace e calcolato in tempo reale: scans per il mese di fatturazione corrente (rispetto a max_scans_per_month) e dynamic_codes, il numero di codici dinamici attivi (rispetto a max_dynamic_codes). Entrambi non vengono mai bloccati al raggiungimento del limite; utilizza questo endpoint per visualizzare l’utilizzo e mostrare avvisi di 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
Crea una nuova organizzazione.
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]" }'Campi:
| Campo | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
name | string | ✅ | Nome visualizzato (max. 255 caratteri) |
slug | string | ✅ | URL-friendly, univoco (min. 2, max. 63 caratteri, solo a-z0-9-) |
billing_email | string | — | Email di fatturazione |
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 dell’organizzazione. Tutti i workspace e i codici QR associati vengono conservati, ma non sono più accessibili.
API Workspace
GET /v1/workspaces
Elenca tutti i workspace dell’organizzazione.
curl https://qr3.app/v1/workspaces \ -H "Authorization: Bearer qr3_sk_..."POST /v1/workspaces
Crea un nuovo 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 }'Campi:
| Campo | Tipo | Predefinito | Descrizione |
|---|---|---|---|
name | string | — | Nome visualizzato (obbligatorio) |
slug | string | — | URL-friendly, univoco per organizzazione (obbligatorio) |
default_locale | string | de | Lingua predefinita |
approval_required | boolean | false | Attiva il flusso di approvazione |
primary_color | string | — | Colore del brand (#RRGGBB) |
Limiti del piano:
| Piano | Max. workspace |
|---|---|
| Free | 1 |
| Pro | 3 |
| Business | 10 |
| Agency | Illimitati |
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
Archivia il workspace. Non può essere applicato al proprio workspace.
Audit Log
GET /v1/audit-logs
Registro tracciabile di tutte le modifiche nel workspace.
curl "https://qr3.app/v1/audit-logs?resource_type=codes&limit=50" \ -H "Authorization: Bearer qr3_sk_..."Parametri di query:
| Parametro | Tipo | Descrizione |
|---|---|---|
resource_type | string | Filtra per risorsa: codes, api_keys, webhooks, workspaces |
resource_id | string | Filtra per ID risorsa specifico |
action | string | Filtra per azione (es. codes.created) |
cursor | string | Cursore di paginazione |
limit | integer | Max. 100 (predefinito: 50) |
Esempio di risposta:
{ "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" } ]}