Организации и работни пространства

Общ преглед

qr3.app използва двустепенна йерархия:

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

Организация — най-високо ниво, свързано със Stripe акаунт и план
Работно пространство — изолирана зона за QR кодове, сканирания и API ключове

Organizations API

`GET /v1/organizations`

Връща организацията, към която принадлежи текущият API ключ.

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

`GET /v1/organizations/usage`

Връща потреблението в реално време на организацията спрямо лимитите на плана — сумирано за всички работни пространства и изчислено на живо: scans за текущия таксуващ месец (спрямо max_scans_per_month) и dynamic_codes, броят на активните динамични кодове (спрямо max_dynamic_codes). И двете никога не се блокират при достигане на лимита; използвайте тази крайна точка (endpoint) за показване на потреблението и известия за надграждане (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`

Създава нова организация.

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

Полета:

Поле	Тип	Задължително	Описание
`name`	string	✅	Показвано име (макс. 255 знака)
`slug`	string	✅	Подходящ за URL, уникален (мин. 2, макс. 63 знака, само `a-z0-9-`)
`billing_email`	string	—	Имейл за фактуриране

`PATCH /v1/organizations/:id`

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) на организацията. Всички свързани работни пространства и QR кодове се запазват, но вече не са достъпни.

Workspaces API

`GET /v1/workspaces`

Списък на всички работни пространства в организацията.

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

`POST /v1/workspaces`

Създаване на ново работно пространство.

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

Полета:

Поле	Тип	По подразбиране	Описание
`name`	string	—	Показвано име (задължително)
`slug`	string	—	Подходящ за URL, уникален за организацията (задължително)
`default_locale`	string	`de`	Език по подразбиране
`approval_required`	boolean	`false`	Активиране на работен процес за одобрение (approval workflow)
`primary_color`	string	—	Брандов цвят (`#RRGGBB`)

Лимити на плановете:

План	Макс. работни пространства
Free	1
Pro	3
Business	10
Agency	Безлимитно

`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,
    "custom_domain": "qr.baeckerei-schmidt.de"
  }'

`DELETE /v1/workspaces/:id`

Архивира работното пространство. Не може да се приложи за собственото работно пространство.

Дневници за одит

`GET /v1/audit-logs`

Проследим дневник на всички промени в работното пространство.

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

Query параметри:

Параметър	Тип	Описание
`resource_type`	string	Филтриране по ресурс: `codes`, `api_keys`, `webhooks`, `workspaces`
`resource_id`	string	Филтриране по конкретен ID на ресурс
`action`	string	Филтриране по действие (напр. `codes.created`)
`cursor`	string	Курсор за пагинация
`limit`	integer	Макс. 100 (по подразбиране: 50)

Примерен отговор (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"
    }
  ]
}