Πίνακας περιεχομένων

  1. Εισαγωγή

  2. Τι είναι το Dolibarr REST API;

  3. Γιατί να ενσωματώσετε το Dolibarr με άλλες εφαρμογές;

  4. Προαπαιτούμενα για τη χρήση του API

  5. Ενεργοποίηση της ενότητας REST API

  6. Κατανόηση του ελέγχου ταυτότητας API στο Dolibarr

  7. Δημιουργία και Διαχείριση API Tokens

  8. Εξερευνώντας τα τελικά σημεία του API Dolibarr

  9. Υποβολή του πρώτου σας αιτήματος API

  10. Λειτουργίες CRUD με το REST API

  11. Χειρισμός σελιδοποίησης, φίλτρων και ταξινόμησης

  12. Απαντήσεις API και Χειρισμός Σφαλμάτων

  13. Περιπτώσεις Χρήσης: Συνήθεις Ενσωματώσεις

  14. Σύνδεση με εξωτερικά CRM ή ERP

  15. Συγχρονισμός προϊόντων, παραγγελιών και τιμολογίων

  16. Σύνδεση με πλατφόρμες ηλεκτρονικού εμπορίου (Shopify, Prestashop)

  17. Ενσωμάτωση με προσαρμοσμένα frontend ή εφαρμογές για κινητά

  18. Βέλτιστες πρακτικές ασφάλειας API

  19. Παρακολούθηση και καταγραφή δραστηριότητας API

  20. Συμπέρασμα

1. Εισαγωγή

Το Dolibarr ERP/CRM είναι ισχυρό από μόνο του, αλλά αποκτά ακόμη μεγαλύτερη αποτελεσματικότητα όταν ενσωματώνεται σε ένα ευρύτερο οικοσύστημα εργαλείων. Είτε πρόκειται για συγχρονισμό με ένα ηλεκτρονικό κατάστημα, είτε για κοινή χρήση δεδομένων με ένα εργαλείο λογιστικής, είτε για την υποστήριξη μιας προσαρμοσμένης εφαρμογής για κινητά, το REST API της Dolibarr ανοίγει την πόρτα σε πλούσιες, ασφαλείς ενσωματώσεις σε πραγματικό χρόνο.

2. Τι είναι το Dolibarr REST API;

Το REST API επιτρέπει σε εξωτερικές εφαρμογές να αλληλεπιδρούν με το Dolibarr μέσω αιτημάτων HTTP. Υποστηρίζει τυπικές λειτουργίες όπως:

  • GET (ανάγνωση δεδομένων)

  • POST (δημιουργία δεδομένων)

  • PUT (ενημέρωση δεδομένων)

  • ΔΙΑΓΡΑΦΗ (αφαίρεση δεδομένων)

Επικοινωνεί μέσω JSON, καθιστώντας εύκολη τη χρήση με σχεδόν οποιαδήποτε γλώσσα προγραμματισμού.

3. Γιατί να ενσωματώσω το Dolibarr με άλλες εφαρμογές;

Τα οφέλη περιλαμβάνουν:

  • Κοινή χρήση δεδομένων σε πραγματικό χρόνο

  • Αποφυγή διπλής εισόδου

  • Αυτοματοποίηση ροών εργασίας επιχειρήσεων

  • Δημιουργία απρόσκοπτων εμπειριών χρήστη

Παραδείγματα:

  • Αποστολή τιμολογίων Dolibarr σε εξωτερικά CRM

  • Ενημέρωση αποθέματος από ένα σύστημα αποθήκης

  • Εισαγωγή παραγγελιών από ηλεκτρονικά καταστήματα

4. Προϋποθέσεις για τη χρήση του API

Πριν ξεκινήσεις:

  • Βεβαιωθείτε ότι το Dolibarr είναι εγκατεστημένο και λειτουργεί

  • Έχετε πρόσβαση διαχειριστή για να ρυθμίσετε τις ενότητες

  • Έχετε έγκυρο τομέα ή IP για πρόσβαση στον διακομιστή

  • Η έκδοση Dolibarr είναι 7.0+ (το REST API είναι βασικό από αυτήν την έκδοση)

5. Ενεργοποίηση της ενότητας REST API

Για να ενεργοποιήσετε:

  1. Πηγαίνετε στο Αρχική > Ρύθμιση > Ενότητες/Εφαρμογές

  2. Θέτω εις ενέργειαν REST API υπηρεσιών ιστού

  3. Επιβεβαίωσε ότι /api/index.php είναι προσβάσιμο στον διακομιστή σας

Μπορεί να χρειαστεί να διαμορφώσετε .htaccess ή κανόνες Nginx για να επιτρέψετε την πρόσβαση στο API.

6. Κατανόηση του ελέγχου ταυτότητας API στο Dolibarr

Το REST API χρησιμοποιεί έλεγχο ταυτότητας που βασίζεται σε διακριτικά:

  • Κάθε χρήστης μπορεί να δημιουργήσει ένα ή περισσότερα κλειδιά API

  • Τα διακριτικά πρέπει να περαστούν στο DOLAPIKEY επί κεφαλής

Ο έλεγχος ταυτότητας συνδέεται με τα δικαιώματα χρήστη, επομένως χρησιμοποιήστε αποκλειστικούς χρήστες API με ελάχιστα δικαιώματα.

7. Δημιουργία και Διαχείριση API Tokens

Βήματα:

  1. Συνδεθείτε ως ο χρήστης που θα έχει πρόσβαση στο API

  2. Πηγαίνετε στο Χρήστης > Κλειδί API αυτί

  3. Δημιουργία ή αναγέννηση του κλειδιού

  4. Αποθηκεύστε το κλειδί με ασφάλεια

Χρησιμοποιήστε ένα διακριτικό ανά εφαρμογή για να διατηρήσετε την απομόνωση.

8. Εξερευνώντας τα Τελικά Σημεία του API του Dolibarr

Τα τυπικά τελικά σημεία περιλαμβάνουν:

  • /api/index.php/thirdparties

  • /api/index.php/products

  • /api/index.php/orders

  • /api/index.php/invoices

  • /api/index.php/users

Μπορείτε να αποκτήσετε πρόσβαση στην πλήρη λίστα στο htdocs/api/ ή χρησιμοποιώντας εργαλεία όπως το Postman.

9. Υποβολή του πρώτου σας αιτήματος API

Παράδειγμα με μπούκλα:

curl -X GET \
  https://yourdomain.com/api/index.php/thirdparties \
  -H 'DOLAPIKEY: your_token_here'

Μια επιτυχημένη κλήση επιστρέφει JSON:

[
  {
    "id": 1,
    "name": "MyCompany",
    "email": "info@mycompany.com"
  },
  ...
]

10. Λειτουργίες CRUD με το REST API

Δημιουργία (POST):

curl -X POST https://yourdomain.com/api/index.php/products \
-H 'DOLAPIKEY: your_token_here' \
-H 'Content-Type: application/json' \
-d '{"label":"New product", "price":100}'

Ανάγνωση (GET): Ανάκτηση με ID

GET /api/index.php/products/1

Ενημέρωση (PUT):

PUT /api/index.php/products/1

Διαγραφή (ΔΙΑΓΡΑΦΗ):

DELETE /api/index.php/products/1

11. Χειρισμός Σελιδοποίησης, Φίλτρων και Ταξινόμησης

Πολλά τελικά σημεία υποστηρίζουν αυτές τις παραμέτρους ερωτήματος:

  • limit=20

  • sortfield=name

  • sortorder=ASC

  • sqlfilters=(name:like:'Client%')

Παράδειγμα:

GET /api/index.php/thirdparties?limit=10&sortfield=name&sqlfilters=(status:=:1)

12. Απαντήσεις API και Χειρισμός Σφαλμάτων

Επιτυχημένες απαντήσεις:

  • 200 ΟΚ (ΛΑΒΕ, ΒΑΖΕΙ)

  • 201 Δημιουργήθηκε (POST)

  • 204 Χωρίς Περιεχόμενο (ΔΙΑΓΡΑΦΗ)

Σφάλματα:

  • 400 Κακή Αίτηση

  • 401 Μη εξουσιοδοτημένη

  • 403 Απαγορευμένη

  • 404 Δεν Βρέθηκε

  • Σφάλμα 500 εσωτερικό διακομιστή

Κάθε απάντηση περιλαμβάνει ένα message πεδίο με το πλαίσιο.

13. Περιπτώσεις Χρήσης: Συνήθεις Ενσωματώσεις

  • CRM: Συγχρονισμός πελατών και ιστορικού πωλήσεων

  • Λογιστήριο: Αποστολή δεδομένων τιμολογίου σε λογιστικά εργαλεία

  • Ηλεκτρονικό εμπόριοΣυγχρονισμός παραγγελιών σε πραγματικό χρόνο με το Dolibarr

  • Mobile εφαρμογέςΠαροχή πινάκων ελέγχου ή εργαλείων πεδίου για ομάδες πωλήσεων

14. Σύνδεση με εξωτερικά CRM ή ERP

Χρήσεις χρήσης:

  • Ανάκτηση δεδομένων πελατών

  • Στείλτε τιμολόγια

  • Συγχρονισμός καταλόγων προϊόντων

Χρησιμοποιήστε middleware ή πλατφόρμες ενσωμάτωσης (π.χ. Zapier, Make.com, προσαρμοσμένα Node.js ή Python scripts).

15. Συγχρονισμός προϊόντων, παραγγελιών και τιμολογίων

Λογική χαρτογράφησης δεδομένων σχεδιασμού:

  • Προϊόντα: αντιστοίχιση SKU, γραμμωτών κωδίκων

  • Παραγγελίες: επαληθεύστε την ύπαρξη πελάτη

  • Τιμολόγια: διατηρήστε μοναδικές αναφορές

Βεβαιωθείτε ότι και τα δύο συστήματα υποστηρίζουν webhooks ή polling.

16. Σύνδεση με πλατφόρμες ηλεκτρονικού εμπορίου (Shopify, Prestashop)

Προσεγγίσεις:

  • Χρησιμοποιήστε υπάρχουσες μονάδες Dolibarr (π.χ., σύνδεση Prestashop)

  • Δημιουργήστε προσαρμοσμένες εφαρμογές γέφυρας που λαμβάνουν παραγγελίες μέσω API ηλεκτρονικού εμπορίου και τις προωθούν στο Dolibarr

Το πρόγραμμα συγχρονίζεται κάθε λίγα λεπτά ή ενεργοποιείται μέσω webhook.

17. Ενσωμάτωση με προσαρμοσμένα frontend ή εφαρμογές για κινητά

Χρησιμοποιήστε το Dolibarr ως backend:

  • Έλεγχος ταυτότητας μέσω αποθηκευμένου διακριτικού

  • Ανάκτηση δεδομένων για πίνακες ελέγχου

  • Ενημερώσεις push από εφαρμογές πωλήσεων για κινητά

Τα React Native, Flutter ή Angular μπορούν να λειτουργήσουν με το API του Dolibarr.

18. Βέλτιστες πρακτικές ασφάλειας API

  • Χρήση μόνο HTTPS

  • Περιορισμός εύρους και λήξης διακριτικού API

  • Εναλλάξτε τα tokens τακτικά

  • Παρακολούθηση αρχείων καταγραφής αιτημάτων για κατάχρηση

  • Αιτήματα API ορίου ρυθμού

Μην εκθέτετε ποτέ τα κλειδιά API σε κώδικα από την πλευρά του πελάτη.

19. Παρακολούθηση και καταγραφή δραστηριότητας API

  • Ενεργοποίηση αρχείων καταγραφής Dolibarr: /documents/admin/ ή αρχεία καταγραφής βάσης δεδομένων

  • Χρήση αντίστροφων διακομιστών μεσολάβησης (π.χ., Nginx) για την καταγραφή της κίνησης API

  • Ειδοποίηση για μη εξουσιοδοτημένες προσπάθειες ή μεγάλους όγκους

  • Δημιουργήστε πίνακες ελέγχου για την παρακολούθηση μετρήσεων χρήσης API

20. Σύναψη

Το Dolibarr REST API είναι μια ισχυρή πύλη για να επεκτείνετε το σύστημα ERP σας πολύ πέρα ​​από το περιβάλλον εργασίας χρήστη. Είτε συνδέεστε με πλατφόρμες cloud, εφαρμογές για κινητά είτε εσωτερικά εργαλεία, η κατανόηση του τρόπου χρήσης και ασφάλειας του API σάς δίνει πλήρη έλεγχο των ροών εργασίας δεδομένων και του αυτοματισμού σας.