Aller au contenu

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.

Fenêtre de terminal
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.

Fenêtre de terminal
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.

Fenêtre de terminal
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 :

ChampTypeRequisDescription
namestringNom d’affichage (max. 255 caractères)
slugstringCompatible URL, unique (min. 2, max. 63 caractères, uniquement a-z0-9-)
billing_emailstringE-mail de facturation

PATCH /v1/organizations/:id

Fenêtre de terminal
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

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.

Fenêtre de terminal
curl https://qr3.app/v1/workspaces \
-H "Authorization: Bearer qr3_sk_..."

POST /v1/workspaces

Créer un nouveau workspace.

Fenêtre de terminal
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 :

ChampTypePar défautDescription
namestringNom d’affichage (requis)
slugstringCompatible URL, unique par organisation (requis)
default_localestringdeLangue par défaut
approval_requiredbooleanfalseActiver le workflow d’approbation
primary_colorstringCouleur de marque (#RRGGBB)

Limites du forfait :

ForfaitMax. Workspaces
Free1
Pro3
Business10
AgencyIllimité

PATCH /v1/workspaces/:id

Fenêtre de terminal
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.

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

Paramètres de requête :

ParamètreTypeDescription
resource_typestringFiltrer par ressource : codes, api_keys, webhooks, workspaces
resource_idstringFiltrer par ID de ressource spécifique
actionstringFiltrer par action (par ex. codes.created)
cursorstringCurseur de pagination
limitintegerMax. 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"
}
]
}