API QR Suisse : documentation de l'API REST
QR Suisse propose une API REST permettant de créer, lire, modifier, archiver et supprimer vos QR codes dynamiques par programmation, de les rechercher dans votre liste, de télécharger leur image (PNG ou SVG), ainsi que de consulter leurs statistiques de scan. Elle s'intègre à vos outils existants — Zapier, Make, un CRM, un script interne — partout où une requête HTTPS suffit.
L'API est disponible avec les plans Pro et Entreprise. Le plan Pro inclut 5 créations de QR via l'API par mois et 1 clé API ; le plan Entreprise inclut 100 créations par mois et jusqu'à 10 clés API actives simultanément. Avec l'un comme avec l'autre, des packs de créations API peuvent être achetés en option. Les clés se gèrent depuis le tableau de bord. Voir nos tarifs pour le détail des plans et des packs.
Créer une clé, choisir ses droits, la faire tourner ou la révoquer : la fiche d'aide Gérer vos clés API explique tout, y compris les quotas, le gel au plan Gratuit et la limite de débit.
Version actuelle de l'API : 1.1.1. Les nouveautés de chaque version et notre engagement de compatibilité figurent dans la section Historique des versions de la référence ci-dessous.
Télécharger la spécification OpenAPI
Pour commencer
- Passez au plan Pro ou Entreprise si ce n'est pas déjà fait.
- Générez une clé API depuis votre tableau de bord et choisissez les droits nécessaires (lecture, création, modification, suppression, statistiques).
- Authentifiez chaque requête avec l'en-tête Authorization: Bearer <clé>.
- Consultez la référence complète des endpoints ci-dessous.
Questions fréquentes
Quels plans donnent accès à l'API ?
Quelles opérations l'API permet-elle aujourd'hui ?
Puis-je connecter l'API à un automate ou un agent IA ?
Y a-t-il une limite au nombre d'appels ou de créations ?
Ce que fait l'API, ce que fait le tableau de bord
L'API et le tableau de bord agissent sur les mêmes QR codes, mais ne couvrent pas les mêmes opérations. Le tableau ci-dessous décrit ce qui est disponible aujourd'hui. L'API est réservée aux plans Pro et Entreprise. Le tableau de bord est disponible sur tous les plans ; les fonctions réservées aux plans Pro et Entreprise y sont signalées.
| Opération | API | Tableau de bord |
|---|---|---|
| Créer un QR code Lien | Oui. Pour un e-mail, un téléphone, un SMS ou un serveur FTP, envoyez l'adresse complète (mailto:, tel:, sms:, ftp://). | Oui, avec des assistants : objet et message préremplis, paramètres UTM. |
| Créer une carte de visite | Oui. | Oui. |
| Créer un QR Calendrier | Non documenté : l'API n'a ni champ d'événement (titre, horaires, lieu) ni endpoint dédié. Créez les QR Calendrier dans le tableau de bord. | Oui. |
| Modifier la destination, le libellé ou une carte de visite | Oui. Une carte de visite peut être modifiée en partie : les champs non envoyés restent inchangés. | Oui, depuis la page du QR code. |
| Archiver ou réactiver | Oui, un QR code à la fois, avec le champ active de la modification. Ni l'archivage ni la réactivation ne sont comptés dans le quota de créations. | Oui, QR code par QR code, ou jusqu'à 100 à la fois (Pro et Entreprise). |
| Supprimer définitivement | Oui. | Oui, un QR code à la fois. |
| Lister les QR codes | Oui, page par page, avec recherche dans le libellé, la destination et la fin de l'adresse courte, filtres (actif ou archivé, type, période de création) et tri (date de création, libellé). Ni filtre par auteur ou par étiquette, ni tri par nombre de scans. | Oui, avec recherche, filtres (statut, type, auteur, étiquettes) et tri. |
| Étiquettes | Non. | Oui (Pro et Entreprise). |
| Actions groupées, téléchargement en ZIP, export CSV | Non. Les images se téléchargent une par une. | Oui, jusqu'à 100 QR codes à la fois (Pro et Entreprise). |
| Télécharger l'image en PNG ou en SVG | Oui. PNG de 128 à 1024 pixels de côté, au choix. | Oui. |
| Statistiques de scan | Total et nombre de scans par jour d'un QR code, sur 15 mois, sans choix de période. | Courbe de chaque QR code, et page Statistiques filtrable par QR code et par période. Historique : 7 jours au plan Gratuit, 15 mois avec Pro et Entreprise. |
| Adresse avec votre domaine personnalisé | Oui : quand votre domaine est actif, l'adresse et l'image renvoyées par l'API l'utilisent. | Oui, configuration comprise (Pro et Entreprise). |
| Suivre les créations via l'API du mois | Oui, avec GET /usage (droit QR_CREATE) : créations du mois, quota mensuel, crédits restants dans vos packs et date de remise à zéro. Une création refusée renvoie aussi 429 quota_exceeded avec la date de remise à zéro. | Oui, dans l'écran Clés API (permission « Gérant des clés API » ou Administrateur). |
| Clés API, membres et permissions, abonnement, achat de packs | Non. | Oui, selon votre plan et vos permissions. |
- Dans le tableau de bord, le type d'un QR code (Lien, Carte de visite ou Calendrier) est fixé à la création. Via l'API, la destination d'un QR code Lien ou Calendrier peut être remplacée par n'importe quelle adresse acceptée : un Calendrier peut ainsi devenir un Lien, et inversement. Une carte de visite reste une carte de visite. Des deux côtés, l'adresse courte encodée dans l'image ne change jamais.
- Ni l'API ni le tableau de bord n'envoient de notification automatique (webhook), par exemple lors d'un scan ou quand le quota est atteint.
- Pour relancer sans créer de doublon une création interrompue par un délai dépassé ou une coupure réseau, envoyez-la avec l'en-tête Idempotency-Key (une valeur aléatoire par création, UUID v4 recommandé) : renvoyée avec la même valeur d'Idempotency-Key et le même contenu dans les 24 heures, elle renvoie le QR code déjà créé, sans en créer un second ni consommer une autre création du quota. Sans cet en-tête, vérifiez la liste de vos QR codes avant de relancer : une création aboutie reste comptée dans le quota, même si vous supprimez ensuite le QR code en double.