Κλειδιά και δικαιώματα

Κάθε αίτημα στέλνει ένα μυστικό κλειδί στην κεφαλίδα Authorization. Ένα κλειδί ανήκει σε μία επιχείρηση και μπορεί να περιοριστεί σε ό,τι χρειάζεται η σύνδεση.

curl

curl https://loyaltyfy.io/api/v1/account \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

Στείλτε το κλειδί ως Authorization: Bearer <key>. Αιτήματα χωρίς κλειδί, με άγνωστο ή με ανακληθέν κλειδί λαμβάνουν 401.

Δοκιμαστικά κλειδιά και κλειδιά παραγωγής

Τα κλειδιά ξεκινούν με sk_test_ ή sk_live_. Και τα δύο δουλεύουν με την ίδια επιχείρηση και τα ίδια δεδομένα· η διαφορά είναι η σημαία livemode σε ό,τι δημιουργεί το κλειδί, ώστε οι αναφορές και τα webhooks να ξεχωρίζουν τη δοκιμαστική κίνηση. Χρησιμοποιήστε δοκιμαστικά κλειδιά όσο αναπτύσσετε και περάστε σε κλειδί παραγωγής στην πρώτη πραγματική βάρδια.

Δικαιώματα

Ένα κλειδί μπορεί να περιοριστεί σε ορισμένα δικαιώματα (scopes). Μια κλήση που απαιτεί δικαίωμα που δεν έχει το κλειδί λαμβάνει 403 με κωδικό missing_scope. Κλειδί χωρίς δικαιώματα έχει πλήρη πρόσβαση· το προτείνουμε μόνο για τα scripts της ίδιας της επιχείρησης.

Δικαίωμα	Επιτρέπει
members:read	Αναζήτηση και λίστα μελών, ανάγνωση ιστορικού, σάρωση κωδικών.
members:write	Εγγραφή μελών, ενημέρωση προφίλ, σύνδεση αριθμών κάρτας.
members:adjust	Χειροκίνητη προσθήκη ή αφαίρεση cashback με αιτιολογία, όταν το επιτρέπει η επιχείρηση.
transactions:write	Καταχώριση και ακύρωση αποδείξεων, καταγραφή επισκέψεων, εξαργύρωση επιβραβεύσεων, λίστα συναλλαγών.
menu:read	Ανάγνωση μενού και πιάτων.
menu:write	Δημιουργία πιάτων, αλλαγή τιμών, διαχείριση λίστας εξαντλημένων.
orders:read	Ανάγνωση παραγγελιών από τραπέζι.
orders:write	Αποδοχή, απόρριψη και αλλαγή κατάστασης παραγγελιών.
devices:write	Το πακέτο για kiosks και σαρωτές: σαρώσεις, επισκέψεις, εγγραφή και εξαργύρωση επιβραβεύσεων, χωρίς πρόσβαση στη λίστα μελών ή στις αποδείξεις.
catalog:read	Ανάγνωση προϊόντων και κανόνων κατηγοριών.
catalog:write	Ανέβασμα προϊόντων και ονομασία κατηγοριών. Τους κανόνες χρημάτων των κατηγοριών τους ορίζει μόνο ο ιδιοκτήτης.
webhooks:write	Διαχείριση webhook endpoints.

Συνηθισμένοι συνδυασμοί: ένα ταμείο χρειάζεται members:read, members:write, transactions:write. Ένας σαρωτής εισόδου χρειάζεται μόνο devices:write. Ο συγχρονισμός μενού χρειάζεται menu:read και menu:write· προσθέστε orders:read και orders:write αν το POS δέχεται παραγγελίες από τραπέζι.

Ασφαλής φύλαξη κλειδιών

Τα κλειδιά είναι μυστικά. Καλείτε το API από τον server σας ή από το back office του ταμείου, ποτέ από browser ή από δημόσια εφαρμογή κινητού.
Αποθηκεύουμε μόνο ένα hash κάθε κλειδιού. Αν χαθεί ένα κλειδί, ανακαλέστε το στον πίνακα ελέγχου και δημιουργήστε νέο· η αλλαγή ισχύει αμέσως.
Όπου γίνεται, χρησιμοποιήστε ένα κλειδί ανά εγκατάσταση (ανά ταμείο, ανά kiosk). Έτσι η ανάκληση ενός δεν σταματά τα υπόλοιπα, και η τιμή Τελευταία χρήση στον πίνακα ελέγχου δείχνει ποια συσκευή καλεί.