Skip to content

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 számára

Organizations API

GET /v1/organizations

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

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

POST /v1/organizations

Létrehoz egy új szervezetet.

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

Mezők:

MezőTípusKötelezőLeírás
namestringMegjelenítendő név (max. 255 karakter)
slugstringURL-barát, egyedi (min. 2, max. 63 karakter, csak a-z0-9-)
billing_emailstringSzámlázási e-mail-cím

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

A szervezet szoft törlése (soft-delete). Minden kapcsolódó Workspace és QR-kód megmarad, de többé nem lesznek hozzáférhetők.


Workspaces API

GET /v1/workspaces

A szervezet összes Workspace-ének kilistázása.

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

POST /v1/workspaces

Új Workspace létrehozása.

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

Mezők:

MezőTípusAlapértelmezettLeírás
namestringMegjelenítendő név (kötelező)
slugstringURL-barát, szervezetenként egyedi (kötelező)
default_localestringdeAlapértelmezett nyelv
approval_requiredbooleanfalseJóváhagyási munkafolyamat aktiválása
primary_colorstringArculati szín (#RRGGBB)

Díjcsomag-korlátok:

DíjcsomagMax. Workspace-ek száma
Free1
Pro3
Business10
AgencyKorlátlan

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

Archiválja a Workspace-t. Nem alkalmazható a saját Workspace-re.


Audit-Logs

GET /v1/audit-logs

A Workspace-ben történt összes változás nyomon követhető naplója.

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

Query-paraméterek:

ParaméterTípusLeírás
resource_typestringSzűrés erőforrás szerint: codes, api_keys, webhooks, workspaces
resource_idstringSzűrés konkrét erőforrás-ID szerint
actionstringSzűrés művelet szerint (pl. codes.created)
cursorstringLapozási kurzor (Pagination-Cursor)
limitintegerMax. 100 (Alapértelmezett: 50)

Példa válasz:

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