Przejdź do głównej zawartości

Organizacje i obszary robocze

Przegląd

qr3.app verwendet eine zweistufige Hierarchie:

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
  • Workspace (obszar roboczy) — izolowany obszar dla kodów QR, skanów i kluczy API

Organizations API

GET /v1/organizations

Zwraca organizację, do której należy aktualny klucz API.

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

POST /v1/organizations

Tworzy nową organizację.

Okno terminala
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:

PoleTypWymaganeOpis
namestringNazwa wyświetlana (maks. 255 znaków)
slugstringPrzyjazny dla URL, unikalny (min. 2, maks. 63 znaki, tylko a-z0-9-)
billing_emailstringE-mail do rozliczeń

PATCH /v1/organizations/:id

Okno terminala
curl -X PATCH https://qr3.app/v1/organizations/org_a1b2c3 \
-H "Authorization: Bearer qr3_sk_..." \
-H "Content-Type: application/json" \
-d '{ "name": "Digital Heroes AG", "billing_email": "[email protected]" }'

DELETE /v1/organizations/:id

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


Workspaces API

GET /v1/workspaces

Lista wszystkich obszarów roboczych (Workspaces) w organizacji.

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

POST /v1/workspaces

Tworzy nowy obszar roboczy (Workspace).

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

Pola:

PoleTypDomyślnieOpis
namestringNazwa wyświetlana (wymagane)
slugstringPrzyjazny dla URL, unikalny w ramach organizacji (wymagane)
default_localestringdeDomyślny język
approval_requiredbooleanfalseAktywacja przepływu zatwierdzania (approval workflow)
primary_colorstringKolor marki (#RRGGBB)

Limity planów:

PlanMaks. liczba obszarów roboczych
Free1
Pro3
Business10
AgencyBez limitu

PATCH /v1/workspaces/:id

Okno terminala
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

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


Logi audytowe

GET /v1/audit-logs

Przejrzysty rejestr wszystkich zmian w obszarze roboczym (Workspace).

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

Parametry zapytania:

ParametrTypOpis
resource_typestringFiltrowanie według zasobu: codes, api_keys, webhooks, workspaces
resource_idstringFiltrowanie według konkretnego identyfikatora zasobu (resource_id)
actionstringFiltrowanie według akcji (np. codes.created)
cursorstringKursor paginacji
limitintegerMaks. 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"
}
]
}