Szervezetek és munkaterületek

Áttekintés

A qr3.app kétszintű hierarchiát használ:

Organization (Firma/Agentur)
  └── Workspace 1 (Kunde A)
  └── Workspace 2 (Kunde B)
  └── Workspace 3 (Internes Team)

Szervezet (Organization) — a legfelső szint, amely egy Stripe-fiókhoz és díjcsomaghoz (Plan) kapcsolódik
Munkaterület (Workspace) — izolált terület a QR-kódok, beolvasások (scans) és API-kulcsok (API-Keys) számára

Organizations API

`GET /v1/organizations`

Visszaadja azt a szervezetet, amelyhez az aktuális API-kulcs tartozik.

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

`GET /v1/organizations/usage`

Visszaadja a szervezet élő használati adatait a díjcsomag-korlátokhoz (Plan-Limits) képest — az összes munkaterületre összesítve és élőben kiszámítva: scans az aktuális számlázási hónapra vonatkozóan (a max_scans_per_month értékkel szemben) és dynamic_codes, az aktív dinamikus kódok száma (a max_dynamic_codes értékkel szemben). Egyik sem kerül blokkolásra a limit elérésekor; használd ezt a végpontot a használati adatok megjelenítésére és a frissítési (upgrade) figyelmeztetésekhez.

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`

Új szervezet létrehozása.

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

Mezők:

Mező	Típus	Kötelező	Leírás
`name`	string	✅	Megjelenítendő név (max. 255 karakter)
`slug`	string	✅	URL-barát, egyedi (min. 2, max. 63 karakter, csak `a-z0-9-`)
`billing_email`	string	—	Számlázási e-mail-cím

`PATCH /v1/organizations/:id`

Módosítja a szervezet nevét, számlázási e-mail-címét és értesítési e-mail-címét.

Ezeket csak egy org_admin módosíthatja, Dashboard-munkamenetben. Az API-kulccsal indított kérések 403 hibával elutasításra kerülnek — a qr3_sk_ és qr3_test_sk_ kulcsok is —, így egy kiszivárgott kulcs nem tudja átirányítani a számlázási vagy értesítési címet.

`DELETE /v1/organizations/:id`

A szervezet szoft törlése (Soft-Delete). Minden kapcsolódó munkaterület és QR-kód megmarad, de többé nem lesznek elérhetők.

Az org_admin szerepkört igényli (Dashboard-munkamenet). A tisztán API-kulccsal indított kérések 403 hibával elutasításra kerülnek — az API-kulcsok soha nem kapnak adminisztrátori szerepkört, így egy kiszivárgott kulcs nem tudja törölni a szervezetet.

Workspaces API

`GET /v1/workspaces`

A hívó számára látható munkaterületek listázása: az org_admin és a szervezet tulajdonosa a szervezet összes munkaterületét látja, a többi tag csak azokat a munkaterületeket, amelyekhez tartozik, egy API-kulcs pedig csak a saját munkaterületét. Az a munkaterület, amelyet a hívó nem lát, minden /v1/workspaces/:id útvonalon 404-gyel válaszol, pontosan úgy, mint egy ismeretlen azonosító.

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

`POST /v1/workspaces`

Új munkaterület létrehozása.

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

API-kulccsal munkaterületet csak olyan kulcs hozhat létre, amelyet egy org_admin vagy a szervezet tulajdonosa hozott létre; minden más kulcs 403-at kap, még a slug ellenőrzése előtt (a válasz tehát nem árulja el, mely slugok foglaltak). A kulcsot létrehozó személy szerepköre minden kérésnél ellenőrzésre kerül: ha visszaminősítik, a kulcsa elveszíti ezt a jogot. Az API-kulcs a saját munkaterületéhez kötött, és utána nem látja az újat: annak id-ja a 201-es válaszban szerepel; egy org_admin megnyitja a Dashboardon, és ott kulcsot hozhat létre hozzá. A Dashboardon munkaterületet csak org_admin hozhat létre.

Mezők:

Mező	Típus	Alapértelmezett	Leírás
`name`	string	—	Megjelenítendő név (kötelező)
`slug`	string	—	URL-barát, szervezeten belül egyedi (kötelező)
`default_locale`	string	`de`	Alapértelmezett nyelv
`approval_required`	boolean	`false`	A tervezett jóváhagyási munkafolyamat számára fenntartva (nincs megvalósítva)
`primary_color`	string	—	Arculati szín (`#RRGGBB`)

Díjcsomag-korlátok (Plan-Limits):

Díjcsomag	Max. munkaterület
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`

Archiválja a munkaterületet. Nem alkalmazható a saját munkaterületre.

Az archiválandó munkaterülethez tartozó org_admin vagy ws_admin szerepkört igényli; a többi szerepkör 403 választ kap. Az a munkaterület, amelyet a hívó nem lát, 404-gyel válaszol — egy API-kulcs esetében ez minden munkaterület a sajátján kívül, amelyet szintén nem archiválhat.

Audit-Logs

`GET /v1/audit-logs`

A munkaterületen végrehajtott összes változás visszakövethető naplója.

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

Lekérdezési paraméterek (Query-Parameter):

Paraméter	Típus	Leírás
`resource_type`	string	Szűrés erőforrás szerint: `codes`, `api_keys`, `webhooks`, `workspaces`
`resource_id`	string	Szűrés konkrét erőforrás-azonosító (ID) szerint
`action`	string	Szűrés művelet szerint (pl. `codes.created`)
`cursor`	string	Lapozási kurzor (Pagination-Cursor)
`limit`	integer	Max. 100 (alapértelmezett: 50)

Példa válasz (Response):

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