Preskočiť na obsah

Organizácie a workspaces

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-Keys

Organizations API

GET /v1/organizations

Vráti organizáciu, ku ktorej patrí aktuálny API-Key.

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

POST /v1/organizations

Vytvorí novú organizáciu.

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

Polia:

PoleTypPovinnéPopis
namestringZobrazovaný názov (max. 255 znakov)
slugstringURL-priateľský, unikátny (min. 2, max. 63 znakov, iba a-z0-9-)
billing_emailstringFakturačný e-mail

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

Soft-delete organizácie. Všetky prislúchajúce workspaces a QR kódy zostanú zachované, ale už nebudú prístupné.


Workspaces API

GET /v1/workspaces

Zoznam všetkých workspaceov organizácie.

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

POST /v1/workspaces

Vytvoriť nový workspace.

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

Polia:

PoleTypPredvolenéPopis
namestringZobrazovaný názov (povinné)
slugstringURL-priateľský, unikátny v rámci organizácie (povinné)
default_localestringdePredvolený jazyk
approval_requiredbooleanfalseAktivovať schvaľovací proces
primary_colorstringBrandingová farba (#RRGGBB)

Limity plánov:

PlánMax. počet workspaceov
Free1
Pro3
Business10
AgencyNeobmedzene

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

Archivuje workspace. Nemožno použiť na vlastný workspace.


Audit-Logs

GET /v1/audit-logs

Sledovateľný záznam všetkých zmien vo workspace.

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

Query parametre:

ParameterTypPopis
resource_typestringFiltrovať podľa prostriedku: codes, api_keys, webhooks, workspaces
resource_idstringFiltrovať podľa konkrétneho ID prostriedku
actionstringFiltrovať podľa akcie (napr. codes.created)
cursorstringPagination kurzor
limitintegerMax. 100 (predvolené: 50)

Príklad odpovede:

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