Skip to content

Οργανισμοί & Workspaces

Επισκόπηση

Το qr3.app χρησιμοποιεί μια ιεραρχία δύο επιπέδων:

Organization (Firma/Agentur)
└── Workspace 1 (Kunde A)
└── Workspace 2 (Kunde B)
└── Workspace 3 (Internes Team)
  • Οργανισμός (Organization) — το ανώτατο επίπεδο, συνδεδεμένο με έναν λογαριασμό Stripe και ένα πρόγραμμα (Plan)
  • Workspace — απομονωμένη περιοχή για QR-Codes, Scans και API-Keys

Organizations API

GET /v1/organizations

Επιστρέφει τον οργανισμό στον οποίο ανήκει το τρέχον API-Key.

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

GET /v1/organizations/usage

Επιστρέφει τη ζωντανή χρήση του οργανισμού σε σχέση με τα όρια του προγράμματος (Plan limits) — αθροιστικά για όλα τα Workspaces και υπολογισμένη σε πραγματικό χρόνο: scans για τον τρέχοντα μήνα τιμολόγησης (έναντι του max_scans_per_month) και dynamic_codes, ο αριθμός των ενεργών δυναμικών κωδικών (έναντι του max_dynamic_codes). Κανένα από τα δύο δεν μπλοκάρεται ποτέ όταν φτάσει το όριο· χρησιμοποιήστε αυτό το endpoint για ενδείξεις χρήσης και ειδοποιήσεις αναβάθμισης.

Terminal window
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

Δημιουργεί έναν νέο οργανισμό.

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

Πεδία:

ΠεδίοΤύποςΥποχρεωτικόΠεριγραφή
namestringΌνομα εμφάνισης (έως 255 χαρακτήρες)
slugstringΦιλικό προς URL, μοναδικό (από 2 έως 63 χαρακτήρες, μόνο a-z0-9-)
billing_emailstringEmail τιμολόγησης

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 του οργανισμού. Όλα τα σχετικά Workspaces και QR-Codes διατηρούνται, αλλά δεν είναι πλέον προσβάσιμα.


Workspaces API

GET /v1/workspaces

Λίστα με όλα τα Workspaces του οργανισμού.

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

POST /v1/workspaces

Δημιουργία νέου 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
}'

Πεδία:

ΠεδίοΤύποςΠροεπιλογήΠεριγραφή
namestringΌνομα εμφάνισης (Υποχρεωτικό)
slugstringΦιλικό προς URL, μοναδικό ανά οργανισμό (Υποχρεωτικό)
default_localestringdeΠροεπιλεγμένη γλώσσα
approval_requiredbooleanfalseΕνεργοποίηση ροής εργασίας έγκρισης
primary_colorstringΧρώμα branding (#RRGGBB)

Όρια προγράμματος (Plan Limits):

ΠρόγραμμαΜέγιστα Workspaces
Free1
Pro3
Business10
AgencyΑπεριόριστα

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

Αρχειοθετεί το Workspace. Δεν μπορεί να εφαρμοστεί στο δικό σας Workspace.


Audit-Logs

GET /v1/audit-logs

Αρχείο καταγραφής (audit log) όλων των αλλαγών στο Workspace.

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

Παράμετροι Query:

ΠαράμετροςΤύποςΠεριγραφή
resource_typestringΦιλτράρισμα ανά πόρο: codes, api_keys, webhooks, workspaces
resource_idstringΦιλτράρισμα ανά συγκεκριμένο ID πόρου
actionstringΦιλτράρισμα ανά ενέργεια (π.χ. codes.created)
cursorstringCursor σελιδοποίησης (pagination cursor)
limitintegerΜέγιστο 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"
}
]
}