API de suppression des tampons (v1)

L’API de suppression des tampons permet de supprimer définitivement les tampons émis.

Une fois supprimés, ils ne peuvent pas être restaurés et tout l’historique associé est également supprimé.
Pour supprimer plusieurs tampons en une seule fois, utilisez le tableau de bord.

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

Documentation v1 (Legacy).

Pour les nouvelles intégrations, nous recommandons d’utiliser la version la plus récente, v2.
v1 est destinée à la maintenance des intégrations existantes et ne reçoit aucune nouvelle fonctionnalité ni amélioration.

API Version

DELETE

/api/stamp/v1/delete?stampIdx={stampIdx}

Request
Response


DELETE /api/stamp/v1/delete
        ?stampIdx=394

Request Parameters

stampIdx integer required: Stamp IDX.

{
    "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

Validation des paramètres numériques

Si un paramètre numérique reçoit une valeur non numérique ou un nombre dépassant la plage que le serveur peut traiter, la requête est immédiatement refusée avec 400 (code d'erreur 653).

Dans ce cas, les données du tampon et l'historique de cumul ne changent pas du tout, et aucun enregistrement d'événement ni envoi de Webhook n'est produit. Une réponse en échec signifie que rien n'a été enregistré.

Changement de comportement. Auparavant, v1 poursuivait le traitement de la requête même lorsque cette validation échouait. L'erreur pouvait alors être remplacée par le message d'un autre paramètre, ou une partie des données du tampon était réellement enregistrée alors que la réponse signalait une erreur. Le traitement s'arrête désormais avec 400 avant traitement, comme dans la dernière version.

Quand faut-il supprimer un tampon

Supprimer un tampon ne se limite pas à un simple nettoyage de données.
Pour l’utilisateur, cela signifie perdre les tampons accumulés. Vérifiez les points suivants avant d’utiliser l’API.

Cas où la suppression est appropriée

Tampons créés à des fins de test
Tampons dupliqués ou émis par erreur jamais visibles par l’utilisateur
Tampons déjà utilisés et devenus inutiles

Cas où utiliser l’API de mise à jour

Tampons déjà accumulés → définir activeYn sur N pour désactiver
Ajuster uniquement la validité → modifier endYmd
Blocage temporaire → désactiver via activeYn puis réactiver si nécessaire

À utiliser avec prudence en production.
La suppression étant irréversible, privilégiez la désactivation pour les données liées aux utilisateurs.

Points d’attention en production

Les données de tampons sont directement liées à l’historique des actions utilisateur, la suppression doit donc être effectuée avec prudence.

La suppression peut impacter le calcul des conditions d’éligibilité aux récompenses
Les résultats peuvent varier dans les campagnes basées sur l’accumulation
Il faut anticiper les éventuelles réclamations ou demandes utilisateurs

Dans la mesure du possible, privilégiez un changement de statut ou l’utilisation de l’API de mise à jour plutôt que la suppression.

Vérifier le stampIdx

Le stampIdx est un identifiant unique retourné lors de la création d’un tampon.

Si vous ne l’avez pas enregistré, vous pouvez le retrouver via le tableau de bord.

La suppression étant irréversible, vérifiez toujours que le stampIdx correspond au bon tampon avant d’appeler l’API.

Cas d’utilisation

Suppression de données incorrectes : Supprimer les tampons dupliqués dus à des erreurs système
Nettoyage des données de test : Supprimer les tampons créés en développement, staging ou QA
Nettoyage des campagnes : Supprimer les tampons inutiles après la fin ou l’expiration d’une campagne