API Reference

Το API v1 είναι deprecated

Το API v1 (/api/v1) συνεχίζει να λειτουργεί κανονικά για τις υπάρχουσες διασυνδέσεις, αλλά δεν θα αποκτήσει νέες λειτουργίες. Δεν υπάρχει ακόμα ημερομηνία απενεργοποίησης. Θα ενημερωθείτε έγκαιρα πριν από οποιαδήποτε αλλαγή.

Για νέες διασυνδέσεις χρησιμοποιήστε το API v2, που προσφέρει και παραγγελίες, ακύρωση και ετικέτα αποστολής, κινήσεις υπολοίπου και webhooks. Αντιστοιχία των κλήσεων:

API v1	API v2	Διαφορά
POST /api/v1/orderVoucher, GET /api/v1/getOrderVoucher	POST /api/v2/shipments	Το v2 θέλει το id της παραγγελίας στο CourierHub. Το βρίσκετε με GET /api/v2/orders?order_number=... από τον αριθμό ή το ID του e-shop.
GET /api/v1/supportedCouriers	GET /api/v2/couriers
GET /api/v1/track/{type}/{identifier}	GET /api/v2/shipments/{voucher}/tracking	Το v2 δέχεται τον αριθμό voucher. Για αναζήτηση με αριθμό παραγγελίας χρησιμοποιήστε GET /api/v2/shipments?order_number=....

Το API v2 δέχεται μόνο το API Token του καταστήματος (chub_...), όχι το webhook token.

Περιορισμένη Πρόσβαση

Η χρήση του API απαιτεί ειδικό API Token το οποίο παρέχεται κατόπιν αιτήματος ή μέσω του διαχειριστικού περιβάλλοντος.

Το CourierHub παρέχει REST API για την πλήρη διαχείριση των αποστολών σας προγραμματιστικά.

Βασικές Λειτουργίες

Το API επιτρέπει:

• Create Order: Δημιουργία νέας παραγγελίας στο σύστημα.
• Get Voucher: Έκδοση voucher για συγκεκριμένη παραγγελία.
• Track Shipment: Λήψη πληροφοριών εντοπισμού.
• Cancel Shipment: Ακύρωση εντολής.

Authentication

Όλες οι κλήσεις απαιτούν την κεφαλίδα Authorization: Bearer {YOUR_API_TOKEN}.

Κάθε κατάστημα έχει δικό του API Token (ξεκινά με chub_), διαφορετικό από το webhook token. Το βρίσκετε και το ανανεώνετε στο περιβάλλον πελάτη (/app/settings): Ρυθμίσεις > Διασύνδεση & Καταστήματα > Webhook Settings > (κατάστημα) > API Token. Μετά την ανανέωση το παλιό token σταματά αμέσως να λειτουργεί.

Webhook token ως API token (deprecated)

Μέχρι τώρα το webhook token του καταστήματος (το UUID που υπάρχει στα webhook URLs) λειτουργούσε και ως API token. Γίνεται ακόμα δεκτό για μια μεταβατική περίοδο, αλλά θα καταργηθεί. Χρησιμοποιήστε το API Token. Το webhook token εμφανίζεται στα webhook URLs του e-shop, οπότε δεν πρέπει να θεωρείται μυστικό.

Έκδοση voucher

• POST /api/v1/orderVoucher (body: order_number, προαιρετικά format, courier_name): εκδίδει το voucher της παραγγελίας ή επιστρέφει το υπάρχον. Η έκδοση κάνει κράτηση στην courier και χρεώνει το υπόλοιπο του λογαριασμού.
• GET /api/v1/getOrderVoucher (ίδιες παράμετροι στο query string): deprecated. Κάνει ακριβώς το ίδιο, αλλά ένα GET δεν πρέπει να δημιουργεί voucher ούτε να χρεώνει. Παραμένει μόνο για τις υπάρχουσες διασυνδέσεις και θα καταργηθεί.

Rate limiting

Όλα τα endpoints του /api/v1 μοιράζονται όριο 60 κλήσεων το λεπτό ανά κατάστημα. Πάνω από το όριο η απάντηση είναι 429 Too Many Requests με κεφαλίδα Retry-After (δευτερόλεπτα).

Documentation

Για την πλήρη τεκμηρίωση των endpoints, παρακαλούμε επικοινωνήστε με το τμήμα υποστήριξης