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 — 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_..."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, 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" \DELETE /v1/organizations/:id
Švelnus organizacijos ištrynimas (Soft-Delete). Visi susiję Workspaces ir QR kodai išlieka, tačiau tampa nepasiekiami.
Workspaces API
GET /v1/workspaces
Pateikia visų organizacijos Workspaces sąrašą.
curl https://qr3.app/v1/workspaces \ -H "Authorization: Bearer qr3_sk_..."POST /v1/workspaces
Sukuria naują 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, unikalus organizacijoje (privalomas) |
default_locale | string | de | Numatytoji kalba |
approval_required | boolean | false | Įjungti patvirtinimo darbo eigą (workflow) |
primary_color | string | — | Prekių ženklo spalva (#RRGGBB) |
Plano ribojimai:
| Planas | Maks. Workspaces skaičius |
|---|---|
| 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 Workspace. Negali būti taikoma jūsų pačių Workspace.
Audito žurnalai
GET /v1/audit-logs
Atsekamas visų 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:
{ "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" } ]}