Eagraíochtaí & Spásanna Oibre

Foramharc

Úsáideann qr3.app ordlathas dhá leibhéal:

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

Eagraíocht — an leibhéal is airde, bainteach le cuntas Stripe agus plean
Spás Oibre — limistéar scoite do chóid QR, scananna, agus API-Keys

API na nEagraíochtaí

`GET /v1/organizations`

Seolann sé ar ais an eagraíocht lena mbaineann an API-Key reatha.

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

`GET /v1/organizations/usage`

Seolann sé ar ais úsáid bheo na heagraíochta i gcomparáid le teorainneacha an phlean — suimithe thar gach Spás Oibre agus ríofa beo: scans don mhí bhilleála reatha (i gcomparáid le max_scans_per_month) agus dynamic_codes, líon na gcód dinimiciúil gníomhach (i gcomparáid le max_dynamic_codes). Ní chuirtear bac ar cheachtar acu ag an teorainn; úsáid an críochphointe seo le haghaidh taispeántais úsáide agus fógraí uasghrádaithe.

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`

Cruthaíonn sé eagraíocht nua.

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

Réimsí:

Réimse	Cineál	Riachtanach	Cur Síos
`name`	string	✅	Ainm taispeána (uasmhéid 255 carachtar)
`slug`	string	✅	Cairdiúil do URL, uathúil (íosmhéid 2, uasmhéid 63 carachtar, `a-z0-9-` amháin)
`billing_email`	string	—	Ríomhphost billeála

`PATCH /v1/organizations/:id`

Athraíonn sé ainm, ríomhphost billeála agus ríomhphost fógraí na heagraíochta.

Ní féidir iad a athrú ach ag org_admin, i seisiún sa deais. Diúltaítear d’iarratais le heochair API le 403 — eochracha qr3_sk_ agus qr3_test_sk_ san áireamh — mar sin ní féidir le heochair a sceitheadh an seoladh billeála ná an seoladh fógraí a atreorú.

`DELETE /v1/organizations/:id`

Scriosadh bog (Soft-Delete) ar an eagraíocht. Coimeádtar gach Spás Oibre agus cód QR gaolmhar, ach ní bheidh rochtain orthu a thuilleadh.

Teastaíonn an ról org_admin (seisiún sa deais). Diúltaítear d’iarratais a bhfuil eochair API shimplí acu le 403 — ní bhaineann eochracha API ról riarthóra amach choíche, mar sin ní féidir le heochair a sceitheadh an eagraíocht a scriosadh.

API na Spásanna Oibre

`GET /v1/workspaces`

Liostaigh na Spásanna Oibre atá le feiceáil ag an té a ghlaonn: feiceann org_admin agus úinéir na heagraíochta gach Spás Oibre den eagraíocht, baill eile na Spásanna Oibre a bhfuil siad iontu amháin, agus eochair API a Spás Oibre féin amháin. Freagraíonn Spás Oibre nach féidir leis an té a ghlaonn a fheiceáil le 404 ar gach bealach /v1/workspaces/:id, díreach cosúil le ID anaithnid.

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

`POST /v1/workspaces`

Cruthaigh Spás Oibre nua.

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

Le heochair API, ní féidir Spás Oibre a chruthú ach le heochair a chruthaigh org_admin nó úinéir na heagraíochta; faigheann gach eochair eile 403, fiú sula seiceáiltear an slug (ní nochtann an freagra mar sin cé na slugs atá in úsáid). Seiceáiltear ról an té a chruthaigh an eochair le gach iarratas: má íslítear é, cailleann a eochair an ceart. Tá eochair API ceangailte dá Spás Oibre féin agus ní fheiceann sí an ceann nua ina dhiaidh sin: tá a id sa fhreagra 201; osclaíonn org_admin é sa deais agus is féidir leis eochair a chruthú dó ansin. Sa deais, ní féidir ach le org_admin Spásanna Oibre a chruthú.

Réimsí:

Réimse	Cineál	Réamhshocrú	Cur Síos
`name`	string	—	Ainm taispeána (Riachtanach)
`slug`	string	—	Cairdiúil do URL, uathúil in aghaidh na hEagraíochta (Riachtanach)
`default_locale`	string	`de`	Teanga réamhshocraithe
`approval_required`	boolean	`false`	Curtha in áirithe don sreabhadh oibre ceadaithe atá beartaithe (níl sé curtha i bhfeidhm)
`primary_color`	string	—	Dath brandála (`#RRGGBB`)

Teorainneacha Plean:

Plean	Uasmhéid Spásanna Oibre
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`

Archívaíonn sé an Spás Oibre. Ní féidir é seo a chur i bhfeidhm ar do Spás Oibre féin.

Teastaíonn org_admin nó ws_admin don Spás Oibre atá á archívú; faigheann róil eile 403. Freagraíonn Spás Oibre nach féidir leis an té a ghlaonn a fheiceáil le 404 — i gcás eochair API, is é sin gach Spás Oibre seachas a cheann féin, nach féidir léi a archívú ach oiread.

Logaí Iniúchta

`GET /v1/audit-logs`

Loga inrianaithe ar gach athrú sa Spás Oibre.

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

Paraiméadair Query:

Paraiméadar	Cineál	Cur Síos
`resource_type`	string	Scag de réir acmhainne: `codes`, `api_keys`, `webhooks`, `workspaces`
`resource_id`	string	Scag de réir ID acmhainne sainiúla
`action`	string	Scag de réir gníomhaíochta (e.g. `codes.created`)
`cursor`	string	Cúrsóir leathanachúcháin
`limit`	integer	Uasmhéid 100 (Réamhshocrú: 50)

Freagra Samplach:

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