Οργανισμοί & 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.
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 για ενδείξεις χρήσης και ειδοποιήσεις αναβάθμισης.
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 | — | Email τιμολόγησης |
PATCH /v1/organizations/:id
Αλλάζει το όνομα, το email χρέωσης και το email ειδοποιήσεων του οργανισμού.
Μόνο ένας org_admin μπορεί να τα αλλάξει, σε συνεδρία Dashboard. Αιτήματα με API-Key απορρίπτονται με 403 — ακόμη και με κλειδιά qr3_sk_ και qr3_test_sk_ —, επομένως ένα διαρρεύσαν API-Key δεν μπορεί να ανακατευθύνει τη διεύθυνση χρέωσης ή ειδοποιήσεων.
DELETE /v1/organizations/:id
Soft-delete του οργανισμού. Όλα τα σχετικά Workspaces και QR-Codes διατηρούνται, αλλά δεν είναι πλέον προσβάσιμα.
Απαιτεί τον ρόλο org_admin (συνεδρία Dashboard). Αιτήματα με απλό API-Key απορρίπτονται με 403 — τα API-Keys δεν αποκτούν ποτέ ρόλο διαχειριστή, επομένως ένα διαρρεύσαν API-Key δεν μπορεί να διαγράψει τον οργανισμό.
Workspaces API
GET /v1/workspaces
Λίστα με τα Workspaces που είναι ορατά στον καλούντα: ο org_admin και ο κάτοχος του οργανισμού βλέπουν όλα τα Workspaces του οργανισμού, τα υπόλοιπα μέλη μόνο τα Workspaces στα οποία ανήκουν και ένα API-Key μόνο το δικό του Workspace. Ένα Workspace που ο καλών δεν βλέπει απαντά με 404 σε κάθε διαδρομή /v1/workspaces/:id, ακριβώς όπως ένα άγνωστο ID.
curl https://qr3.app/v1/workspaces \ -H "Authorization: Bearer qr3_sk_..."POST /v1/workspaces
Δημιουργία νέου Workspace.
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 }'Με API-Key μπορεί να δημιουργήσει Workspace μόνο ένα κλειδί που δημιούργησε ένας org_admin ή ο κάτοχος του οργανισμού· κάθε άλλο κλειδί λαμβάνει 403, πριν ακόμη ελεγχθεί το slug (η απάντηση δεν αποκαλύπτει ποια slugs είναι κατειλημμένα). Ο ρόλος του δημιουργού ελέγχεται σε κάθε αίτημα: αν υποβιβαστεί, το κλειδί του χάνει το δικαίωμα. Ένα API-Key είναι δεμένο με το δικό του Workspace και δεν βλέπει μετά το νέο: το id του βρίσκεται στην απάντηση 201· ένας org_admin το ανοίγει στο Dashboard και μπορεί να δημιουργήσει εκεί ένα κλειδί γι’ αυτό. Στο Dashboard μόνο ένας org_admin μπορεί να δημιουργεί Workspaces.
Πεδία:
| Πεδίο | Τύπος | Προεπιλογή | Περιγραφή |
|---|---|---|---|
name | string | — | Όνομα εμφάνισης (Υποχρεωτικό) |
slug | string | — | Φιλικό προς URL, μοναδικό ανά οργανισμό (Υποχρεωτικό) |
default_locale | string | de | Προεπιλεγμένη γλώσσα |
approval_required | boolean | false | Δεσμευμένο για προγραμματισμένη ροή εργασίας έγκρισης (δεν έχει υλοποιηθεί) |
primary_color | string | — | Χρώμα branding (#RRGGBB) |
Όρια προγράμματος (Plan Limits):
| Πρόγραμμα | Μέγιστα 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
Αρχειοθετεί το Workspace. Δεν μπορεί να εφαρμοστεί στο δικό σας Workspace.
Απαιτεί org_admin ή ws_admin του Workspace που πρόκειται να αρχειοθετηθεί· οι υπόλοιποι ρόλοι λαμβάνουν 403. Ένα Workspace που ο καλών δεν βλέπει απαντά με 404 — για ένα API-Key αυτό ισχύει για κάθε Workspace εκτός από το δικό του, το οποίο επίσης δεν μπορεί να αρχειοθετήσει.
Audit-Logs
GET /v1/audit-logs
Αρχείο καταγραφής (audit log) όλων των αλλαγών στο Workspace.
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 | Cursor σελιδοποίησης (pagination cursor) |
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" } ]}