Stempel-Lösch-API (v1)

Die Stempel-Lösch-API ermöglicht das dauerhafte Löschen ausgestellter Stempel.

Gelöschte Stempel können nicht wiederhergestellt werden, und die gesamte zugehörige Historie wird entfernt.
Um mehrere Stempel gleichzeitig zu löschen, verwenden Sie das Dashboard.

Diese API ist ab dem Personal-Tarif verfügbar.

v1-Dokumentation (Legacy).

Für neue Integrationen empfehlen wir die Verwendung der neuesten Version v2.
v1 dient der Aufrechterhaltung bestehender Integrationen und erhält keine neuen Funktionen oder Verbesserungen.

API Version

DELETE

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

Request
Response


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

Request Parameters

stampIdx integer required: Stempel-IDX.

{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer: Antwortcode: 0 = Erfolg, andere Werte = Fehler
message string: Antwortnachricht. Wenn der Code nicht 0 ist, wird eine Fehlermeldung zurückgegeben.
result null

Prüfung numerischer Parameter

Erhält ein numerischer Parameter einen nicht numerischen Wert oder eine Zahl außerhalb des vom Server verarbeitbaren Bereichs, wird die Anfrage sofort mit 400 (Fehlercode 653) abgelehnt.

In diesem Fall ändern sich Stempeldaten und Sammelhistorie überhaupt nicht, und es entsteht weder ein Ereigniseintrag noch eine Webhook-Zustellung. Eine Fehlerantwort bedeutet, dass nichts gespeichert wurde.

Hinweis zur Verhaltensänderung. Bisher verarbeitete v1 die Anfrage auch dann weiter, wenn diese Prüfung fehlschlug. Dadurch konnte der Fehler von der Meldung eines anderen Parameters überschrieben werden, oder ein Teil der Stempeldaten wurde tatsächlich gespeichert, obwohl die Antwort einen Fehler meldete. Jetzt bricht die Verarbeitung wie in der neuesten Version vorher mit 400 ab.

Wann sollte ein Stempel gelöscht werden

Das Löschen eines Stempels ist mehr als nur Datenbereinigung.
Für Nutzer bedeutet es den Verlust aller gesammelten Stempel. Prüfen Sie dies vor der Nutzung der Lösch-API.

Wann Löschen sinnvoll ist

Für Testzwecke erstellte Stempel
Doppelte oder fehlerhafte Stempel, die nie angezeigt wurden
Bereits eingelöste und nicht mehr benötigte Stempel

Wann stattdessen die Update-API verwenden

Stempel bereits beim Nutzer vorhanden → activeYn auf N setzen zur Deaktivierung
Nur Gültigkeit anpassen → endYmd ändern
Vorübergehend deaktivieren → activeYn deaktivieren und bei Bedarf wieder aktivieren

Im Produktivbetrieb mit Vorsicht einsetzen.
Da das Löschen irreversibel ist, sollte bei nutzerbezogenen Daten zuerst die Deaktivierung geprüft werden.

Wichtige Punkte im Betrieb

Stempeldaten sind eng mit der Nutzeraktivität verknüpft, daher sollte das Löschen mit großer Sorgfalt erfolgen.

Das Löschen kann die Berechnung von Anspruchsbedingungen für Belohnungen beeinflussen
Ergebnisse können sich bei kumulativen Kampagnen ändern
Mögliche Nutzerbeschwerden oder Supportfälle sollten berücksichtigt werden

Wenn möglich, sollten Statusänderungen oder die Update-API anstelle von Löschungen bevorzugt werden.

stampIdx ermitteln

stampIdx ist eine eindeutige ID, die bei der Erstellung eines Stempels zurückgegeben wird.

Wenn sie nicht gespeichert wurde, kann sie im Dashboard eingesehen werden.

Da das Löschen irreversibel ist, stellen Sie sicher, dass die stampIdx auf den richtigen Datensatz verweist, bevor Sie die API aufrufen.

Anwendungsfälle

Fehlerhafte Daten entfernen: Doppelt vergebene Stempel aufgrund von Systemfehlern löschen
Testdaten bereinigen: Stempel aus Entwicklungs-, Staging- oder QA-Umgebungen entfernen
Kampagnendaten bereinigen: Nicht mehr benötigte Stempel aus abgeschlossenen oder abgelaufenen Kampagnen löschen