Přeskočit na obsah

Organizace a workspaces

Přehled

qr3.app využívá dvoustupňovou hierarchií:

Organization (Firma/Agentur)
└── Workspace 1 (Kunde A)
└── Workspace 2 (Kunde B)
└── Workspace 3 (Internes Team)
  • Organizace — nejvyšší úroveň, přidružená k účtu Stripe a tarifu
  • Workspace — izolovaná oblast pro QR kódy, skeny a API klíče

Organizations API

GET /v1/organizations

Vrací organizaci, ke které patří aktuální API klíč.

Terminál
curl https://qr3.app/v1/organizations \
-H "Authorization: Bearer qr3_sk_..."

GET /v1/organizations/usage

Vrací aktuální využití organizace vůči limitům tarifu — sečtené za všechny workspacy a počítané v reálném čase: scans pro aktuální zúčtovací měsíc (vůči max_scans_per_month) a dynamic_codes, počet aktivních dynamických kódů (vůči max_dynamic_codes). Žádný z těchto limitů nikdy neblokuje provoz; tento koncový bod použijte pro zobrazení využití a upozornění na upgrade.

Terminál
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

Vytvoří novou organizaci.

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

Pole:

PoleTypPovinnéPopis
namestringZobrazované jméno (max. 255 znaků)
slugstringURL-friendly, unikátní (min. 2, max. 63 znaků, pouze a-z0-9-)
billing_emailstringFakturační e-mail

PATCH /v1/organizations/:id

Terminál
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 (měkké smazání) organizace. Všechny přidružené workspacy a QR kódy zůstanou zachovány, ale již nebudou přístupné.


Workspaces API

GET /v1/workspaces

Vypíše všechny workspacy v organizaci.

Terminál
curl https://qr3.app/v1/workspaces \
-H "Authorization: Bearer qr3_sk_..."

POST /v1/workspaces

Vytvoří nový workspace.

Terminál
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
}'

Pole:

PoleTypVýchozíPopis
namestringZobrazované jméno (povinné)
slugstringURL-friendly, unikátní v rámci organizace (povinné)
default_localestringdeVýchozí jazyk
approval_requiredbooleanfalseAktivovat schvalovací proces (workflow)
primary_colorstringBarva brandu (#RRGGBB)

Limity tarifů:

TarifMax. počet workspaců
Free1
Pro3
Business10
AgencyNeomezeně

PATCH /v1/workspaces/:id

Terminál
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. Nelze použít na vlastní workspace.


Auditní záznamy

GET /v1/audit-logs

Auditovatelný záznam všech změn ve workspace.

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

Query parametry:

ParametrTypPopis
resource_typestringFiltr podle prostředku: codes, api_keys, webhooks, workspaces
resource_idstringFiltr podle konkrétního ID prostředku
actionstringFiltr podle akce (např. codes.created)
cursorstringKurzory pro stránkování (Pagination cursor)
limitintegerMax. 100 (výchozí: 50)

Příklad odpovědi:

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