Sari la conținut

Organizații & Spații de lucru

Prezentare generală

qr3.app utilizează o ierarhie pe două niveluri:

Organization (Firma/Agentur)
└── Workspace 1 (Kunde A)
└── Workspace 2 (Kunde B)
└── Workspace 3 (Internes Team)
  • Organizație — nivelul superior, asociat unui cont Stripe și unui plan
  • Workspace — zonă izolată pentru coduri QR, scanări și chei API

Organizations API

GET /v1/organizations

Returnează organizația de care aparține cheia API curentă.

Terminal window
curl https://qr3.app/v1/organizations \
-H "Authorization: Bearer qr3_sk_..."

GET /v1/organizations/usage

Returnează utilizarea în timp real a organizației în raport cu limitele planului — sumată pentru toate spațiile de lucru și calculată live: scans pentru luna de facturare curentă (în raport cu max_scans_per_month) și dynamic_codes, numărul de coduri dinamice active (în raport cu max_dynamic_codes). Niciuna dintre acestea nu este blocată la atingerea limitei; utilizează acest endpoint pentru afișarea utilizării și notificări de upgrade.

Terminal window
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

Creează o organizație nouă.

Terminal window
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]"
}'

Câmpuri:

CâmpTipObligatoriuDescriere
namestring✅Nume afișat (max. 255 caractere)
slugstring✅Prietenos cu URL-ul, unic (min. 2, max. 63 caractere, doar a-z0-9-)
billing_emailstring—E-mail de facturare

PATCH /v1/organizations/:id

Modifică numele, adresa de e-mail pentru facturare și adresa de e-mail pentru notificări ale organizației.

Le poate modifica doar un org_admin, într-o sesiune Dashboard. Cererile autentificate cu o cheie API sunt respinse cu 403 — inclusiv cheile qr3_sk_ și qr3_test_sk_ —, astfel încât o cheie compromisă nu poate redirecționa adresa de facturare sau de notificări.

DELETE /v1/organizations/:id

Ștergere logică (Soft-Delete) a organizației. Toate spațiile de lucru și codurile QR asociate sunt păstrate, dar nu mai sunt accesibile.

Necesită rolul org_admin (sesiune Dashboard). Cererile autentificate doar cu o cheie API sunt respinse cu 403 — cheile API nu dețin niciodată un rol de administrator, astfel încât o cheie compromisă nu poate șterge organizația.


Workspaces API

GET /v1/workspaces

Listează spațiile de lucru (workspaces) vizibile pentru apelant: org_admin și proprietarul organizației văd toate spațiile de lucru ale organizației, ceilalți membri doar spațiile de lucru din care fac parte, iar o cheie API doar propriul spațiu de lucru. Un spațiu de lucru pe care apelantul nu îl vede răspunde cu 404 pe fiecare rută /v1/workspaces/:id, exact ca un ID necunoscut.

Terminal window
curl https://qr3.app/v1/workspaces \
-H "Authorization: Bearer qr3_sk_..."

POST /v1/workspaces

Creează un spațiu de lucru nou.

Terminal window
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
}'

Cu o cheie API, un spațiu de lucru poate fi creat doar de o cheie creată de un org_admin sau de proprietarul organizației; orice altă cheie primește 403, chiar înainte de verificarea slug-ului (răspunsul nu dezvăluie, așadar, ce slug-uri sunt ocupate). Rolul persoanei care a creat cheia este verificat la fiecare cerere: dacă este retrogradată, cheia își pierde dreptul. O cheie API este legată de propriul spațiu de lucru și nu îl vede apoi pe cel nou: id-ul acestuia se află în răspunsul 201; un org_admin îl deschide în Dashboard și poate crea acolo o cheie pentru el. În Dashboard, doar un org_admin poate crea spații de lucru.

Câmpuri:

CâmpTipImplicitDescriere
namestring—Nume afișat (obligatoriu)
slugstring—Prietenos cu URL-ul, unic per organizație (obligatoriu)
default_localestringdeLimba implicită
approval_requiredbooleanfalseRezervat pentru fluxul de aprobare planificat (neimplementat)
primary_colorstring—Culoare de branding (#RRGGBB)

Limite plan:

PlanNumăr maxim de Workspaces
Free1
Pro1
Business10
Agency50
Enterprise500

PATCH /v1/workspaces/:id

Terminal window
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
}'

DELETE /v1/workspaces/:id

Arhivează spațiul de lucru. Nu poate fi aplicat asupra propriului spațiu de lucru.

Necesită org_admin sau ws_admin al spațiului de lucru care urmează să fie arhivat; celelalte roluri primesc 403. Un spațiu de lucru pe care apelantul nu îl vede răspunde cu 404 — pentru o cheie API, acesta este orice spațiu de lucru în afară de al ei, pe care nu îl poate arhiva nici pe acesta.


Audit-Logs

GET /v1/audit-logs

Istoric trasabil al tuturor modificărilor din spațiul de lucru.

Terminal window
curl "https://qr3.app/v1/audit-logs?resource_type=codes&limit=50" \
-H "Authorization: Bearer qr3_sk_..."

Parametri Query:

ParametruTipDescriere
resource_typestringFiltrare după resursă: codes, api_keys, webhooks, workspaces
resource_idstringFiltrare după un ID de resursă specific
actionstringFiltrare după acțiune (de ex. codes.created)
cursorstringCursor de paginare
limitintegerMax. 100 (implicit: 50)

Exemplu de răspuns:

{
"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"
}
]
}