API

Το API της Gem Logic σας επιτρέπει να ενσωματώσετε εξωτερικά συστήματα και να αυτοματοποιήσετε ροές εργασίας. Μπορείτε να το χρησιμοποιήσετε για να διαχειριστείτε προγραμματιστικά προϊόντα, πωλήσεις, επαφές, επισκευές, καταμετρήσεις αποθέματος και εργασίες εκτύπωσης.

Μεταβείτε στο Ρυθμίσεις ‣ API για να δημιουργήσετε και να διαχειριστείτε τα κλειδιά API σας.

Πιστοποίηση

Όλα τα αιτήματα API πρέπει να περιλαμβάνουν ένα κλειδί API στην κεφαλίδα HTTP x-api-key. Μπορείτε να δημιουργήσετε κλειδιά από τη σελίδα Ρυθμίσεις ‣ API. Τα κλειδιά μπορούν να απενεργοποιηθούν ή να διαγραφούν ανά πάσα στιγμή.

Παράδειγμα αιτήματος:

curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
  -H "x-api-key: YOUR_API_KEY"

Κίνδυνος

Διατηρήστε τα κλειδιά API σας μυστικά. Μην τα μοιράζεστε ποτέ σε δημόσια αποθετήρια ή κώδικα πλευράς πελάτη. Αν ένα κλειδί διαρρεύσει, απενεργοποιήστε το αμέσως και δημιουργήστε ένα νέο.

Βασικό URL

Όλα τα endpoints είναι σχετικά με το URL της εγκατάστασής σας, κάτω από το πρόθεμα /api/:

https://your-instance.gem-logic.com/api/

Μορφή απόκρισης

Όλες οι αποκρίσεις επιστρέφονται ως JSON. Τα επιτυχημένα αιτήματα επιστρέφουν κωδικό κατάστασης 200 (για GET) ή 201 (για POST). Τα σφάλματα επιστρέφουν τον κατάλληλο κωδικό κατάστασης με ένα μήνυμα:

• 200 OK — επιτυχημένο αίτημα GET

• 201 Created — επιτυχημένο αίτημα POST

• 400 Bad Request — μη έγκυρα ή ελλιπή δεδομένα

• 401 Unauthorized — μη έγκυρο ή ελλιπές κλειδί API

• 404 Not Found — ο πόρος δεν υπάρχει

Endpoints

Αγορές

Μέθοδος	GET
URL	/api/marketplaces/
Περιγραφή	Επιστρέφει λίστα με όλα τα κανάλια πωλήσεων.

Πεδία απόκρισης:

Πεδίο	Τύπος	Περιγραφή
id	integer	Μοναδικό αναγνωριστικό
marketplace	string	Όνομα marketplace

Προϊόντα

Λίστα προϊόντων

Μέθοδος	GET
URL	/api/products/{marketplace_id}
Περιγραφή	Επιστρέφει προϊόντα φιλτραρισμένα ανά marketplace. Χρησιμοποιήστε το ID του marketplace από το endpoint marketplaces.

Πεδία απόκρισης:

Πεδίο	Τύπος	Περιγραφή
id	integer	Μοναδικό αναγνωριστικό
item_sku	string	SKU προϊόντος
created	datetime	Ημερομηνία δημιουργίας
status	string	Κατάσταση προϊόντος
images	array	Λίστα εικόνων προϊόντος (id, image)
item_weight	decimal	Βάρος
item_height	decimal	Ύψος
item_length	decimal	Μήκος
item_width	decimal	Πλάτος

Δημιουργία εικόνας προϊόντος

Μέθοδος	POST
URL	/api/products/create/image/
Περιγραφή	Ανεβάζει μια εικόνα προϊόντος χρησιμοποιώντας κωδικοποίηση base64. Αν το SKU του προϊόντος δεν υπάρχει ακόμα, ένα νέο προϊόν δημιουργείται αυτόματα.

Πεδία αιτήματος:

Πεδίο	Τύπος	Απαιτείται	Περιγραφή
item_sku	string	Ναι	SKU προϊόντος στο οποίο θα προσαρτηθεί η εικόνα
image	string (base64)	Ναι	Δεδομένα εικόνας κωδικοποιημένα σε base64

Πωλήσεις

Λίστα πωλήσεων

Μέθοδος	GET
URL	/api/sales/
Περιγραφή	Επιστρέφει μια λίστα με όλες τις εντολές πώλησης.

Πεδία απόκρισης:

Πεδίο	Τύπος	Περιγραφή
order_id	string	Μοναδικό αναγνωριστικό εντολής

Δημιουργία πώλησης

Μέθοδος	POST
URL	/api/sales/create/
Περιγραφή	Δημιουργεί μια νέα εντολή πώλησης.

Επαφές

Μέθοδος	GET
URL	/api/contacts/
Περιγραφή	Επιστρέφει μια λίστα με όλες τις επαφές.

Πεδία απόκρισης:

Πεδίο	Τύπος	Περιγραφή
id	integer	Μοναδικό αναγνωριστικό
complete_name	string	Πλήρες όνομα
contact_type	string	Τύπος επαφής
email	string	Διεύθυνση email
phone	string	Αριθμός τηλεφώνου
language	string	Προτιμώμενη γλώσσα

Επισκευές

Δημιουργία επισκευής

Μέθοδος	POST
URL	/api/repairs/create/
Περιγραφή	Δημιουργεί μια νέα παραγγελία επισκευής με συσχετισμένο είδος επισκευής. Εάν δεν παρέχεται σημείο πώλησης ή τμήμα, χρησιμοποιείται το πρώτο διαθέσιμο.

Πεδία αιτήματος:

Πεδίο	Τύπος	Απαιτείται	Περιγραφή
client_id	integer	Όχι	ID του πελάτη/επαφής
marketplace	string / integer	Όχι	ID ή όνομα σημείου πώλησης
division_id	integer	Όχι	ID τμήματος επιχείρησης
title	string	Όχι	Τίτλος ή περιγραφή του είδους επισκευής
repair_info_1	string	Όχι	Επιπλέον σχόλιο επισκευής
repair_info_2	string	Όχι	Επιπλέον σχόλιο επισκευής
repair_info_3	string	Όχι	Επιπλέον σχόλιο επισκευής
quantity	decimal	Όχι	Ποσότητα (προεπιλογή: 1)
weight	decimal	Όχι	Βάρος είδους
weight_unit	string	Όχι	Μονάδα μέτρησης βάρους
size	string	Όχι	Μέγεθος είδους
color	string	Όχι	Χρώμα είδους
engravement	string	Όχι	Κείμενο χάραξης
client_reference | string		Όχι	Αριθμός αναφοράς πελάτη

Παράδειγμα απόκρισης:

{"message": "Repair created successfully.", "order_id": "R-0001"}

Προσθήκη είδους σε επισκευή

Μέθοδος	POST
URL	/api/repairs/add-item/
Περιγραφή	Προσθέτει ένα νέο είδος σε υπάρχουσα εντολή επισκευής.

Πεδία αιτήματος:

Πεδίο	Τύπος	Απαιτείται	Περιγραφή
order_id	string	Ναι	Αναγνωριστικό εντολής της επισκευής στην οποία θα προστεθεί το είδος
item_sku	string	Όχι	SKU προϊόντος για σύνδεση με το είδος
title	string	Όχι	Τίτλος ή περιγραφή
repair_info_1	string	Όχι	Επιπλέον σχόλιο επισκευής
repair_info_2	string	Όχι	Επιπλέον σχόλιο επισκευής
repair_info_3	string	Όχι	Επιπλέον σχόλιο επισκευής
quantity	decimal	Όχι	Ποσότητα (προεπιλογή: 1)
weight	decimal	Όχι	Βάρος είδους
weight_unit	string	Όχι	Μονάδα μέτρησης βάρους
size	string	Όχι	Μέγεθος είδους
color	string	Όχι	Χρώμα είδους
engravement	string	Όχι	Κείμενο χάραξης
client_reference | string		Όχι	Αριθμός αναφοράς πελάτη
cost	decimal	Όχι	Κόστος του είδους

Καταμετρήσεις αποθέματος

Δημιουργία καταμέτρησης αποθέματος

Μέθοδος	POST
URL	/api/inventory-counts/
Περιγραφή	Δημιουργεί νέα συνεδρία καταμέτρησης αποθέματος.

Πεδία απόκρισης:

Πεδίο	Τύπος	Περιγραφή
id	string	Αναγνωριστικό καταμέτρησης αποθέματος
created_at	datetime	Χρονοσήμανση δημιουργίας
status	string	Πάντα active
tag_count	integer	Αριθμός καταμετρημένων προϊόντων

Εμφάνιση προϊόντων καταμέτρησης αποθέματος

Μέθοδος	GET
URL	/api/inventory-counts/{inventory_count_id}/products/
Περιγραφή	Επιστρέφει όλα τα προϊόντα που καταμετρήθηκαν σε συγκεκριμένη καταμέτρηση αποθέματος.

Πεδία απόκρισης:

Πεδίο	Τύπος	Περιγραφή
id	string	Μοναδικό αναγνωριστικό
created_at	datetime	Πότε καταμετρήθηκε το προϊόν
product_sku	string	SKU προϊόντος
product_name	string	Όνομα προϊόντος
quantity	integer	Μετρημένη ποσότητα

Εργασίες εκτύπωσης

Μέθοδος	POST
URL	/api/print-pdf/
Περιγραφή	Ανεβάστε ένα αρχείο PDF στη σειρά εκτύπωσης για έναν συγκεκριμένο εκτυπωτή. Το αρχείο επικυρώνεται ως προς τη μορφή και την ασφάλεια. Μέγιστο μέγεθος αρχείου: 20 MB. Χρησιμοποιήστε τον τύπο περιεχομένου multipart/form-data.

Πεδία αιτήματος:

Πεδίο	Τύπος	Απαιτείται	Περιγραφή
pdf	αρχείο	Ναι	Αρχείο PDF προς εκτύπωση (μέγ. 20 MB)
printer_uuid	UUID	Ναι	UUID του εκτυπωτή-στόχου
landscape	boolean	Όχι	Εκτύπωση σε λειτουργία οριζόντιας διάταξης (προεπιλογή: false)

Παράδειγμα αιτήματος:

curl -X POST https://your-instance.gem-logic.com/api/print-pdf/ \
  -H "x-api-key: YOUR_API_KEY" \
  -F "pdf=@document.pdf" \
  -F "printer_uuid=YOUR_PRINTER_UUID"

Παράδειγμα απόκρισης:

{"status": "queued", "print_job_id": 42}

Διαδραστικός εξερευνητής API

Το Gem Logic περιλαμβάνει έναν ενσωματωμένο διαδραστικό εξερευνητή API που βασίζεται στο Swagger UI. Μπορείτε να τον αποκτήσετε από τον σύνδεσμο Τεκμηρίωση API στη σελίδα Ρυθμίσεις ‣ API. Ο εξερευνητής σάς επιτρέπει να δοκιμάσετε κάθε σημείο πρόσβασης απευθείας από το πρόγραμμα περιήγησής σας.

Δείτε επίσης

• Ενσωματώσεις