Mit der Loyaltify API kann Ihr Entwickler Loyaltify mit Ihren eigenen Systemen verbinden, etwa einer Kasse, einem Buchungstool oder Ihrer Website. Eine Kasse kann zum Beispiel nach jedem Verkauf automatisch Punkte hinzufügen, sodass Ihr Team die Karte nicht scannen muss.
Diese Anleitung richtet sich an Sie und Ihren Entwickler: wo Sie Ihren API-Schlüssel finden, wo die Dokumentation liegt und was Sie wissen sollten, bevor Sie loslegen.
💡 Gut zu wissen: Das ist Teil des Tarifs Advanced. Wenn Sie in einen kleineren Tarif wechseln, funktioniert es nicht mehr.
Ihren API-Schlüssel finden
Klicken Sie in Loyaltify oben rechts auf Ihren Namen.
Gehen Sie zu Profil und kopieren Sie Ihren API-Schlüssel.
Sie sehen in Ihrem Advanced-Konto keinen API-Schlüssel? Schreiben Sie dem Support über den Live-Chat, dann schalten wir ihn für Sie frei.
⚠️ Behandeln Sie Ihren API-Schlüssel wie ein Passwort. Geben Sie ihn nur an Ihren Entwickler weiter und fügen Sie ihn nie in den Code einer Website oder in einen Link ein.
Die Dokumentation lesen
Die vollständige API-Dokumentation finden Sie unter api.loyaltify.io/api-docs. Ein paar Dinge, die Ihr Entwickler wissen sollte:
Senden Sie den API-Schlüssel bei jeder Anfrage im Header
X-API-Keymit.Verwenden Sie die Live-Adresse
api.loyaltify.io.Wenn Sie einen Endpoint im Browser öffnen, wird „Unauthorized“ angezeigt. Das ist normal, weil der Browser Ihren Schlüssel nicht mitsendet.
Was Sie mit der API tun können
Kunden anmelden über eines Ihrer Anmeldeformulare, zum Beispiel von Ihrer eigenen Website oder App aus. Die Antwort enthält die Kartenlinks des Kunden für Apple Wallet und Google Wallet.
Kunden abrufen samt ihren Transaktionen, ihre Daten aktualisieren oder sie löschen.
Stempel, Punkte oder Guthaben hinzufügen oder Prämien einlösen mit einer Scan-Anfrage, genau wie Ihr Team in der Store App. Was Sie senden, hängt vom Kartentyp ab.
Gut zu wissen
Der QR-Code auf jeder Karte hat immer dasselbe Format:
lytf-, Ihre Store-ID und dann die ID des Kunden. Eine Kasse kann ihn lesen, um den richtigen Kunden zu finden.Jeder Kunde hat zwei IDs: eine kurze Kunden-ID (die auf seiner Karte und in Webhooks) und eine interne Nummer, die manche API-Anfragen verwenden. Die Dokumentation zeigt, wie Sie die eine anhand der anderen nachschlagen.
Sie brauchen Ihre Store-ID? Schreiben Sie dem Support über den Live-Chat.
Mehrere Standorte oder Kassen können alle denselben API-Schlüssel verwenden.
Sie möchten wissen, wenn etwas passiert? Nutzen Sie Webhooks, um eine Nachricht zu erhalten, sobald sich ein Kunde anmeldet oder etwas sammelt.
💡 Sollen wir es für Sie entwickeln? Wir entwickeln auch individuelle Integrationen, gegen ein separates Angebot. Schreiben Sie uns über den Live-Chat, welches System Sie nutzen und was passieren soll.
Brauchen Sie Hilfe?
Wir helfen Ihnen gern!
Wenn Sie Fragen zu der API haben, schreiben Sie uns über den Live-Chat in Loyaltify oder nutzen Sie den Chat-Button unten rechts auf dieser Seite. Unser Team hilft Ihnen gern weiter.