Inhaltsverzeichnis

  1. Einführung

  2. Was ist die Dolibarr REST API?

  3. Warum Dolibarr in andere Anwendungen integrieren?

  4. Voraussetzungen für die Verwendung der API

  5. Aktivieren des REST-API-Moduls

  6. Grundlegendes zur API-Authentifizierung in Dolibarr

  7. Generieren und Verwalten von API-Token

  8. Erkunden der Dolibarr-API-Endpunkte

  9. Ihre erste API-Anfrage stellen

  10. CRUD-Operationen mit der REST-API

  11. Umgang mit Paginierung, Filtern und Sortierung

  12. API-Antworten und Fehlerbehandlung

  13. Anwendungsfälle: Gängige Integrationen

  14. Verbindung zu externen CRMs oder ERPs

  15. Synchronisieren von Produkten, Bestellungen und Rechnungen

  16. Verbindung zu E-Commerce-Plattformen (Shopify, Prestashop)

  17. Integration mit benutzerdefinierten Frontends oder mobilen Apps

  18. Best Practices für die API-Sicherheit

  19. Überwachen und Protokollieren der API-Aktivität

  20. Fazit

1. Einleitung

Dolibarr ERP/CRM ist für sich genommen schon leistungsstark, gewinnt aber noch mehr an Wirkung, wenn es in ein breiteres Tool-Ökosystem integriert wird. Ob Synchronisierung mit einem E-Commerce-Shop, Datenaustausch mit einem Buchhaltungstool oder die Bereitstellung einer benutzerdefinierten mobilen App – die REST-API von Dolibarr ermöglicht umfassende, sichere Echtzeit-Integrationen.

2. Was ist die Dolibarr REST API?

Die REST-API ermöglicht externen Anwendungen die Interaktion mit Dolibarr über HTTP-Anfragen. Sie unterstützt Standardoperationen wie:

  • GET (Daten lesen)

  • POST (Daten erstellen)

  • PUT (Daten aktualisieren)

  • LÖSCHEN (Daten entfernen)

Die Kommunikation erfolgt über JSON, sodass die Verwendung mit praktisch jeder Programmiersprache problemlos möglich ist.

3. Warum Dolibarr in andere Anwendungen integrieren?

Die Vorteile sind:

  • Datenaustausch in Echtzeit

  • Vermeidung doppelter Eingaben

  • Automatisierung von Geschäftsabläufen

  • Nahtlose Benutzererfahrungen schaffen

Beispiele:

  • Senden von Dolibarr-Rechnungen an externe CRMs

  • Aktualisieren des Inventars aus einem Lagersystem

  • Importieren von Bestellungen aus Online-Shops

4. Voraussetzungen für die Nutzung der API

Bevor Sie beginnen:

  • Stellen Sie sicher, dass Dolibarr installiert und ausgeführt wird

  • Sie haben Administratorzugriff zum Konfigurieren von Modulen

  • Sie verfügen über eine gültige Domäne oder IP, um auf den Server zuzugreifen

  • Dolibarr-Version ist 7.0+ (REST-API ist seit dieser Version der Kern)

5. Aktivieren des REST-API-Moduls

Ermöglichen:

  1. Gehe zu Home > Setup > Module/Anwendungen

  2. Mehr erfahren REST-API für Webdienste

  3. Bestätige das /api/index.php ist auf Ihrem Server erreichbar

Möglicherweise müssen Sie konfigurieren .htaccess oder Nginx-Regeln, um den API-Zugriff zu ermöglichen.

6. API-Authentifizierung in Dolibarr verstehen

Die REST-API verwendet eine tokenbasierte Authentifizierung:

  • Jeder Benutzer kann einen oder mehrere API-Schlüssel generieren

  • Token müssen übergeben werden in der DOLAPIKEY Kopfzeile

Die Authentifizierung ist an Benutzerberechtigungen gebunden. Verwenden Sie daher dedizierte API-Benutzer mit minimalen Rechten.

7. Generieren und Verwalten von API-Token

Schritte:

  1. Melden Sie sich als der Benutzer an, der auf die API zugreifen wird

  2. Gehe zu Benutzer > API-Schlüssel Tab

  3. Schlüssel generieren oder neu generieren

  4. Bewahren Sie den Schlüssel sicher auf

Verwenden Sie ein Token pro Anwendung, um die Isolation aufrechtzuerhalten.

8. Erkunden der Dolibarr-API-Endpunkte

Typische Endpunkte sind:

  • /api/index.php/thirdparties

  • /api/index.php/products

  • /api/index.php/orders

  • /api/index.php/invoices

  • /api/index.php/users

Sie können auf die vollständige Liste zugreifen in htdocs/api/ oder durch die Verwendung von Tools wie Postman.

9. Ihre erste API-Anfrage stellen

Beispiel mit curl:

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

Ein erfolgreicher Aufruf gibt JSON zurück:

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

10. CRUD-Operationen mit der REST-API

Erstellen (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}'

Lesen (GET): Abrufen nach ID

GET /api/index.php/products/1

Aktualisieren (PUT):

PUT /api/index.php/products/1

Löschen (DELETE):

DELETE /api/index.php/products/1

11. Umgang mit Paginierung, Filtern und Sortierung

Viele Endpunkte unterstützen diese Abfrageparameter:

  • limit=20

  • sortfield=name

  • sortorder=ASC

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

Ejemplo:

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

12. API-Antworten und Fehlerbehandlung

Erfolgreiche Antworten:

  • 200 OK (GET, PUT)

  • 201 Erstellt (POST)

  • 204 Kein Inhalt (LÖSCHEN)

Fehler:

  • 400 Bad Request

  • 401 Nicht autorisiert

  • 403 Verboten

  • 404 Not Found

  • 500 Internal Server Error

Jede Antwort enthält eine message Feld mit Kontext.

13. Anwendungsfälle: Gängige Integrationen

  • CRM: Kunden und Verkaufsverlauf synchronisieren

  • Buchhaltung: Rechnungsdaten an Buchhaltungstools senden

  • E-Commerce: Echtzeit-Auftragssynchronisierung mit Dolibarr

  • Mobile Apps: Bereitstellung von Dashboards oder Feldtools für Vertriebsteams

14. Verbindung zu externen CRMs oder ERPs

Anwendungsfälle:

  • Kundendaten abrufen

  • Rechnungen senden

  • Produktkataloge synchronisieren

Verwenden Sie Middleware oder Integrationsplattformen (z. B. Zapier, Make.com, benutzerdefinierte Node.js- oder Python-Skripte).

15. Synchronisieren von Produkten, Bestellungen und Rechnungen

Datenzuordnungslogik entwerfen:

  • Produkte: SKUs und Barcodes abgleichen

  • Bestellungen: Überprüfen, ob der Kunde existiert

  • Rechnungen: Eindeutige Referenzen pflegen

Stellen Sie sicher, dass beide Systeme Webhooks oder Polling unterstützen.

16. Verbindung zu E-Commerce-Plattformen (Shopify, Prestashop)

Nähert sich:

  • Verwenden Sie vorhandene Dolibarr-Module (z. B. Prestashop-Connector)

  • Schreiben Sie benutzerdefinierte Bridge-Apps, die Bestellungen über E-Commerce-APIs abrufen und an Dolibarr weiterleiten

Planen Sie Synchronisierungen alle paar Minuten oder lösen Sie sie per Webhook aus.

17. Integration mit benutzerdefinierten Frontends oder mobilen Apps

Verwenden Sie Dolibarr als Backend:

  • Authentifizierung über gespeichertes Token

  • Daten für Dashboards abrufen

  • Push-Updates von mobilen Verkaufs-Apps

React Native, Flutter oder Angular können alle mit der API von Dolibarr funktionieren.

18. Best Practices für die API-Sicherheit

  • Nur HTTPS verwenden

  • Umfang und Ablauf des API-Tokens begrenzen

  • Tauschen Sie die Token regelmäßig aus

  • Überwachen Sie Anforderungsprotokolle auf Missbrauch

  • Rate-Limit-API-Anfragen

Geben Sie API-Schlüssel niemals im clientseitigen Code preis.

19. Überwachung und Protokollierung der API-Aktivität

  • Aktivieren Sie Dolibarr-Protokolle: /documents/admin/ oder Datenbankprotokolle

  • Verwenden Sie Reverse-Proxys (z. B. Nginx), um den API-Verkehr zu protokollieren

  • Warnmeldung bei unbefugten Versuchen oder großen Datenmengen

  • Erstellen Sie Dashboards zur Verfolgung von API-Nutzungsmetriken

20. Fazit

Die Dolibarr REST API ist ein leistungsstarkes Gateway, mit dem Sie Ihr ERP-System weit über die Benutzeroberfläche hinaus erweitern können. Unabhängig davon, ob Sie eine Verbindung mit Cloud-Plattformen, mobilen Apps oder internen Tools herstellen: Wenn Sie wissen, wie Sie die API verwenden und sichern, haben Sie die vollständige Kontrolle über Ihre Datenworkflows und die Automatisierung.