Hoppa till innehåll

Organisationer & Workspaces

Översikt

qr3.app använder en tvåstegshierarki:

Organization (Firma/Agentur)
└── Workspace 1 (Kunde A)
└── Workspace 2 (Kunde B)
└── Workspace 3 (Internes Team)
  • Organisation — översta nivån, kopplad till ett Stripe-konto och en plan
  • Workspace — isolerat område för QR-koder, skanningar och API-nycklar

Organizations API

GET /v1/organizations

Returnerar organisationen som den aktuella API-nyckeln tillhör.

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

GET /v1/organizations/usage

Returnerar organisationens live-användning mot dess plangränser — summerat över alla workspaces och beräknat i realtid: scans för den aktuella faktureringsmånaden (mot max_scans_per_month) och dynamic_codes, antalet aktiva dynamiska koder (mot max_dynamic_codes). Båda blockeras aldrig vid gränsen; använd denna slutpunkt för att visa användning och uppgraderingsmeddelanden.

Terminal window
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

Skapar en ny organisation.

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

Fält:

FältTypObligatoriskBeskrivning
namestringVisningsnamn (max 255 tecken)
slugstringURL-vänlig, unik (minst 2, max 63 tecken, endast a-z0-9-)
billing_emailstringFakturerings-e-post

PATCH /v1/organizations/:id

Terminal window
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

Mjuk radering (soft-delete) av organisationen. Alla tillhörande workspaces och QR-koder bevaras, men är inte längre tillgängliga.


Workspaces API

GET /v1/workspaces

Lista alla workspaces i organisationen.

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

POST /v1/workspaces

Skapa ett nytt workspace.

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

Fält:

FältTypStandardBeskrivning
namestringVisningsnamn (obligatoriskt)
slugstringURL-vänlig, unik per org (obligatoriskt)
default_localestringdeStandardspråk
approval_requiredbooleanfalseAktivera godkännandearbetsflöde
primary_colorstringVarumärkesfärg (#RRGGBB)

Plangränser:

PlanMax antal workspaces
Free1
Pro3
Business10
AgencyObegränsat

PATCH /v1/workspaces/:id

Terminal window
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

Arkiverar workspacet. Kan inte tillämpas på det egna workspacet.


Audit-loggar

GET /v1/audit-logs

Spårbar logg över alla ändringar i workspacet.

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

Query-parametrar:

ParameterTypBeskrivning
resource_typestringFiltrera efter resurs: codes, api_keys, webhooks, workspaces
resource_idstringFiltrera efter specifik resurs-ID
actionstringFiltrera efter åtgärd (t.ex. codes.created)
cursorstringPaginering-cursor
limitintegerMax 100 (standard: 50)

Exempelsvar:

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