Référence de l'API
Référence de l’API
L’API REST de qr3.app est accessible à l’adresse https://qr3.app/v1/ et suit systématiquement les conventions de l’Aperçu de l’API (authentification via Authorization: Bearer, erreurs selon la RFC 7807, pagination par curseur).
Prise en main
Aperçu de l'API Versionnage, format de requête/réponse, idempotence, pagination.
Authentification Clés API, en-têtes de Workspace, environnement de test vs. live.
Référence des erreurs Types d'erreurs RFC 7807 avec codes d'état et exemples.
Référence interactive OpenAPI 3.1 + Scalar-Playground — saisissez vos tokens et testez directement.
Domaines de ressources
Codes QR Créer, mettre à jour, suivre et rediriger en toute sécurité des codes dynamiques et statiques.
Organisations & Workspaces Comptes, Workspaces, adhésions et limites de forfait.
Webhooks S'abonner aux événements, vérification de signature, journaux de livraison.
MCP & Agents Model Context Protocol — générer des codes QR et des DPP à partir d'agents IA.
Protection des données & Endpoints de confidentialité Export RGPD, suppression de compte, hachage d'IP, consentements.
Versionnage & Obsolescence Comment les nouveaux champs sont introduits et ce qui déclenche des changements de rupture.
Endpoints spécifiques au DPP
Tous les endpoints du Digital Product Passport sont documentés dans leur propre section Digital Product Passport — y compris les références de schéma pour les batteries et le textile, le validateur de conformité UE ainsi que le résolveur GS1 public.
URLs de base par environnement
| Environnement | URL de base | Objectif |
|---|---|---|
| Production | https://qr3.app/v1/ | API live publique |
| Stage | https://qr3-api-stage.<account>.workers.dev/v1/ | Pilote de pré-production (voir ENVIRONMENTS.md) |
| Local | http://localhost:8787/v1/ | pnpm --filter api dev |
La spécification OpenAPI est disponible à l’adresse https://qr3.app/v1/openapi.json et est automatiquement mise à jour à chaque déploiement.