Skip to content

Organizacijos ir darbo sritys

Apžvalga

qr3.app naudoja dviejų lygių hierarchiją:

Organization (Firma/Agentur)
└── Workspace 1 (Kunde A)
└── Workspace 2 (Kunde B)
└── Workspace 3 (Internes Team)
  • Organizacija — aukščiausias lygis, susietas su Stripe paskyra ir planu
  • Workspace — izoliuota sritis QR kodams, nuskaitymams ir API raktams

Organizations API

GET /v1/organizations

Grąžina organizaciją, kuriai priklauso dabartinis API raktas.

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

POST /v1/organizations

Sukuria naują organizaciją.

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

Laukai:

LaukasTipasPrivalomasAprašymas
namestringRodomas pavadinimas (maks. 255 simboliai)
slugstringDraugiškas URL, unikalus (min. 2, maks. 63 simboliai, tik a-z0-9-)
billing_emailstringSąskaitų faktūrų el. paštas

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

Švelnus organizacijos ištrynimas (Soft-Delete). Visi susiję Workspaces ir QR kodai išlieka, tačiau tampa nepasiekiami.


Workspaces API

GET /v1/workspaces

Pateikia visų organizacijos Workspaces sąrašą.

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

POST /v1/workspaces

Sukuria naują 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
}'

Laukai:

LaukasTipasNumatytasisAprašymas
namestringRodomas pavadinimas (privalomas)
slugstringDraugiškas URL, unikalus organizacijoje (privalomas)
default_localestringdeNumatytoji kalba
approval_requiredbooleanfalseĮjungti patvirtinimo darbo eigą (workflow)
primary_colorstringPrekių ženklo spalva (#RRGGBB)

Plano ribojimai:

PlanasMaks. Workspaces skaičius
Free1
Pro3
Business10
AgencyNeribota

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

Archyvuoja Workspace. Negali būti taikoma jūsų pačių Workspace.


Audito žurnalai

GET /v1/audit-logs

Atsekamas visų Workspace pakeitimų žurnalas.

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

Užklausos parametrai:

ParametrasTipasAprašymas
resource_typestringFiltruoti pagal išteklių: codes, api_keys, webhooks, workspaces
resource_idstringFiltruoti pagal konkretų ištekliaus ID
actionstringFiltruoti pagal veiksmą (pvz., codes.created)
cursorstringPuslapiavimo žymeklis (Pagination-Cursor)
limitintegerMaks. 100 (numatytasis: 50)

Atsakymo pavyzdys:

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