Organisaatiot & työtilat

Yleiskatsaus

qr3.app käyttää kaksivaiheista hierarkiaa:

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

Organisaatio — ylin taso, joka liittyy Stripe-tiliin ja palvelupakettiin
Työtila — eristetty alue QR-koodeille, skannauksille ja API-avaimille

Organizations API

`GET /v1/organizations`

Palauttaa organisaation, johon nykyinen API-avain kuuluu.

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

`GET /v1/organizations/usage`

Palauttaa organisaation reaaliaikaisen käytön suhteessa palvelupaketin rajoituksiin — laskettuna yhteen kaikista työtiloista ja laskettuna reaaliaikaisesti: scans kuluvalle laskutuskaudelle (verrattuna max_scans_per_month) ja dynamic_codes, aktiivisten dynaamisten koodien määrä (verrattuna max_dynamic_codes). Kumpaakaan ei koskaan estetä rajan yyttyessä; käytä tätä päätepistettä käyttöliittymän kulutusmittareihin ja päivityskehotteisiin.

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`

Luo uuden organisaation.

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

Kentät:

Kenttä	Tyyppi	Pakollinen	Kuvaus
`name`	string	✅	Näyttönimi (enint. 255 merkkiä)
`slug`	string	✅	URL-ystävällinen, yksilöllinen (väh. 2, enint. 63 merkkiä, vain `a-z0-9-`)
`billing_email`	string	—	Laskutussähköposti

`PATCH /v1/organizations/:id`

Muuttaa organisaation nimeä, laskutussähköpostia ja ilmoitussähköpostia.

Vain org_admin voi muuttaa niitä Dashboard-istunnossa. Pyynnöt API-avaimella hylätään koodilla 403 — myös qr3_sk_- ja qr3_test_sk_-avaimet —, joten vuotanut avain ei voi ohjata laskutus- tai ilmoitusosoitetta uudelleen.

`DELETE /v1/organizations/:id`

Organisaation pehmeä poisto (soft-delete). Kaikki siihen liittyvät työtilat ja QR-koodit säilytetään, mutta niihin ei enää pääse käsiksi.

Vaatii roolin org_admin (Dashboard-istunto). Pyynnöt pelkällä API-avaimella hylätään koodilla 403 — API-avaimet eivät koskaan saa järjestelmänvalvojan roolia, joten vuotanut avain ei voi poistaa organisaatiota.

Workspaces API

`GET /v1/workspaces`

Listaa kutsujalle näkyvät työtilat: org_admin ja organisaation omistaja näkevät kaikki organisaation työtilat, muut jäsenet vain ne työtilat, joihin he kuuluvat, ja API-avain vain oman työtilansa. Työtila, jota kutsuja ei näe, vastaa jokaisella reitillä /v1/workspaces/:id koodilla 404 aivan kuten tuntematon tunniste.

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

`POST /v1/workspaces`

Luo uusi työtila.

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-avaimella työtilan saa luoda vain avain, jonka on luonut org_admin tai organisaation omistaja; kaikki muut avaimet saavat koodin 403 jo ennen slugin tarkistusta (vastaus ei siis paljasta, mitkä slugit ovat varattuja). Luojan rooli tarkistetaan jokaisen pyynnön yhteydessä: jos hänet alennetaan, hänen avaimensa menettää oikeuden. API-avain on sidottu omaan työtilaansa eikä näe uutta työtilaa jälkeenpäin: sen id on 201-vastauksessa; org_admin avaa sen Dashboardissa ja voi luoda sille siellä avaimen. Dashboardissa työtiloja voi luoda vain org_admin.

Kentät:

Kenttä	Tyyppi	Oletus	Kuvaus
`name`	string	—	Näyttönimi (pakollinen)
`slug`	string	—	URL-ystävällinen, yksilöllinen organisaatiossa (pakollinen)
`default_locale`	string	`de`	Oletuskieli
`approval_required`	boolean	`false`	Varattu suunnitellulle hyväksymistyönkululle (ei toteutettu)
`primary_color`	string	—	Brändiväri (`#RRGGBB`)

Palvelupakettien rajoitukset:

Palvelupaketti	Työtiloja enintään
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`

Arkistoi työtilan. Ei voida kohdistaa omaan työtilaan.

Vaatii roolin org_admin tai arkistoitavan työtilan roolin ws_admin; muut roolit saavat koodin 403. Työtila, jota kutsuja ei näe, vastaa koodilla 404 — API-avaimelle tämä koskee kaikkia työtiloja paitsi sen omaa, jota se ei myöskään voi arkistoida.

Audit-lokit

`GET /v1/audit-logs`

Jäljitettävä loki kaikista työtilan muutoksista.

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

Kyselyparametrit:

Parametri	Tyyppi	Kuvaus
`resource_type`	string	Suodata resurssin mukaan: `codes`, `api_keys`, `webhooks`, `workspaces`
`resource_id`	string	Suodata tietyn resurssitunnuksen (ID) mukaan
`action`	string	Suodata toiminnon mukaan (esim. `codes.created`)
`cursor`	string	Sivutuksen osoitin (cursor)
`limit`	integer	Enintään 100 (oletus: 50)

Esimerkkivastaus:

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