Organisatsioonid ja töölauad

Ülevaade

qr3.app kasutab kahetasandilist hierarhiat:

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

Organisatsioon — kõrgeim tase, mis on seotud Stripe’i konto ja paketiga
Workspace — isoleeritud ala QR-koodide, skaneeringute ja API-võtmete jaoks

Organizations API

`GET /v1/organizations`

Tagastab organisatsiooni, millele praegune API-võti kuulub.

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

`GET /v1/organizations/usage`

Tagastab organisatsiooni reaalajas kasutuse võrreldes paketi limiitidega — summeerituna üle kõigi Workspace’ide ja arvutatuna reaalajas: scans jooksva arvelduskuu kohta (võrreldes max_scans_per_month limiidiga) ja dynamic_codes ehk aktiivsete dünaamiliste koodide arv (võrreldes max_dynamic_codes limiidiga). Kumpagi ei blokeerita kunagi limiidi täitumisel; kasuta seda otspunkti (endpoint) kasutuse kuvamiseks ja uuendusteatiste (upgrade) kuvamiseks.

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`

Loob uue organisatsiooni.

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

Väljad:

Väli	Tüüp	Kohustuslik	Kirjeldus
`name`	string	✅	Kuvatav nimi (max 255 märki)
`slug`	string	✅	URL-sõbralik, unikaalne (min 2, max 63 märki, ainult `a-z0-9-`)
`billing_email`	string	—	Arveldusaadress (e-post)

`PATCH /v1/organizations/:id`

Muudab organisatsiooni nime, arvete e-posti ja teavituste e-posti.

Neid saab muuta ainult org_admin Dashboardi sessioonis. Päringud API-võtmega lükatakse tagasi veakoodiga 403 — ka võtmed qr3_sk_ ja qr3_test_sk_ —, seega ei saa lekkinud võti arve- ega teavitusaadressi ümber suunata.

`DELETE /v1/organizations/:id`

Organisatsiooni pehme kustutamine (soft-delete). Kõik seotud Workspace’id ja QR-koodid säilitatakse, kuid need pole enam kättesaadavad.

Nõuab rolli org_admin (Dashboardi sessioon). Päringud pelgalt API-võtmega lükatakse tagasi veakoodiga 403 — API-võtmed ei oma kunagi administraatori rolli, seega ei saa lekkinud võti organisatsiooni kustutada.

Workspaces API

`GET /v1/workspaces`

Kuvab Workspace’id, mida päringu tegija näeb: org_admin ja organisatsiooni omanik näevad kõiki organisatsiooni Workspace’e, teised liikmed ainult neid Workspace’e, kuhu nad kuuluvad, ja API-võti ainult oma Workspace’i. Workspace, mida päringu tegija ei näe, vastab igal marsruudil /v1/workspaces/:id koodiga 404, täpselt nagu tundmatu ID.

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

`POST /v1/workspaces`

Uue Workspace’i loomine.

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-võtmega tohib Workspace’i luua ainult võti, mille on loonud org_admin või organisatsiooni omanik; iga teine võti saab koodi 403 juba enne slug’i kontrolli (vastus ei reeda, millised slug’id on hõivatud). Looja rolli kontrollitakse iga päringu juures: kui ta alandatakse, kaotab tema võti selle õiguse. API-võti on seotud oma Workspace’iga ega näe uut hiljem: selle id on vastuses 201; org_admin avab selle Dashboardis ja saab seal sellele võtme luua. Dashboardis tohib Workspace’e luua ainult org_admin.

Väljad:

Väli	Tüüp	Vaikimisi	Kirjeldus
`name`	string	—	Kuvatav nimi (kohustuslik)
`slug`	string	—	URL-sõbralik, unikaalne organisatsiooni piires (kohustuslik)
`default_locale`	string	`de`	Vaikimisi keel
`approval_required`	boolean	`false`	Reserveeritud kavandatud kinnitamise töövoo jaoks (pole rakendatud)
`primary_color`	string	—	Brändi värv (`#RRGGBB`)

Paketi limiidid:

Pakett	Max Workspace’ide arv
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`

Arhiveerib Workspace’i. Seda ei saa rakendada praegusele Workspace’ile.

Nõuab arhiveeritava Workspace’i rolli org_admin või ws_admin; teised rollid saavad koodi 403. Workspace, mida päringu tegija ei näe, vastab koodiga 404 — API-võtme puhul on see iga Workspace peale tema enda, mida ta samuti arhiveerida ei saa.

Audit-logid

`GET /v1/audit-logs`

Jälgitav logi kõigi Workspace’is tehtud muudatuste kohta.

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

Päringu parameetrid:

Parameeter	Tüüp	Kirjeldus
`resource_type`	string	Filtreeri ressursi järgi: `codes`, `api_keys`, `webhooks`, `workspaces`
`resource_id`	string	Filtreeri konkreetse ressursi ID järgi
`action`	string	Filtreeri tegevuse järgi (nt `codes.created`)
`cursor`	string	Lehekülgede jaotamise kursor (pagination cursor)
`limit`	integer	Max 100 (vaikimisi: 50)

Näidisvastus:

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