Cadeau collectif
Des collègues ou des amis veulent chacun laisser leur propre message pour un même cadeau, et le destinataire découvre tous les messages en même temps. C’est le rôle du conteneur gallery : il contient plusieurs messages au lieu d’un seul, et l’enregistrement de chaque contributeur s’ajoute au même conteneur au lieu de remplacer le précédent.
Prérequis
Un jeton d’accès, et une idée claire de ce qui distingue les modes de conteneur : le mode est fixé à la création, choisissez donc gallery avant votre premier appel. Consultez Modes de conteneur.
Créer le conteneur en mode gallery
Donnez à mode la valeur gallery dans l’appel même qui crée le conteneur. mode est ignoré si un conteneur existe déjà pour ce crid : c’est donc le seul moment où vous pouvez le choisir. Aucun appel ultérieur ne permet de faire passer un conteneur existant de single à gallery.
curl -X POST https://client-api.v5.livstick.com/api/v3/containers \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-d '{ "crid": "TEAM-GIFT-042", "mode": "gallery" }'
Faire enregistrer chaque contributeur
uid correspond à l’urid du conteneur, la même valeur pour tous les contributeurs. Comme le conteneur a été créé en mode gallery, chaque passage dans le Recorder (un par contributeur) ajoute un nouveau message au conteneur au lieu d’écraser le précédent.
<LivstickWidget uid="TEAM-GIFT-042" domain="example.com" />
Relire les messages
Filtrez /messages par crid pour relire ce que la galerie a recueilli jusqu’ici. Si N contributeurs ont enregistré, l’appel renvoie N messages pour ce conteneur.
curl "https://client-api.v5.livstick.com/api/v3/messages?crid=TEAM-GIFT-042" \
-H "Authorization: Bearer {ACCESS_TOKEN}"
Déverrouiller le conteneur
unlock rend les messages recueillis accessibles au destinataire. Appelez-le lorsque vous considérez la collecte comme terminée : unlock n’est pas idempotent, c’est donc une étape délibérée, à ne pas répéter à chaque passage d’un contributeur.
curl -X POST https://client-api.v5.livstick.com/api/v3/containers/TEAM-GIFT-042/unlock \
-H "Authorization: Bearer {ACCESS_TOKEN}"
Pour aller plus loin
La Client API se limite à ajouter des messages à un conteneur gallery : elle ne gère ni cagnotte commune, ni invitations des contributeurs, ni lien partagé entre eux. Distribuer le lien d’enregistrement à chaque contributeur, décider quand clore la collecte, choisir le moment d’appeler unlock : c’est à vous de concevoir ces étapes.