Aller au contenu
Livstick Développeurs

Prérequis

Un jeton d’accès fourni par l’équipe Livstick, et une étape de votre chaîne logistique capable d’appeler l’API et de transmettre un fichier à votre processus d’impression des cartes ou de préparation des colis. Si vous n’avez pas encore de jeton, demandez un accès développeur.

Créer le conteneur au checkout

Comme pour tout conteneur à message unique : un crid, un message. Conservez tout de suite la valeur editKey de la réponse : elle n’est fournie qu’à la création.

POST /containers
curl -X POST https://client-api.v5.livstick.com/api/v3/containers \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "crid": "ORDER-456",
    "language": "en_us"
  }'

Intégrer le Recorder à votre page de confirmation

Transmettez les valeurs urid et editKey du conteneur que vous venez de créer. Le client enregistre sa vidéo avant de quitter la page. Aucun contact du destinataire n’est nécessaire dans ce parcours, puisque la remise passe par le colis et non par Livstick.

HTML page de confirmation de commande
<livstick-widget-v2
  uid="{urid from step 1}"
  domain="example.com"
></livstick-widget-v2>
<script>
  const widget = document.querySelector("livstick-widget-v2");
  widget.editKey = "{editKey from step 1}";
</script>

Récupérer le QR code ou la carte imprimable

Récupérez le QR code brut au format PNG si vous mettez en page votre propre carte, ou le PDF prêt à l’emploi si vous préférez la carte conçue par Livstick : son texte imprimé suit la langue définie sur le conteneur. Dans les deux cas, le QR code encode toujours l’URL de lecture destinée au destinataire, jamais un lien d’aperçu. Générez le fichier dès que votre chaîne logistique dispose du crid, puis transmettez-le au processus qui imprime ou insère la carte : son contenu ne change plus ensuite.

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

# or, for the ready-made PDF card:
curl https://client-api.v5.livstick.com/api/v3/containers/ORDER-456/card \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  --output card.pdf

Déverrouiller le message à l’expédition de la carte

Une fois la carte glissée dans le colis et celui-ci expédié, appelez unlock, et non notify. Ici, c’est vous qui assurez la remise, au moyen de la carte physique plutôt que d’un message envoyé par Livstick ; c’est unlock qui rend le message accessible à quiconque scanne le code.

POST /containers/{crid}/unlock
curl -X POST https://client-api.v5.livstick.com/api/v3/containers/ORDER-456/unlock \
  -H "Authorization: Bearer {ACCESS_TOKEN}"

Intégration à votre chaîne logistique

Générez le QR code ou la carte dès que le conteneur existe : inutile d’attendre l’enregistrement de la vidéo, et le contenu du fichier ne changera pas, vous pouvez donc l’imprimer et l’emballer sans risque avant l’expédition. Pour comprendre ce qui distingue unlock de notify, et savoir quand utiliser l’un ou l’autre, consultez la page de concept « Remise : notify et unlock ».