Organisations & Workspaces
Aperçu
qr3.app utilise une hiérarchie à deux niveaux :
Organization (Firma/Agentur) └── Workspace 1 (Kunde A) └── Workspace 2 (Kunde B) └── Workspace 3 (Internes Team)- Organisation — niveau supérieur, associé à un compte Stripe et à un forfait
- Workspace — espace isolé pour les codes QR, les scans et les clés API
API Organizations
GET /v1/organizations
Retourne l’organisation à laquelle appartient la clé API actuelle.
curl https://qr3.app/v1/organizations \ -H "Authorization: Bearer qr3_sk_..."GET /v1/organizations/usage
Retourne l’utilisation en temps réel de l’organisation par rapport aux limites du forfait — cumulée sur tous les workspaces et calculée en direct : scans pour le mois de facturation en cours (par rapport à max_scans_per_month) et dynamic_codes, le nombre de codes dynamiques actifs (par rapport à max_dynamic_codes). Aucun des deux n’est jamais bloqué lorsque la limite est de dépassement ; utilisez cet endpoint pour afficher l’utilisation et les invitations à passer au forfait supérieur.
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
Crée une nouvelle organisation.
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]" }'Champs :
| Champ | Type | Requis | Description |
|---|---|---|---|
name | string | ✅ | Nom d’affichage (max. 255 caractères) |
slug | string | ✅ | Compatible URL, unique (min. 2, max. 63 caractères, uniquement a-z0-9-) |
billing_email | string | — | E-mail de facturation |
PATCH /v1/organizations/:id
curl -X PATCH https://qr3.app/v1/organizations/org_a1b2c3 \ -H "Authorization: Bearer qr3_sk_..." \ -H "Content-Type: application/json" \DELETE /v1/organizations/:id
Suppression réversible (soft-delete) de l’organisation. Tous les workspaces et codes QR associés sont conservés, mais ne sont plus accessibles.
API Workspaces
GET /v1/workspaces
Lister tous les workspaces de l’organisation.
curl https://qr3.app/v1/workspaces \ -H "Authorization: Bearer qr3_sk_..."POST /v1/workspaces
Créer un nouveau 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 }'Champs :
| Champ | Type | Par défaut | Description |
|---|---|---|---|
name | string | — | Nom d’affichage (requis) |
slug | string | — | Compatible URL, unique par organisation (requis) |
default_locale | string | de | Langue par défaut |
approval_required | boolean | false | Activer le workflow d’approbation |
primary_color | string | — | Couleur de marque (#RRGGBB) |
Limites du forfait :
| Forfait | Max. Workspaces |
|---|---|
| Free | 1 |
| Pro | 3 |
| Business | 10 |
| Agency | Illimité |
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
Archive le workspace. Ne peut pas être appliqué à votre propre workspace.
Journaux d’audit
GET /v1/audit-logs
Historique traçable de toutes les modifications apportées au workspace.
curl "https://qr3.app/v1/audit-logs?resource_type=codes&limit=50" \ -H "Authorization: Bearer qr3_sk_..."Paramètres de requête :
| Paramètre | Type | Description |
|---|---|---|
resource_type | string | Filtrer par ressource : codes, api_keys, webhooks, workspaces |
resource_id | string | Filtrer par ID de ressource spécifique |
action | string | Filtrer par action (par ex. codes.created) |
cursor | string | Curseur de pagination |
limit | integer | Max. 100 (par défaut : 50) |
Exemple de réponse :
{ "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" } ]}