Organizacijos ir darbo sritys

Apžvalga

qr3.app naudoja dviejų lygių hierarchiją:

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

Organizacija — aukščiausias lygis, susietas su Stripe paskyra ir planu
Workspace (darbo sritis) — izoliuota sritis QR kodams, nuskaitymams ir API raktams

Organizacijų API

`GET /v1/organizations`

Grąžina organizaciją, kuriai priklauso dabartinis API raktas.

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

`GET /v1/organizations/usage`

Grąžina tiesioginį organizacijos išteklių naudojimą pagal plano ribas — sumuojamą per visas darbo sritis (Workspaces) ir skaičiuojamą realiuoju laiku: scans einamajam atsiskaitymo mėnesiui (lyginant su max_scans_per_month) und dynamic_codes — aktyvių dinaminių kodų skaičių (lyginant su max_dynamic_codes). Abu rodikliai niekada nėra blokuojami pasiekus ribą; naudokite šį pabaigos tašką (endpoint) naudojimo rodymui ir pranešimams apie plano atnaujinimą.

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`

Sukuria naują organizaciją.

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

Laukai:

Laukas	Tipas	Privalomas	Aprašymas
`name`	string	✅	Rodomas pavadinimas (maks. 255 simboliai)
`slug`	string	✅	Draugiškas URL adresui, unikalus (min. 2, maks. 63 simboliai, tik `a-z0-9-`)
`billing_email`	string	—	Sąskaitų faktūrų el. paštas

`PATCH /v1/organizations/:id`

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`

Logiškai ištrina (soft-delete) organizaciją. Visos susijusios darbo sritys (Workspaces) ir QR kodai išlieka, tačiau tampa nepasiekiami.

Darbo sričių API

`GET /v1/workspaces`

Išvardija visas organizacijos darbo sritis (Workspaces).

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

`POST /v1/workspaces`

Sukuria naują darbo sritį (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
  }'

Laukai:

Laukas	Tipas	Numatytasis	Aprašymas
`name`	string	—	Rodomas pavadinimas (privalomas)
`slug`	string	—	Draugiškas URL adresui, unikalus organizacijoje (privalomas)
`default_locale`	string	`de`	Numatytoji kalba
`approval_required`	boolean	`false`	Įjungti patvirtinimo darbo eigą (approval workflow)
`primary_color`	string	—	Prekių ženklo spalva (`#RRGGBB`)

Plano ribos:

Planas	Maks. darbo sričių
Free	1
Pro	3
Business	10
Agency	Neribota

`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,
    "custom_domain": "qr.baeckerei-schmidt.de"
  }'

`DELETE /v1/workspaces/:id`

Archyvuoja darbo sritį (Workspace). Negali būti taikoma savo pačių darbo sričiai.

Audito žurnalai

`GET /v1/audit-logs`

Atsekamas visų darbo srities (Workspace) pakeitimų žurnalas.

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

Užklausos parametrai:

Parametras	Tipas	Aprašymas
`resource_type`	string	Filtruoti pagal išteklių: `codes`, `api_keys`, `webhooks`, `workspaces`
`resource_id`	string	Filtruoti pagal konkretų ištekliaus ID
`action`	string	Filtruoti pagal veiksmą (pvz., `codes.created`)
`cursor`	string	Puslapiavimo žymeklis (pagination cursor)
`limit`	integer	Maks. 100 (numatytasis: 50)

Atsakymo pavyzdys (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"
    }
  ]
}