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
Darbo sritis (Workspace) – izoliuota sritis QR kodams, nuskaitymams ir API raktams

Organizations 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ą, palyginti su plano ribomis – sumuojama per visas darbo sritis ir skaičiuojama realiuoju laiku: scans einamajam atsiskaitymo mėnesiui (palyginti su max_scans_per_month) ir dynamic_codes – aktyvių dinaminių kodų skaičių (palyginti su max_dynamic_codes). Pasiekus ribą, nei vienas iš jų nėra blokuojamas; naudokite šį galinį 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`

Keičia organizacijos pavadinimą, sąskaitų el. pašto adresą ir pranešimų el. pašto adresą.

Juos gali keisti tik org_admin valdymo skydelio sesijoje. Užklausos su API raktu atmetamos su 403 — taip pat ir su qr3_sk_ bei qr3_test_sk_ raktais —, todėl nutekėjęs raktas negali nukreipti sąskaitų ar pranešimų adreso kitur.

`DELETE /v1/organizations/:id`

Švelnus organizacijos ištrynimas (Soft-Delete). Visos susijusios darbo sritys ir QR kodai išlieka, tačiau tampa nepasiekiami.

Reikalauja org_admin vaidmens (valdymo skydelio sesijos). Užklausos, pateiktos tik su API raktu, yra atmetamos su 403 — API raktai niekada neįgyja administratoriaus vaidmens, todėl nutekėjęs raktas negali ištrinti organizacijos.

Workspaces API

`GET /v1/workspaces`

Išvardyti kviečiančiajam matomas darbo sritis: org_admin ir organizacijos savininkas mato visas organizacijos darbo sritis, kiti nariai tik tas darbo sritis, kurioms priklauso, o API raktas tik savo darbo sritį. Darbo sritis, kurios kviečiantysis nemato, kiekviename maršrute /v1/workspaces/:id atsako 404, lygiai kaip nežinomas ID.

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

`POST /v1/workspaces`

Sukurti naują darbo sritį.

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

Su API raktu darbo sritį gali sukurti tik raktas, kurį sukūrė org_admin arba organizacijos savininkas; bet kuris kitas raktas gauna 403 dar prieš tikrinant slug (atsakymas neatskleidžia, kurie slug jau užimti). Rakto kūrėjo vaidmuo tikrinamas kiekvienos užklausos metu: jei jis pažeminamas, jo raktas netenka šios teisės. API raktas susietas su savo darbo sritimi ir naujos vėliau nemato: jos id yra atsakyme 201; org_admin ją atidaro valdymo skydelyje ir ten gali sukurti jai raktą. Valdymo skydelyje darbo sritis gali kurti tik org_admin.

Laukai:

Laukas	Tipas	Numatytoji reikšmė	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`	Rezervuota planuojamai patvirtinimo darbo eigai (neįgyvendinta)
`primary_color`	string	—	Prekės ženklo spalva (`#RRGGBB`)

Plano ribos:

Planas	Maks. darbo sričių skaičius
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`

Archyvuoja darbo sritį. Negalima pritaikyti savo paties darbo sričiai.

Reikalauja org_admin arba archyvuojamos darbo srities ws_admin vaidmens; kiti vaidmenys gauna 403. Darbo sritis, kurios kviečiantysis nemato, atsako 404 — API raktui tai yra bet kuri darbo sritis, išskyrus jo paties darbo sritį, kurios jis taip pat negali archyvuoti.

Audito žurnalai

`GET /v1/audit-logs`

Atsekamas visų darbo srities pakeitimų žurnalas.

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

Užklausos parametrai (Query Parameters):

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 (cursor)
`limit`	integer	Maks. 100 (numatytoji reikšmė: 50)

Atsakymo pavyzdys:

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