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íč.

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.

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.

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:

Pole	Typ	Povinné	Popis
`name`	string	✅	Zobrazované jméno (max. 255 znaků)
`slug`	string	✅	URL-friendly, unikátní (min. 2, max. 63 znaků, pouze `a-z0-9-`)
`billing_email`	string	—	Fakturační e-mail

`PATCH /v1/organizations/:id`

Mění název, fakturační e-mail a e-mail pro oznámení organizace.

Měnit je může pouze org_admin v relaci v Dashboardu. Požadavky s API klíčem jsou odmítnuty s 403 — včetně klíčů qr3_sk_ a qr3_test_sk_ —, takže uniklý klíč nemůže přesměrovat fakturační adresu ani adresu pro oznámení.

`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é.

Vyžaduje roli org_admin (relace v Dashboardu). Požadavky s pouhým API klíčem jsou odmítnuty s 403 — API klíče nikdy nezískají roli administrátora, takže uniklý klíč nemůže organizaci smazat.

Workspaces API

`GET /v1/workspaces`

Vypíše workspacy viditelné pro volajícího: org_admin a vlastník organizace vidí všechny workspacy organizace, ostatní členové jen workspacy, do kterých patří, a API klíč jen svůj vlastní workspace. Workspace, který volající nevidí, odpovídá na každé cestě /v1/workspaces/:id kódem 404, stejně jako neznámé ID.

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

`POST /v1/workspaces`

Vytvoří nový 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
  }'

S API klíčem smí workspace vytvořit jen klíč, který vytvořil org_admin nebo vlastník organizace; každý jiný klíč dostane 403, ještě před kontrolou slugu (odpověď tedy neprozradí, které slugy jsou obsazené). Role tvůrce se kontroluje při každém požadavku: pokud je tvůrce degradován, jeho klíč toto právo ztratí. API klíč je vázán na svůj vlastní workspace a nový workspace potom nevidí: jeho id je v odpovědi 201; org_admin ho otevře v Dashboardu a může pro něj tam vytvořit klíč. V Dashboardu smí workspacy vytvářet jen org_admin.

Pole:

Pole	Typ	Výchozí	Popis
`name`	string	—	Zobrazované jméno (povinné)
`slug`	string	—	URL-friendly, unikátní v rámci organizace (povinné)
`default_locale`	string	`de`	Výchozí jazyk
`approval_required`	boolean	`false`	Vyhrazeno pro plánovaný schvalovací proces (není implementován)
`primary_color`	string	—	Barva brandu (`#RRGGBB`)

Limity tarifů:

Tarif	Max. počet workspaců
Free	1
Pro	1
Business	10
Agency	50
Enterprise	500

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

`DELETE /v1/workspaces/:id`

Archivuje workspace. Nelze použít na vlastní workspace.

Vyžaduje roli org_admin nebo ws_admin archivovaného workspace; ostatní role dostanou 403. Workspace, který volající nevidí, odpovídá kódem 404 — pro API klíč je to každý workspace kromě vlastního, který archivovat také nemůže.

Auditní záznamy

`GET /v1/audit-logs`

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

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

Query parametry:

Parametr	Typ	Popis
`resource_type`	string	Filtr podle prostředku: `codes`, `api_keys`, `webhooks`, `workspaces`
`resource_id`	string	Filtr podle konkrétního ID prostředku
`action`	string	Filtr podle akce (např. `codes.created`)
`cursor`	string	Kurzory pro stránkování (Pagination cursor)
`limit`	integer	Max. 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"
    }
  ]
}