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 -tilaukseen
- Workspace — 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_..."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ään 255 merkkiä) |
slug | string | ✅ | URL-ystävällinen, yksilöllinen (vähintään 2, enintään 63 merkkiä, vain a-z0-9-) |
billing_email | string | — | Laskutussähköposti |
PATCH /v1/organizations/:id
curl -X PATCH https://qr3.app/v1/organizations/org_a1b2c3 \ -H "Authorization: Bearer qr3_sk_..." \ -H "Content-Type: application/json" \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.
Workspaces API
GET /v1/workspaces
Listaa kaikki organisaation työtilat.
curl https://qr3.app/v1/workspaces \ -H "Authorization: Bearer qr3_sk_..."POST /v1/workspaces
Luo uusi työtila (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 }'Kentät:
| Kenttä | Tyyppi | Oletus | Kuvaus |
|---|---|---|---|
name | string | — | Näyttönimi (pakollinen) |
slug | string | — | URL-ystävällinen, organisaatiokohtaisesti yksilöllinen (pakollinen) |
default_locale | string | de | Oletuskieli |
approval_required | boolean | false | Ota hyväksyntätyönkulku käyttöön |
primary_color | string | — | Brändiväri (#RRGGBB) |
Tilaustason rajoitukset:
| Tilaus | Työtiloja enintään |
|---|---|
| Free | 1 |
| Pro | 3 |
| Business | 10 |
| Agency | Rajoittamaton |
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
Arkistoi työtilan. Ei voida suorittaa sille työtilalle, jota parhaillaan käytetään.
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 | Sivutuskursori (Pagination 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" } ]}