Remise : notify et unlock
notify déclenche la remise d’un message à son destinataire. unlock rend un message accessible à son destinataire. L’appel à utiliser dépend de qui assure la remise — Livstick, ou vous.
Avant cette page
Cette page suppose que vous savez déjà lire les états pending_release, released, delivery_triggered et unknown d’un message. États des conteneurs et des messages
notify ou unlock : qui assure la remise ?
Appelez notify lorsque Livstick doit envoyer l’e-mail ou le SMS qui informe le destinataire que son message est prêt. Appelez unlock lorsque votre propre canal — votre modèle d’e-mail, votre carte imprimée, votre QR code — assure déjà la remise, et que vous avez seulement besoin que Livstick rende le message visible au moment où ce canal atteint le destinataire.
notify
POST /containers/{crid}/notify requiert le scope containers:notify. Son corps est facultatif et permet de remplacer les coordonnées de l’expéditeur ou du destinataire utilisées pour cette remise, avec la même structure sender / recipient qu’à la création du conteneur.
curl -X POST https://client-api.v5.livstick.com/api/v3/containers/{crid}/notify \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-d '{ "recipient": { "email": "recipient@example.com" } }'unlock
POST /containers/{crid}/unlock requiert le scope containers:unlock. Il ne prend pas de corps — appelez-le une fois que votre propre canal a atteint le destinataire, et Livstick lui rend le message accessible.
curl -X POST https://client-api.v5.livstick.com/api/v3/containers/{crid}/unlock \
-H "Authorization: Bearer {ACCESS_TOKEN}"Votre situation → l’appel à effectuer
Repérez la ligne qui correspond à la façon dont le destinataire apprend réellement que son message est prêt.
| Votre situation | L’appel à effectuer |
|---|---|
| Livstick doit envoyer l’e-mail ou le SMS qui parvient au destinataire. | notify |
| Votre propre e-mail, QR code ou carte imprimée assure déjà la remise. | unlock |
| Vous devez envoyer à un autre contact que celui enregistré sur le conteneur. | notify, avec un recipient de remplacement dans le corps |
Où ce choix intervient
Deux scénarios de ce portail sont construits directement autour de ce choix.
- E-commerce : e-mail à la livraison
- Utilise notify — Livstick envoie l’e-mail au destinataire dès que le message est prêt.
- E-commerce : QR code sur une carte physique
- Utilise unlock — la carte assure elle-même la remise, et unlock ne fait qu’ouvrir l’accès.
- Référence des conteneurs
- La référence complète des opérations notify et unlock.