API d’utilisation des récompenses de tampons

L’API d’utilisation des récompenses de tampons marque une récompense (boisson gratuite, réduction, etc.) comme utilisée une fois tous les tampons complétés.

Après utilisation, le tampon ne peut plus être utilisé, et un nouveau doit être émis pour démarrer un nouveau cycle.
Elle est utilisée dans les systèmes de récompense basés sur les visites ou les achats.

Cette API est disponible à partir de l’offre Personal.

PUT

/api/stamp/v1/redeem 

{
    "stampIdx": 394,
    "onsitePwd": "12345"
}

Request Parameters

stampIdx integer required
Stamp IDX.
onsitePwd string
Mot de passe d’authentification du personnel pour les tampons sur site.
Requis uniquement si le tampon a onsiteYn = Y, et doit être saisi par le personnel lors de la validation d’une récompense.
Utilisez la valeur onsitePwd renvoyée par la Validate API. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer
Code de réponse : 0 = Succès, autres valeurs = Erreur
message string
Message de réponse. Si le code n’est pas 0, un message d’erreur est renvoyé.
result null

À quelle étape intervient cette API ?

Il s’agit de la dernière étape du système de tampons.

  • Vérifier que l’accumulation est complète
  • Traiter l’attribution de la récompense
  • Marquer le tampon comme utilisé

Il ne s’agit pas seulement d’un changement d’état, mais de la finalisation du résultat du programme.

Point final du cycle

Cette API représente la dernière étape du cycle de tampons.

Pour l’utilisateur, c’est le moment de recevoir la récompense. Pour le développeur, cela marque la fin d’un cycle et le début du suivant.

Après Redeem, appeler Create permet de maintenir l’engagement.

Cycle complet

  1. Create → Émettre un tampon
  2. Add Stamp → Accumuler
  3. Validate → Vérifier
  4. Redeem → Utiliser la récompense
  5. Create → Démarrer un nouveau cycle

Gestion des tampons en magasin

onsitePwd est requis uniquement si un mot de passe de vérification sur site est activé (onsiteYn = Y).

Le personnel saisit cette valeur pour valider l’utilisation et éviter toute utilisation non autorisée.

Utilisez la valeur onsitePwd fournie par l’API de validation.
Si aucun mot de passe n’est configuré, ce champ peut être ignoré.

Automatisation après utilisation

Vous pouvez automatiser les actions après utilisation de la récompense.

  • Appeler l’API de création de coupons pour émettre une récompense immédiatement
  • Créer un nouveau tampon pour démarrer un nouveau cycle

Ce flux permet d’automatiser l’ensemble du cycle de récompense sans intervention manuelle.

Points clés en opération

Cette API n’est pas seulement une fonctionnalité, mais le point où les résultats métier sont définitivement validés.

Il est essentiel de garantir le flux validation → utilisation, le contrôle transactionnel côté serveur et la journalisation d’audit.