Passer au contenu principal
L’API GetQR est en version bêta et réservée à certains espaces de travail. Certains détails peuvent changer avant la disponibilité générale.
Une création en masse transforme une liste de noms et d’URL en QR codes Website avec un design commun. Elle s’exécute en arrière-plan : lancez-la, suivez sa progression, puis téléchargez l’archive ZIP.

Fonctionnement

1

Lancez la création en masse

Envoyez vos lignes avec Créer à partir de JSON ou Créer à partir d’un fichier CSV. L’API répond 202 avec la création en masse et son id.
2

Suivez sa progression

Appelez Récupérer une création en masse toutes les quelques secondes jusqu’à ce que status vaille completed ou failed.
3

Téléchargez l'archive

Quand status vaut completed, appelez Télécharger l’archive pour obtenir un ZIP des images des QR codes.
  • Limite. Jusqu’à 100 lignes par création en masse.
  • Une à la fois. Une seule création en masse s’exécute par espace de travail. En lancer une autre pendant qu’une est en cours renvoie celle en cours.
  • Idempotence. Chaque requête nécessite une idempotencyKey. Répéter une requête avec la même clé et le même corps renvoie la création en masse déjà lancée. La même clé avec un corps différent renvoie 422.
  • Lignes. Chaque ligne nécessite un name et une url. Consultez Lignes.
  • Offre. La création en masse n’est pas disponible avec l’offre Single QR : la requête renvoie 403 exceeded_limit.

Lignes

  • Nom. Devient le titre du QR code. Espaces superflus supprimés, tronqué à 40 caractères. Les noms répétés (sans tenir compte de la casse) reçoivent un numéro : Menu, Menu 2, Menu 3.
  • URL. Devient la destination. Elle doit être une adresse http ou https avec un vrai domaine, comme example.com/menu, et ne contenir aucun espace. Une URL sans schéma reçoit https://.
  • Lignes vides. Les lignes sans nom ni URL sont ignorées. Une ligne avec un seul des deux est refusée.
Chaque QR code est un QR code website sur un lien court. Consultez Types de QR codes.

En-têtes

string
requis
Bearer suivi de votre clé API. Consultez Authentification.
string
application/json pour Créer à partir de JSON, multipart/form-data pour Créer à partir d’un fichier CSV.

L’objet création en masse

string
ID de la création en masse, par exemple cm2k7x9qb0003ax8eb4f6gh2t.
string
queued, processing, packaging ou completed. Une création en masse échouée ou annulée passe par rollingBack avant failed.
string
Nom du fichier source.
integer
Nombre de lignes.
integer
QR codes créés jusqu’ici.
integer
Images de QR codes générées jusqu’ici.
integer
Progression globale, de 0 à 100. La création va jusqu’à 40, le rendu jusqu’à 90, l’empaquetage correspond à 95, et completed à 100.
boolean
true quand une création en masse en cours n’a pas progressé depuis 2 minutes. Continuez à interroger : Récupérer une création en masse relance une création en masse bloquée.
object | null
Quand status vaut failed : code et message. Une création en masse annulée a le code cancelled_by_user. Une création en masse échouée est annulée dans son intégralité : aucun de ses QR codes n’est conservé.
string | null
Chemin de Télécharger l’archive, une fois que status vaut completed.
string
Date de lancement, ISO 8601.
string
Date de dernière mise à jour, ISO 8601.
string | null
Date de fin, ISO 8601.
string | null
Date d’échec, ISO 8601.

Récupérer la création en masse en cours

GET /api/v1/bulk-qr-creations Renvoie la création en masse encore en cours dans votre espace de travail. Si aucune n’est en cours, renvoie la dernière terminée (completed ou failed) jusqu’à ce qu’elle soit fermée : télécharger son archive ou la fermer dans le tableau de bord a cet effet. Sinon, renvoie null. Utilisez cet endpoint pour reprendre le suivi après un redémarrage.

Créer à partir de JSON

POST /api/v1/bulk-qr-creations Lance une création en masse à partir d’une liste de lignes. Répond 202 Accepted. La création en masse s’exécute en arrière-plan.
object[]
requis
QR codes à créer, jusqu’à 100. Chaque ligne est { "name": "...", "url": "..." } et n’accepte aucun autre champ. Consultez Lignes.
object
requis
Design appliqué à chaque QR code : styles, frameOptions et logoOptions, tous facultatifs. Envoyez {} pour le design par défaut. Les autres champs sont refusés. Consultez Personnalisation.
string
requis
Nom affiché dans le tableau de bord et utilisé pour l’archive, de 1 à 255 caractères.
string
requis
Votre propre clé pour cette création en masse, de 8 à 100 caractères.

Créer à partir d’un fichier CSV

POST /api/v1/bulk-qr-creations/csv Identique à Créer à partir de JSON, mais reçoit les lignes sous forme de fichier CSV envoyé en multipart/form-data. Répond 202 Accepted. Le fichier doit être un .csv de 1 000 000 octets maximum. Sa ligne d’en-tête doit être exactement name,url, suivie de 100 lignes de données au maximum. Consultez Format CSV.
file
requis
Le fichier CSV.
string
requis
L’objet de design, sérialisé en JSON, par exemple {"styles":{"dotsOptions":{"type":"rounded"}}}. Envoyez {} pour le design par défaut.
string
requis
Votre propre clé pour cette création en masse, de 8 à 100 caractères.
string
Nom affiché dans le tableau de bord et utilisé pour l’archive, jusqu’à 255 caractères. Par défaut, le nom du fichier importé.

Récupérer une création en masse

GET /api/v1/bulk-qr-creations/{id} Renvoie le statut et la progression d’une création en masse. Interrogez cet endpoint tant que status vaut queued, processing ou packaging. downloadUrl apparaît dès que l’archive est prête.
string
requis
ID de la création en masse. Récupérez-le dans la réponse de création ou de création en masse en cours.

Annuler une création en masse

DELETE /api/v1/bulk-qr-creations/{id} Arrête une création en masse en cours et supprime les QR codes qu’elle a déjà créés. L’annulation s’effectue pendant la requête : la réponse a donc normalement le status failed et l’error.code cancelled_by_user. Annuler une création en masse déjà échouée la renvoie inchangée.
Une création en masse terminée ne peut pas être annulée : la requête renvoie 400. Supprimez plutôt ses QR codes un par un avec QR codes.
string
requis
ID de la création en masse.

Télécharger l’archive

GET /api/v1/bulk-qr-creations/{id}/download Renvoie une archive ZIP avec un JPEG de 1024 px par QR code, nommé d’après sa ligne : 001-Menu.jpg, 002-Wine list.jpg, etc. L’archive est nommée d’après sourceFilename. Disponible une fois que status vaut completed. Le téléchargement ferme la création en masse : Récupérer la création en masse en cours cesse donc de la renvoyer.
string
requis
ID de la création en masse.

Problèmes courants

Le message indique la ligne. Chaque URL doit être une adresse http ou https avec un vrai domaine, comme example.com/menu. Corrigez la ligne et renvoyez la requête.
La première ligne du CSV doit être name,url, dans cet ordre et en minuscules, sans autre colonne.
Une clé ne peut pas être réutilisée pour un autre lot. Envoyez une nouvelle idempotencyKey.
La création en masse n’est pas encore terminée. Continuez à interroger l’API jusqu’à ce que status vaille completed.
La création en masse est déjà terminée : elle ne peut donc pas être annulée.
Votre espace de travail utilise l’offre Single QR, qui n’inclut pas la création en masse. Passez à une offre supérieure.
Une autre création en masse est encore en cours dans votre espace de travail, ou vous avez réutilisé une idempotencyKey. Attendez qu’elle se termine, ou utilisez une nouvelle clé.

Et ensuite

Personnalisation

QR codes

Création en masse dans l'application

Format CSV