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ċjata 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 hija assoċjata l-API key attwali.

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

`GET /v1/organizations/usage`

Irritorna l-użu dirett (live) tal-organizzazzjoni meta mqabbel mal-limiti tal-pjan — magħdud fuq il-workspaces kollha u kkalkulat live: scans għax-xahar tal-kontijiet attwali (kontra max_scans_per_month) u dynamic_codes, in-numru ta’ kodiċijiet dinamiċi attivi (kontra max_dynamic_codes). L-ebda wieħed minnhom ma jiġi mblukkat meta jilħaq il-limitu; uża dan l-endpoint biex turi l-użu u n-notifiki ta’ upgrade.

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`

Oħloq organizzazzjoni ġdida.

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:

Kamp	Tip	Obbligatorju	Deskrizzjoni
`name`	string	✅	Isem għall-wiri (mass. 255 karattru)
`slug`	string	✅	URL-friendly, uniku (min. 2, mass. 63 karattru, `a-z0-9-` biss)
`billing_email`	string	—	Email tal-kontijiet

`PATCH /v1/organizations/:id`

Ibiddel l-isem, l-email tal-kontijiet u l-email tan-notifiki tal-organizzazzjoni.

Jista’ jibdilhom biss org_admin, f’sessjoni tad-Dashboard. Talbiet awtentikati b’API key jiġu rrifjutati b’ 403 — anke keys qr3_sk_ u qr3_test_sk_ — u għalhekk key li tkun tnixxet ma tistax tidderieġi mill-ġdid l-indirizz tal-kontijiet jew tan-notifiki.

`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.

Jirrikjedi r-rwol org_admin (sessjoni tad-Dashboard). Talbiet awtentikati b’API key sempliċi biss jiġu rrifjutati b’ 403 — l-API keys qatt ma jilħqu rwol ta’ admin, u għalhekk key li tkun tnixxet ma tistax tħassar l-organizzazzjoni.

API tal-Workspaces

`GET /v1/workspaces`

Elenka l-workspaces li jista’ jara min qed isejjaħ: org_admin u s-sid tal-organizzazzjoni jaraw il-workspaces kollha tal-organizzazzjoni, membri oħra biss il-workspaces li huma parti minnhom, u API key biss il-workspace tagħha. Workspace li min qed isejjaħ ma jistax jara jwieġeb 404 fuq kull rotta /v1/workspaces/:id, eżatt bħal ID mhux magħruf.

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

`POST /v1/workspaces`

Oħloq Workspace ġdid.

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

B’API key, workspace jista’ joħolqu biss key li ħoloq org_admin jew is-sid tal-organizzazzjoni; kull key oħra tirċievi 403, saħansitra qabel ma jiġi ċċekkjat is-slug (għalhekk it-tweġiba ma tiżvelax liema slugs huma meħuda). Ir-rwol ta’ min ħoloq il-key jiġi ċċekkjat f’kull talba: jekk jitniżżel, il-key tiegħu titlef id-dritt. API key hija marbuta mal-workspace tagħha u wara ma tarax il-ġdid: l-id tiegħu jinsab fit-tweġiba 201; org_admin jiftħu fid-Dashboard u hemmhekk jista’ joħloq key għalih. Fid-Dashboard, workspaces jista’ joħloqhom biss org_admin.

Kampi:

Kamp	Tip	Default	Deskrizzjoni
`name`	string	—	Isem għall-wiri (obbligatorju)
`slug`	string	—	URL-friendly, uniku għal kull Org (obbligatorju)
`default_locale`	string	`de`	Lingwa default
`approval_required`	boolean	`false`	Riżervat għall-workflow ta’ approvazzjoni ppjanat (mhux implimentat)
`primary_color`	string	—	Kulur tal-branding (`#RRGGBB`)

Limiti tal-Pjan:

Pjan	Mass. Workspaces
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`

Arkivja l-workspace. Ma jistax jiġi applikat fuq il-workspace tiegħek stess.

Jirrikjedi org_admin jew ws_admin tal-workspace li qed jiġi arkivjat; rwoli oħra jirċievu 403. Workspace li min qed isejjaħ ma jistax jara jwieġeb 404 — għal API key dan huwa kull workspace ħlief tagħha, li lanqas ma tista’ tarkivja.

Audit Logs

`GET /v1/audit-logs`

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

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

Parametri tal-Query:

Parametru	Tip	Deskrizzjoni
`resource_type`	string	Iffiltra skont ir-riżorsa: `codes`, `api_keys`, `webhooks`, `workspaces`
`resource_id`	string	Iffiltra skont l-ID speċifika tar-riżorsa
`action`	string	Iffiltra skont l-azzjoni (eż. `codes.created`)
`cursor`	string	Cursor tal-paġinazzjoni
`limit`	integer	Mass. 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"
    }
  ]
}