Skip to content

Organizzazzjonijiet u Workspaces

Ħarsa ġenerali

qr3.app juża ġerarkija b’żewġ livelli:

Organization (Firma/Agentur)
└── Workspace 1 (Kunde A)
└── Workspace 2 (Kunde B)
└── Workspace 3 (Internes Team)
  • Organizzazzjoni — l-ogħla livell, assoċjat ma’ kont u pjan ta’ Stripe
  • Workspace — żona iżolata għal QR codes, skans u API keys

API tal-Organizzazzjonijiet

GET /v1/organizations

Irritorna l-organizzazzjoni li magħha huwa assoċjat l-API key attwali.

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

POST /v1/organizations

Oħloq organizzazzjoni ġdida.

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

Kampi:

KampTipMandatorjuDeskrizzjoni
namestringIsem għall-wiri (mass. 255 karattru)
slugstringURL-friendly, uniku (min. 2, mass. 63 karattru, a-z0-9- biss)
billing_emailstringEmail tal-kontijiet

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

Soft-delete tal-organizzazzjoni. Il-workspaces u l-QR codes kollha assoċjati jinżammu, iżda ma jibqgħux aċċessibbli.


API tal-Workspaces

GET /v1/workspaces

Elenka l-workspaces kollha tal-organizzazzjoni.

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

POST /v1/workspaces

Oħloq workspace ġdid.

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

Kampi:

KampTipDefaultDeskrizzjoni
namestringIsem għall-wiri (mandatorju)
slugstringURL-friendly, uniku għal kull Org (mandatorju)
default_localestringdeLingwa default
approval_requiredbooleanfalseAttiva l-workflow tal-approvazzjoni
primary_colorstringKulur tal-branding (#RRGGBB)

Limiti tal-Pjan:

PjanMass. Workspaces
Free1
Pro3
Business10
AgencyBla limitu

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

Archivja l-workspace. Ma jistax jiġi applikat għall-workspace tiegħek stess.


Audit Logs

GET /v1/audit-logs

Log traċċabbli tal-bidliet kollha fil-workspace.

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

Parametri tal-Query:

ParametruTipDeskrizzjoni
resource_typestringIffiltra skont ir-riżorsa: codes, api_keys, webhooks, workspaces
resource_idstringIffiltra skont ID speċifika tar-riżorsa
actionstringIffiltra skont l-azzjoni (eż. codes.created)
cursorstringCursor tal-paginazzjoni
limitintegerMass. 100 (Default: 50)

Eżempju ta’ Response:

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