QR codes et cartes imprimables

Un conteneur peut générer deux objets destinés à être imprimés ou glissés dans un colis : une image de QR code, et une carte imprimable qui associe ce QR code à un texte traduit. Tous deux sont générés à la demande, à partir de l’état actuel du conteneur.

Ce que sont ces fichiers

Le QR code et la carte ne sont pas stockés à l’avance — chaque requête génère le fichier à partir de l’URL d’enregistrement actuelle du conteneur. C’est pourquoi les deux appels ne prennent que l’identifiant du conteneur : il n’y a rien d’autre à configurer.

Le QR code est une image PNG, dimensionnée pour l’impression ou pour être intégrée dans une autre mise en page.
La carte est un PDF qui présente ce même QR code à côté d’un texte traduit dans la langue du conteneur.

Le QR code

Requiert le scope containers:qrcode. Le corps de la réponse est l’image PNG elle-même, sans enveloppe JSON.

GET /containers/{crid}/qrcode

curl https://client-api.v5.livstick.com/api/v3/containers/{crid}/qrcode \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -o qrcode.png

La carte imprimable

Requiert le scope containers:card. Le corps de la réponse est le fichier PDF, prêt à être envoyé à une file d’impression ou joint à une étiquette d’expédition.

GET /containers/{crid}/card

curl https://client-api.v5.livstick.com/api/v3/containers/{crid}/card \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -o card.pdf

Ce qu’encode le QR code

Quelle que soit la façon dont il est demandé, le QR code encode toujours l’URL de lecture du destinataire — jamais un lien d’aperçu, ni le lien de réenregistrement de l’expéditeur. En le scannant, le destinataire arrive directement sur le message, à chaque fois.

L’équivalent en 2.1

L’API Client 2.1 expose le même fichier via un appel de forme différente : elle accepte GET comme POST, et prend les couleurs du QR code en paramètres de requête plutôt qu’un style fixe. {API_BASE} ci-dessous est un espace réservé — l’URL de base de la 2.1 vous est fournie avec vos accès, elle n’est pas publiée ici.

GET / POST /v2.1/client/{key}/{crid}/qrcode

curl "{API_BASE}/v2.1/client/{key}/{crid}/qrcode?dark=000000&light=ffffff"

Préparer l’impression

Générez le QR code ou la carte une fois le conteneur dans l’état où vous comptez l’expédier — et, pour la carte, une fois la langue du destinataire connue, puisque son texte est traduit. Le contenu du QR code ne change plus ensuite : il est lié à l’URL de lecture du conteneur, et non à un instantané pris au moment de la génération, si bien qu’une carte imprimée continue de fonctionner même si vous redemandez le fichier plus tard.