REST API
Η πηγή Rest API σας επιτρέπει να συνδέσετε τον ελεγκτή τιμών με οποιοδήποτε σύστημα επιστρέφει σε JSON το όνομα και την τιμή ενός προϊόντος για δεδομένο κωδικό — π.χ. ένα ηλεκτρονικό κατάστημα, ένα σύστημα POS ή τη δική σας ενδιάμεση υπηρεσία.
Πώς λειτουργεί
- (Προαιρετικά) Όταν ξεκινά η εφαρμογή και μετά την αποθήκευση των ρυθμίσεων, ο ελεγκτής τιμών φέρνει ένα διακριτικό (token) από το URL του διακριτικού.
- Μετά από κάθε σάρωση στέλνει αίτημα στο URL δεδομένων, όπου το
{code}αντικαθίσταται από τον σαρωμένο κωδικό. Αν έχει διακριτικό, προσθέτει την κεφαλίδαAuthorization: Bearer <token>. - Διαβάζει το όνομα, την τιμή και προαιρετικά το EAN από την απάντηση JSON — με τις διαδρομές που ορίζετε.
Λειτουργούν και το http:// και το https://. Η εφαρμογή περιμένει περίπου 10 δευτερόλεπτα για απάντηση.
Πεδία
Διακριτικό (προαιρετικό) — αφήστε το Url to token κενό αν το API δεν απαιτεί έλεγχο ταυτότητας.
| Πεδίο | Τι να εισαγάγετε | Παράδειγμα |
|---|---|---|
| Url to token | Η διεύθυνση που επιστρέφει το διακριτικό. | https://api.example.com/auth |
| GET / POST | Μέθοδος του αιτήματος διακριτικού. | POST |
| Body request | Το σώμα JSON που στέλνεται με POST (το πεδίο φαίνεται μόνο για POST). | {"user":"pricechecker","password":"…"} |
| Path to token | Πού βρίσκεται το διακριτικό στην απάντηση JSON. | token ή $.data.token |
Δεδομένα προϊόντος
| Πεδίο | Τι να εισαγάγετε | Παράδειγμα |
|---|---|---|
| Url to data | Η διεύθυνση του αιτήματος προϊόντος· το {code} αντικαθίσταται από τον σαρωμένο κωδικό. | https://api.example.com/price?code={code} |
| GET / POST | Μέθοδος του αιτήματος προϊόντος. | GET |
| Body request | Το σώμα JSON για POST· μπορείτε να χρησιμοποιήσετε και εδώ το {code}. | {"ean":"{code}"} |
| Path to name | Διαδρομή προς το όνομα του προϊόντος στην απάντηση. | product.name |
| Path to price | Διαδρομή προς την τιμή· η τιμή πρέπει να είναι αριθμός. | product.price |
| Path to EAN (optional) | Διαδρομή προς τον κωδικό EAN που εμφανίζεται κάτω από την τιμή. Κενό = κάτω από την τιμή εμφανίζεται ο σαρωμένος κωδικός. | product.ean |
Οι διαδρομές χρησιμοποιούν σύνταξη JsonPath: τα product.name και $.product.name σημαίνουν το ίδιο, ένα στοιχείο πίνακα είναι π.χ. $.items[0].price. Τα αιτήματα POST στέλνονται με την κεφαλίδα Content-Type: application/json; charset=utf-8.
Παράδειγμα
Το αίτημα μετά τη σάρωση του κωδικού 5901234567890:
GET https://api.example.com/price?code=5901234567890
Authorization: Bearer eyJhbGciOi...
Μια απάντηση που καταλαβαίνει ο ελεγκτής τιμών:
{
"product": {
"name": "Coffee beans 1 kg",
"price": 59.99,
"ean": "5901234567890"
}
}
Ρυθμίσεις: Path to name product.name, Path to price product.price, Path to EAN product.ean. Επιστρέψτε την τιμή ως αριθμό με δεκαδική τελεία — ο ελεγκτής τιμών τη μορφοποιεί σύμφωνα με το πεδίο Price format.
Απαιτήσεις από το API
- Για προϊόν που βρέθηκε, το API απαντά με κατάσταση 2xx και JSON που περιέχει το όνομα και την τιμή.
- Κάθε άλλη απάντηση (π.χ. 404 για άγνωστο κωδικό, 401 για άκυρο διακριτικό, πεδίο που λείπει από το JSON) εμφανίζει Data download error στην οθόνη. Με το REST API η εφαρμογή δεν δείχνει «Product not found» — αν θέλετε οι πελάτες να ξεχωρίζουν αυτές τις περιπτώσεις, επιστρέψτε π.χ. το όνομα «Product not available» με τιμή 0.
- Ο κωδικός εισάγεται στο URL χωρίς κωδικοποίηση. Οι κωδικοί EAN και τα τυπικά σύμβολα δεν προκαλούν πρόβλημα· αν τα σύμβολά σας περιέχουν κενά ή ειδικούς χαρακτήρες, χρησιμοποιήστε αίτημα POST με τον κωδικό στο σώμα.
- Το διακριτικό φέρνεται μόνο όταν ξεκινά η εφαρμογή και μετά την αποθήκευση των ρυθμίσεων — η εφαρμογή δεν το ανανεώνει μόνη της. Χρησιμοποιήστε διακριτικό μεγάλης διάρκειας ή κλειδί που δεν λήγει· όταν το διακριτικό λήξει, βοηθά η επανεκκίνηση της εφαρμογής.
Το Connection test στις ρυθμίσεις ελέγχει μόνο το αίτημα διακριτικού. Όταν το URL του διακριτικού είναι κενό, το τεστ πετυχαίνει πάντα — ο πραγματικός έλεγχος είναι η σάρωση μερικών προϊόντων μετά την αποθήκευση των ρυθμίσεων.