☰ Μενού · Επισκόπηση
Loyaltyfy API
Συνδέστε ταμείο, σύστημα κρατήσεων, kiosk ή τη δική σας εφαρμογή με τις κάρτες επιβράβευσης, τα QR μενού και τις παραγγελίες από το τραπέζι του Loyaltyfy.
Το Loyaltyfy λειτουργεί προγράμματα επιβράβευσης και ψηφιακά μενού για εστιατόρια, καφέ, καταστήματα και κομμωτήρια. Ο πελάτης έχει την κάρτα του στο Apple Wallet ή στο Google Wallet· η επιχείρηση βλέπει κάθε επίσκεψη και κάθε απόδειξη. Το API επιτρέπει στα συστήματα που ήδη χρησιμοποιεί η επιχείρηση να συμμετέχουν: το ταμείο προσθέτει cashback όταν κλείνει μια απόδειξη, ένα kiosk στην είσοδο βάζει σφραγίδα για την επίσκεψη, ένα σύστημα κρατήσεων επιβραβεύει ένα ραντεβού που πραγματοποιήθηκε, το POS παραλαμβάνει τις παραγγελίες που στέλνουν οι πελάτες από το QR μενού.
Είναι ένα απλό REST API πάνω από HTTPS. Αιτήματα και απαντήσεις είναι σε JSON, τα ποσά είναι ακέραιοι στη μικρότερη υποδιαίρεση του νομίσματος (12500 σημαίνει 125.00) και οι χρόνοι σε ISO 8601. Κάθε επιχείρηση έχει τα δικά της κλειδιά, οπότε μία σύνδεση εξυπηρετεί όσες επιχειρήσεις θέλετε: αποθηκεύετε ένα κλειδί ανά επιχείρηση και το στέλνετε σε κάθε κλήση.
Από πού να ξεκινήσετε
Βρείτε τον πελάτη με κάρτα, τηλέφωνο ή barcode, περάστε μια απόδειξη, εξαργυρώστε cashback, ακυρώστε μια επιστροφή, εκδώστε κάρτες με τους δικούς σας αριθμούς.
Συγχρονίστε τιμές και λίστα εξαντλημένων, λάβετε παραγγελίες από το τραπέζι, τρέξτε το πρόγραμμα επιβράβευσης στο ταμείο του καφέ.
Μετατρέψτε κάθε σάρωση σε μέλος και λίστα επιτρεπτών ενεργειών. Εγγράψτε πελάτες από tablet. Βάλτε σφραγίδα για επίσκεψη χωρίς απόδειξη.
Επιβραβεύστε ραντεβού που πραγματοποιήθηκαν, συγχρονίστε πελάτες, δείτε πώς το κάνει η ενσωματωμένη σύνδεση με το Altegio.
Βασικό URL
Όλα τα endpoints βρίσκονται κάτω από το https://loyaltyfy.io/api/v1. Οι διαδρομές σε αυτή την τεκμηρίωση ξεκινούν από το /v1, άρα GET /v1/members σημαίνει GET https://loyaltyfy.io/api/v1/members.
Βασικά αντικείμενα
| Αντικείμενο | Τι είναι |
|---|---|
| member | Πελάτης εγγεγραμμένος στο πρόγραμμα επιβράβευσης της επιχείρησης, με μία κάρτα Wallet. Τον βρίσκετε με αριθμό κάρτας, barcode, τηλέφωνο ή id. |
| transaction | Μία κλεισμένη απόδειξη που έστειλε ένα ταμείο. Δίνει cashback ή σφραγίδες, μπορεί να εξαργυρώσει cashback, μπορεί να ακυρωθεί. |
| visit | Check-in χωρίς απόδειξη, από kiosk, σαρωτή ή σύστημα κρατήσεων. |
| menu, menu_item | Το QR μενού της επιχείρησης: κατηγορίες, πιάτα, τροποποιητές, τιμές, λίστα εξαντλημένων. |
| order | Καλάθι που έστειλε ένας πελάτης από το QR μενού στο τραπέζι. Το POS το αποδέχεται και το περνά από τις καταστάσεις. |
| event | Κάτι που συνέβη (περάστηκε απόδειξη, καταχωρίστηκε παραγγελία), το οποίο παραδίδεται στο webhook endpoint σας. |
Επόμενο βήμα
Κάντε την πρώτη σας κλήση στη Γρήγορη εκκίνηση. Με ένα δοκιμαστικό κλειδί χρειάζεται περίπου πέντε λεπτά.