Organizacje i obszary robocze

Przegląd

qr3.app korzysta z dwupoziomowej hierarchii:

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

Organizacja — najwyższy poziom, powiązany z kontem Stripe i planem
Obszar roboczy (Workspace) — odizolowany obszar dla kodów QR, skanów i kluczy API

Organizations API

`GET /v1/organizations`

Zwraca organizację, do której należy bieżący klucz API.

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

`GET /v1/organizations/usage`

Zwraca bieżące zużycie organizacji w odniesieniu do limitów planu — zsumowane dla wszystkich obszarów roboczych i obliczane na żywo: scans dla bieżącego miesiąca rozliczeniowego (względem max_scans_per_month) oraz dynamic_codes, czyli liczbę aktywnych kodów dynamicznych (względem max_dynamic_codes). Żadne z nich nie jest blokowane po osiągnięciu limitu; użyj tego punktu końcowego do wyświetlania zużycia i komunikatów o uaktualnieniu planu.

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`

Tworzy nową organizację.

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

Pola:

Pole	Typ	Wymagane	Opis
`name`	string	✅	Nazwa wyświetlana (maks. 255 znaków)
`slug`	string	✅	Przyjazny dla URL, unikalny (min. 2, maks. 63 znaki, tylko `a-z0-9-`)
`billing_email`	string	—	E-mail do rozliczeń

`PATCH /v1/organizations/:id`

Zmienia nazwę, adres e-mail do faktur i adres e-mail do powiadomień organizacji.

Zmieniać je może tylko org_admin w sesji Dashboardu. Żądania z kluczem API są odrzucane z kodem 403 — także z kluczami qr3_sk_ i qr3_test_sk_ —, więc wyciekły klucz nie może przekierować adresu do faktur ani do powiadomień.

`DELETE /v1/organizations/:id`

Miękkie usunięcie (soft-delete) organizacji. Wszystkie powiązane obszary robocze i kody QR zostaną zachowane, ale nie będą już dostępne.

Wymaga roli org_admin (sesja Dashboardu). Żądania z samym kluczem API są odrzucane z kodem 403 — klucze API nigdy nie otrzymują roli administratora, więc wyciekły klucz nie może usunąć organizacji.

Workspaces API

`GET /v1/workspaces`

Listuje obszary robocze widoczne dla wywołującego: org_admin i właściciel organizacji widzą wszystkie obszary robocze organizacji, pozostali członkowie tylko obszary robocze, do których należą, a klucz API tylko własny obszar roboczy. Obszar roboczy, którego wywołujący nie widzi, odpowiada kodem 404 na każdej ścieżce /v1/workspaces/:id, dokładnie tak jak nieznany identyfikator.

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

`POST /v1/workspaces`

Tworzy nowy obszar roboczy.

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

Kluczem API obszar roboczy może utworzyć tylko klucz utworzony przez org_admin lub właściciela organizacji; każdy inny klucz otrzymuje kod 403, jeszcze przed sprawdzeniem sluga (odpowiedź nie zdradza więc, które slugi są zajęte). Rola osoby, która utworzyła klucz, jest sprawdzana przy każdym żądaniu: jeśli zostanie zdegradowana, jej klucz traci to uprawnienie. Klucz API jest powiązany z własnym obszarem roboczym i nie widzi potem nowego: jego id znajduje się w odpowiedzi 201; org_admin otwiera go w Dashboardzie i może tam utworzyć dla niego klucz. W Dashboardzie obszary robocze może tworzyć tylko org_admin.

Pola:

Pole	Typ	Domyślnie	Opis
`name`	string	—	Nazwa wyświetlana (wymagane)
`slug`	string	—	Przyjazny dla URL, unikalny w obrębie organizacji (wymagane)
`default_locale`	string	`de`	Domyślny język
`approval_required`	boolean	`false`	Zarezerwowane dla planowanego procesu zatwierdzania (niezaimplementowane)
`primary_color`	string	—	Kolor marki (`#RRGGBB`)

Limity planów:

Plan	Maks. liczba obszarów roboczych
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`

Archiwizuje obszar roboczy. Nie można zastosować do własnego obszaru roboczego.

Wymaga roli org_admin lub ws_admin dla archiwizowanego obszaru roboczego; pozostałe role otrzymują kod 403. Obszar roboczy, którego wywołujący nie widzi, odpowiada kodem 404 — dla klucza API dotyczy to każdego obszaru roboczego poza własnym, którego również nie może zarchiwizować.

Logi audytowe

`GET /v1/audit-logs`

Przejrzysty rejestr wszystkich zmian w obszarze roboczym.

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

Parametry zapytania:

Parametr	Typ	Opis
`resource_type`	string	Filtrowanie według zasobu: `codes`, `api_keys`, `webhooks`, `workspaces`
`resource_id`	string	Filtrowanie według określonego identyfikatora zasobu
`action`	string	Filtrowanie według akcji (np. `codes.created`)
`cursor`	string	Kursor stronicowania
`limit`	integer	Maks. 100 (domyślnie: 50)

Przykładowa odpowiedź:

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