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; utilizați 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
namestringNume afișat (max. 255 caractere)
slugstringPrietenos cu URL-ul, unic (min. 2, max. 63 caractere, doar a-z0-9-)
billing_emailstringE-mail de facturare

PATCH /v1/organizations/:id

Terminal window
curl -X PATCH https://qr3.app/v1/organizations/org_a1b2c3 \
-H "Authorization: Bearer qr3_sk_..." \
-H "Content-Type: application/json" \
-d '{ "name": "Digital Heroes AG", "billing_email": "[email protected]" }'

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.


Workspaces API

GET /v1/workspaces

Listează toate spațiile de lucru (workspaces) ale organizației.

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

Câmpuri:

CâmpTipImplicitDescriere
namestringNume afișat (obligatoriu)
slugstringPrietenos cu URL-ul, unic per organizație (obligatoriu)
default_localestringdeLimba implicită
approval_requiredbooleanfalseActivează fluxul de lucru pentru aprobare
primary_colorstringCuloare de branding (#RRGGBB)

Limite plan:

PlanNumăr maxim de Workspaces
Free1
Pro3
Business10
AgencyNelimitat

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,
"custom_domain": "qr.baeckerei-schmidt.de"
}'

DELETE /v1/workspaces/:id

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


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