Chat with us, powered by LiveChat
Home > Plattform > Integrations-APIs

Loyalty Plattform Schnittstellen Übersicht

Unsere Plattform bietet ein umfassendes Set and APIs für die schnelle Integration in verschiedene Systeme, wie z.B. Registrierungs-API, Punktestands-API, Status-Check-API, Status-Benefit-Check API, Transaktions-API u.v.m. Verschaffen Sie sich einen Überblick zu unserer umfassenden Schnittstellen-Bibliothek.

Schnittstellen Kurzbeschreibung

SymbolAuthentifizierung

API NameKurzbeschreibung
Erzeugung-Zugangs-Token-API Diese API erzeugt ein Zugangs-Token (Auth Token), das für den Aufruf aller APIs mit OAuth 2.0-Authentifizierung verwendet werden muss

SymbolMitglieder-Authentifizierung & Registrierung

API NameKurzbeschreibung
Login-API Diese API authentifiziert ein Mitglied über seine Anmeldeinformationen (Web / App)
Logout-API Diese API beendet die aktuelle Sitzung des Mitglieds und meldet ein Mitglied von einer Website oder mobilen Anwendung ab, in der sich das Mitglied angemeldet hat
Mitglieder-Authentifizierung Diese API ermöglicht es einem Mitglied, eine PIN / ein Passwort für Punkte-Einlösetransaktionen einzurichten oder zu aktualisieren
Mitgliedskarten-Validierungs-API Diese API authentifiziert eine Mitgliedskartennummer und übermittelt die Stufe (Status) eines Mitglieds
Registrierungs-API Diese API registriert einen Kunden als Mitglied im Loyalty Programm. Sie kann auch zur Aktualisierung der Registrierungsdaten des Mitglieds verwendet werden

SymbolMitgliederdaten

API Name Kurzbeschreibung
Abonnement-Kündigung Diese API kündigt ein oder mehrere gültige Abonnements eines Mitglieds.
Alle-Angebote-Abruf-API Diese API stellt die Liste aller verfügbaren Vorteile (Benefits) einschließlich der Vorteilsgutscheine für ein Mitglied zur Verfügung.
Aufrufen-aller-verfügbarer-Benefits-API Diese API liefert die Liste der Vorteile (Benefits) mit den verbleibenden Nutzungsbegrenzungen (Limits), die einem Mitglied zur Verfügung stehen.
Gutschein-Authentifizierungs-API Diese API wird verwendet, um einen eindeutigen Gutscheincode (der an ein Mitglied vergeben wird) zu authentifizieren und ihn dann als „verwendet“ zu kennzeichnen. So wird ein Gutschein nur einmal eingelöst.
Gutschein-Historie-API Diese API stellt die Liste der verwendeten und ungenutzten Gutscheine für ein Mitglied zur Verfügung.
Gutschein-ZuordnungDiese API weist einem Mitglied einen Vorteil oder Vorteilsgutschein unabhängig von seinem Status-Level zu
Kartenaustausch Diese API ersetzt die alte Kartennummer durch eine neue Kartennummer für ein Mitglied
Mitglieder-Abonnements-Abruf-API Diese API zeigt die Liste aller Abonnements, die dem Mitglied zugeordnet sind
Mitglieder-Identität Diese API fügt einen Alias für ein Mitglied hinzu oder aktualisiert diesen
Mitgliedsinformationen nach Alias-ID Diese API stellt die Profilinformationen und Infos zum Punkte-Guthaben eines Mitglieds unter Verwendung einer Alias-ID zur Verfügung.
Mitgliedsinformationen-API Diese API stellt die Informationen über ein Mitglied zur Verfügung, einschließlich Profil- und punktebezogener Infos
Mitgliedskonto-Historie Diese API stellt die (nichtpunkte-basierte) Historie der Aktivitäten eines Mitglieds zur Verfügung, einschließlich der Registrierung, der Status-Bewegungshistorie und der Einlösung von Vorteilen (Benefits)
Mitgliedswährung hinzufügen Diese API fügt die bevorzugte Währung eines Mitglieds hinzu
Passwort-Ändern-API Diese API ermöglicht es einem Mitglied, sein Passwort zu ändern
Passwort-Vergessen-API Diese API sendet eine E-Mail (an die registrierte E-Mail-Adresse des Mitglieds) mit einem Link, der es dem Mitglied ermöglicht, sein Passwort zurückzusetzen
Punkte-Status-Überprüfung-API Die API liefert den Punktestand eines Mitglieds und statusbezogene Informationen.
Punkte-Verfall-API Diese API lässt die Anzahl der Prämienpunkte vom Konto eines Mitglieds verfallen, gemäß dem Prozentsatz des Verfalls, der im API-Anforderungsparameter vom Saldo festgelegt wurde.
Status-Vorteile-Überprüfung-API Diese API prüft, ob das Mitglied Anspruch auf einen Vorteil (Benefit) oder einen Vorteilsgutschein hat. Die API löst auch einen anspruchsberechtigten Vorteil ein oder stellt einem Mitglied einen Vorteilsgutschein aus.
Transaktionshistorie-API Diese API stellt die Punkte-Transaktionshistorie eines bestimmten Mitglieds zur Verfügung. Darin enthalten sind alle Sammel- als auch Einlösetransaktionen, Rückabwicklungs- und Verfall-Transaktionen
Verfallen-der-Mitgliedspunkte-Abruf-API Diese API liefert Informationen über bereits verfallene oder bald verfallende Punkte eines Mitglieds

SymbolMitgliedersegmentierung

API NameKurzbeschreibung
Segment-Mitglieder-Zuordnung-API Diese API fügt ein Mitglied einem Segment hinzu oder entfernt es
Zuordnung-Promotion-Segmente-API Diese API ordnet ein Mitglieder-Segment einer Aktion (Promotion) zu und erhält Informationen über die Segmentdatei, um die Mitglieder auszulesen und dem Segment zuzuordnen.

SymbolProgrammdetails

API NameKurzbeschreibung
Abruf-Kunden-Kommunikationskanal-API Diese API enthält die Liste aller Kommunikationskanäle (wie E-Mail, SMS usw.), die für das Senden von Nachrichten an Mitglieder verwendet werden können.
Abruf-Kunden-Kommunikationskategorie-API Diese API stellt die Liste aller Kommunikationskategorien zur Verfügung, die zum Bestimmen der Kommunikationseinwilligung eines Mitglieds verwendet werden
Abruf-Kundensprache-API Diese API enthält die Liste der Sprachen, in denen das Programm konfiguriert wurde
Abruf-Master-Daten-API Diese API stellt die Informationen zur Verfügung, die zu den spezifizierten Master-Daten gespeichert sind (z.B. Liste der Produktkategorien oder Städte).
Identitätsanbieter Diese API ruft alle Daten von registrierten Identitätsanbietern ab (die für die Alias-Verwaltung eingerichtet wurden)
Master hinzufügen/aktualisieren Diese API aktualisiert oder fügt Informationen zu jeglicher benutzerdefinierten Master-Entität hinzu
Partner hinzufügen Diese API fügt einen Partner hinzu oder aktualisiert die Informationen zu einem Partner.
Partner-Aufruf-API Diese API liefert die Liste der Partner
Partner-Historie Diese API wird verwendet, um die Historie der Punktetransaktionen bei Partnern innerhalb eines bestimmten Zeitraums abzurufen, die auch Details zu Sammel-, Einlösungs-, Stornierung- und Verfallspunkten enthält.
Punkte-Einlösung-Partner-Austausch Diese API liefert alle Informationen über Punkteeinlösung-Austausch-Partner

Programmregeln & Vorteile

API NameKurzbeschreibung
Abonnement-API Diese API wird verwendet, um abonnementbasierte Pläne für jegliches Mitglied des Loyalty Programms anzubieten .
Abruf-aller-Promotions-API Diese API liefert eine Liste der im System verfügbaren Aktionen (Promotions)
Einlöse-Schwellenwert Diese API legt die Punktegrenze des Mitglieds für eine Einlösetransaktion fest. Bei Überschreitung dieser Grenze muss ein Mitglied die Einlösung mit seiner PIN bestätigen
Gewinnspiele abrufen Diese API stellt die Liste der Gewinnspiele/ Wettbewerbe zur Verfügung, die im Programm eingerichtet wurden oder die für ein bestimmtes Mitglied gültig sind.
Hinzufügen/Aktualisieren von Promotions Diese API fügt eine Aktion (Promotion) hinzu oder aktualisiert sie
Identifizierung und Aktualisierung der Mitgliedsstufe Diese API aktualisiert eine Mitgliedsstufe/-status (z.B. aktiv, deaktiviert, etc.) eines Mitglieds
Losvergabe Diese API ermöglicht es einem Mitglied, an einem Gewinnspiel/ einem Wettbewerb teilzunehmen.
Manuelle Status-Aktualisierung Diese API aktualisiert die Statusstufe eines Mitglieds unabhängig von den Statusregeln

Sammeln und Einlösen

API NameKurzbeschreibung
Alle Transaktionen-API Diese API bietet eine zentrale Schnittstelle für alle Arten von Transaktionen wie das Sammeln, die Rückabwicklung, das Verfallen von Punkten, die teilweise Rückabwicklung, das Einlösen und die Einöse-Rückabwicklung
Einlösen-von Punkte-Gutschein-API Diese API stellt einen Einlösungsgutschein aus, wenn die Punkte eines Mitglieds eingelöst werden.
Einlöse-Rückabwicklungs-API Diese API schreibt dem Mitgliedskonto Punkte gut, indem er eine Einlösetransaktion rückgängig macht
Einlösungs-API Diese API löst die Punkte eines Mitglieds ein
Event-Belohnungs-API Diese API belohnt ein Mitglied mit Bonuspunkten, die auf einer Maßnahme/Aktion eines Mitglieds basieren, z.B. Belohnungspunkte für Social Media-Aktivitäten, Teilnahme an Umfragen etc.
Freischaltung-der-Punkte-API Diese API entsperrt eine Transaktion mit gesperrten Punkten (die entsperrten Punkte sind nun einlösbar)
Punkte-Sperrung Diese API sperrt eine Punktetransaktion auf dem Konto eines Mitglieds für die Einlösung (gesperrte Punkte können nicht eingelöst werden)
Sammel-API Diese API berechnet und bucht die Punkte auf dem Konto eines Mitglieds basierend auf Transaktionsdetails und den Promotion-Regeln, die für die Transaktion gültig sind
Sammel-Rückabwicklungs-API Diese API storniert eine komplette Punkte-Transaktion eines Mitglieds, indem sie negative (Storno-)Punkttransaktionen bucht
Teilweise-Sammel-Rückabwicklungs-API Diese API ermöglicht die teilweise Stornierung von Sammel-Transaktionen (z.B. Rückgabe einiger Artikel und nicht des gesamten Warenkorbs), indem die ursprüngliche Transaktion storniert und Punkte auf der Grundlage der verbleibenden Produkte neu berechnet werden
Warenkorb-Punkte-Auswertungs-API Diese API gibt die Punkte aus, die ein Mitglied (oder ein Gastkonto) für sämtliche Live-Promotions sammeln würde, basierend auf den Transaktionsdetails, die gesendet werden