Wie Sie die Dolibarr-API zur Automatisierung Ihrer Prozesse verwenden

Synchronisieren Sie Ihre Kunden, erstellen Sie automatisch Rechnungen, verbinden Sie Ihre Website mit Ihrem ERP-System… Die REST-API von Dolibarr ermöglicht Ihnen die Automatisierung. Hier finden Sie eine vollständige Anleitung für den Einstieg und um Zeit bei wiederkehrenden Aufgaben zu sparen.

Automatisierung · REST-API · Dolibarr • Mittleres Niveau

1. Was ist die Dolibarr REST-API?

2. Warum sollten Sie Ihre Prozesse mit der API automatisieren?

3. Schritt 1: Aktivieren Sie das REST-API-Modul

4. Schritt 2: Generieren und sichern Sie Ihren API-Schlüssel

5. Schritt 3: Entdecken Sie die Explorer-API

6. Endpunkte und ihre Struktur verstehen

7. Schritt 4: Ihre ersten Anfragen in der Praxis

8. Konkrete Automatisierungsszenarien

9. Unternehmensübergreifendes Antwort- und Fehlermanagement

10. Bewährte Verfahren für nachhaltige Automatisierung

11. Häufig gestellte Fragen

12. Fazit: Lassen Sie Dolibarr für sich arbeiten

Wie viele Stunden verbringen Sie wöchentlich damit, Informationen von einem Softwareprogramm in ein anderes zu kopieren? Kundendatensätze manuell anzulegen, Rechnungen einzeln zu erstellen, Daten zwischen Ihrer Website und Ihrem Management-Tool zu exportieren und wieder zu importieren? Diese sich wiederholenden Aufgaben sind nicht nur zeitaufwendig, sondern auch eine Quelle für Fehler und Frustration.

Die Lösung heißt Automatisierung . Und für Dolibarr-Nutzer basiert sie auf einem leistungsstarken und oft übersehenen Werkzeug: der REST-API . Diese Programmierschnittstelle ist fest in die Software integriert und ermöglicht es anderen Anwendungen, direkt mit Ihrem Dolibarr zu kommunizieren und Daten ohne manuelle Eingriffe zu lesen und zu schreiben.

In diesem umfassenden Leitfaden erklären wir Ihnen die Dolibarr-API. Sie erfahren, was eine REST-API ist, wie Sie sie aktivieren und absichern, wie Sie Ihre ersten Anfragen stellen und vor allem, wie Sie sie effektiv zur Automatisierung Ihrer Geschäftsprozesse einsetzen. Sie benötigen lediglich einige grundlegende technische Kenntnisse: Wir erklären Ihnen jeden Schritt. Am Ende dieses Leitfadens können Sie stundenlange manuelle Arbeit in wenige Zeilen Code verwandeln, die automatisch ausgeführt werden.

Was ist die Dolibarr REST-API?

Beginnen wir mit den Grundlagen. Eine API (Application Programming Interface) ist ein Regelwerk, das die Kommunikation zwischen zwei Softwareprogrammen ermöglicht. Anstatt sich durch eine Benutzeroberfläche zu klicken, sendet ein Programm strukturierte Anfragen und empfängt Antworten – alles automatisch.

Die API von Dolibarr basiert auf REST , einem Webstandard, der HTTP-Anfragen verwendet – dieselben, die auch Ihr Browser nutzt. Der Datenaustausch erfolgt im JSON- Format , einem leichtgewichtigen und gut lesbaren Textformat, das mit nahezu allen Programmiersprachen kompatibel ist. Konkret bedeutet dies, dass Sie Dolibarr über ein PHP-, Python- oder JavaScript-Skript oder sogar über ein einfaches Kommandozeilen-Tool steuern können.

Diese API ist seit mehreren Versionen nativ in Dolibarr integriert und ermöglicht den Zugriff auf die meisten Softwarefunktionen: Drittanbieter, Produkte, Bestellungen, Rechnungen, Benutzer und vieles mehr. Sie bildet die Grundlage für jede Integration und Automatisierung Ihres ERP-Systems.

Die vier grundlegenden Operationen

Die API basiert auf vier grundlegenden Aktionen, die HTTP-Methoden entsprechen. Diese werden oft als CRUD- Operationen (Erstellen, Lesen, Aktualisieren, Löschen) bezeichnet:

•     GET — Daten lesen (Kundenliste einsehen, Rechnung abrufen).

•     POST — ein neues Datenelement erstellen (ein Produkt hinzufügen, einen Drittanbieter anlegen).

•     PUT — Vorhandene Daten aktualisieren (eine Rechnung ändern).

•     LÖSCHEN — ein Datenelement löschen.

Warum sollten Sie Ihre Prozesse mit der API automatisieren?

Bevor wir uns mit den technischen Details befassen, betrachten wir die konkreten Vorteile. Automatisierung per API ist kein Luxus für Entwickler, sondern ein Produktivitätshebel mit sehr realen Ergebnissen.

Sparen Sie wertvolle Zeit

Jede automatisierte, sich wiederholende Aufgabe spart Ihrem Unternehmen Zeit. Die Synchronisierung hunderter Kunden, die Erstellung dutzender Rechnungen, die Aktualisierung eines Produktkatalogs: Was früher Stunden dauerte, erledigt sich jetzt in Sekundenschnelle – ganz automatisch.

Eingabefehler beseitigen

Manuelle Dateneingabe ist die Hauptfehlerquelle: vertauschte Ziffern, fehlende Zeilen, Duplikate. Indem Sie die Informationen von einem Programm übertragen lassen, gewährleisten Sie die Konsistenz und Zuverlässigkeit Ihrer Daten über alle Ihre Tools hinweg.

Verbinde dein Ökosystem

Die API ermöglicht Dolibarr die Kommunikation mit Ihrer übrigen Software: Ihrem Onlineshop , Ihrer Buchhaltungssoftware, Ihrem CRM-System, einer individuellen mobilen Anwendung oder Automatisierungsplattformen. Ihr ERP-System ist somit keine isolierte Einheit mehr, sondern wird zum zentralen Steuerungselement eines vernetzten Systems.

Arbeiten in Echtzeit

Eine Bestellung auf Ihrer Website erstellt automatisch einen Kunden und die Bestellung in Dolibarr. Ein Zahlungseingang aktualisiert die Rechnung. Diese Echtzeit-Synchronisierung bietet Ihnen einen stets aktuellen Überblick über Ihr Unternehmen und optimiert Ihre gesamten Abläufe.

Schritt 1: Aktivieren Sie das REST-API-Modul

Zuerst müssen Sie die API in Dolibarr aktivieren. Gehen Sie zu Startseite → Konfiguration → Module/Anwendungen und suchen und aktivieren Sie das Modul „REST API Web Services“ . Für diesen Vorgang sind Administratorrechte erforderlich.

Sobald das Modul aktiviert ist, überprüfen Sie, ob die API erreichbar ist. Sie ist unter der Adresse `/api/index.php` Ihrer Installation erreichbar. Wenn Ihr Dolibarr-Server auf Apache läuft, ist die API in der Regel ohne zusätzliche Konfiguration verfügbar. Bei Nginx muss möglicherweise die Serverkonfiguration angepasst werden, um den Zugriff auf API-Anfragen zu ermöglichen.

Schritt 2: Generieren und sichern Sie Ihren API-Schlüssel

eine API- Schlüsselauthentifizierung (ein Token). Jeder Benutzer kann einen oder mehrere Schlüssel besitzen. Um einen Schlüssel zu generieren, melden Sie sich an, öffnen Sie das Benutzerprofil unter „Benutzer & Gruppen“ , gehen Sie zum Tab „API-Schlüssel“ und generieren Sie ihn. Kopieren Sie diesen Schlüssel und bewahren Sie ihn sicher auf.

Dieser Schlüssel muss dann jeder Ihrer Anfragen beigefügt werden. Er wird in einem bestimmten HTTP-Header übermittelt:

Entscheidend ist, dass die Authentifizierung an die Benutzerrechte gekoppelt ist. Der Schlüssel erbt die Berechtigungen des Benutzers, der ihn generiert hat. Daher kann eine Anfrage nur Aktionen ausführen, zu denen dieser Benutzer in Dolibarr berechtigt ist. Dies ist ein grundlegender Sicherheitsmechanismus, der mit Bedacht eingesetzt werden muss.

Gute Sicherheitspraktiken

Ein API-Schlüssel ist genauso sensibel wie ein Passwort. Um zu vermeiden, dass Ihr Zugangspunkt zu einer Sicherheitslücke wird, müssen einige Regeln befolgt werden:

•     Erstellen Sie einen dedizierten API-Benutzer mit ausschließlich den für die geplante Automatisierung unbedingt erforderlichen Rechten. Verwenden Sie niemals ein Administratorkonto.

•     Verwenden Sie pro Anwendung einen Schlüssel . Im Falle einer Kompromittierung können Sie den betreffenden Schlüssel widerrufen, ohne dass dies Auswirkungen auf andere Integrationen hat.

•     Der Schlüssel darf niemals im clientseitigen Code (Browser-JavaScript, öffentliche Anwendung) offengelegt werden, wo er sichtbar wäre.

•     Erzwingen Sie HTTPS , um die Übertragung von Schlüssel und Daten zu verschlüsseln.

•     Tauschen Sie die Schlüssel regelmäßig aus , um das Risiko im Falle eines Lecks zu minimieren.

Schritt 3: Entdecken Sie die Explorer-API

Dolibarr bietet ein fantastisches Tool zum Erkunden und Testen der API, ohne eine einzige Zeile Code schreiben zu müssen: den API Explorer , basierend auf der Swagger-Schnittstelle. Sie finden ihn in Ihrer Installation unter /api/index.php/explorer/ .

Dieser Explorer listet alle auf Ihrer Installation verfügbaren Endpunkte auf, inklusive der automatisch aus dem Code generierten Dokumentation. Noch besser: Er bietet interaktive Testformulare, mit denen Sie direkt im Browser eine Anfrage ausführen und die Antwort einsehen können. So können Sie die Datenstruktur optimal verstehen und Ihre Aufrufe testen, bevor Sie sie programmieren.

Endpunkte und ihre Struktur verstehen

Ein Endpunkt (oder Zugriffspunkt) ist eine URL, die einem Datentyp entspricht. In Dolibarr folgen sie einer einheitlichen Struktur, organisiert nach Modulen. Die Basis-URL lautet immer /api/index.php/ , gefolgt vom Ressourcennamen. Hier sind die gängigsten:

Jeder Endpunkt akzeptiert je nach gewünschter Aktion unterschiedliche HTTP-Methoden. Um ein bestimmtes Element anzusprechen, wird dessen Kennung an die URL angehängt: Eine Anfrage für die Rechnungsnummer 42 adressiert somit den Pfad zur Rechnungsressource, gefolgt von dieser Kennung.

Schritt 4: Ihre ersten Anfragen in der Praxis

Kommen wir nun zur praktischen Anwendung mit dem universellsten Werkzeug: cURL, das auf den meisten Systemen über die Kommandozeile verfügbar ist. Die folgenden Beispiele lassen sich an jede Programmiersprache anpassen.

Daten lesen (GET)

Um die Liste Ihrer Drittanbieter abzurufen, genügt eine einfache GET-Anfrage mit Ihrem Schlüssel:

Dolibarr gibt anschließend ein JSON-Array mit den Drittanbietern und all ihren Feldern zurück. Sie können die Abfrage mithilfe von Sortier-, Limit- oder Filterparametern verfeinern, um nur die gewünschten Daten abzurufen.

Daten erstellen (POST)

Um ein neues Produkt anzulegen, wird eine POST-Anfrage zusammen mit einem JSON-Body gesendet, der das Objekt beschreibt:

Aktualisieren (PUT) und löschen (DELETE)

Der Aktualisierungsprozess folgt derselben Logik und verwendet die PUT-Methode. Dabei wird die ID des Elements als Ziel verwendet und nur die zu ändernden Felder gesendet. Zum Löschen hingegen wird die DELETE-Methode auf die URL des betreffenden Elements angewendet. In allen Fällen muss der API-Schlüssel der Anfrage beigefügt werden, und die Berechtigungen des Benutzers entscheiden über den Erfolg der Operation.

Konkrete Automatisierungsszenarien

Nachdem wir die Grundlagen behandelt haben, sehen wir uns nun an, wie sich das Ganze in konkrete Erfolge umsetzen lässt. Hier sind einige der nützlichsten Automatisierungen.

Synchronisieren Sie Ihren Online-Shop

Bei jeder Bestellung in Ihrem Onlineshop erstellt ein Skript über die API automatisch einen Kunden, falls noch keiner existiert, und speichert die Bestellung anschließend in Dolibarr. Ihr ERP-System spiegelt Ihre Verkäufe in Echtzeit wider – ganz ohne manuelle Dateneingabe. Umgekehrt können Sie Ihren Produktkatalog von Dolibarr in Ihren Onlineshop übertragen, um stets konsistente Produktinformationen zu gewährleisten.

Rechnungen automatisch erstellen und versenden

Bei Abonnements oder wiederkehrenden Dienstleistungen kann ein programmiertes Skript monatlich die entsprechenden Rechnungen über die API erstellen und anschließend deren Validierung auslösen. Der Zeitaufwand für die Abrechnung wiederkehrender Zahlungen reduziert sich dadurch auf null.

Befüllung eines externen Dashboards

Möchten Sie Ihre wichtigsten Leistungsindikatoren (KPIs) in einem Visualisierungstool oder einer gemeinsam genutzten Tabelle verfolgen? Ein Skript fragt regelmäßig die API ab, um Umsatz, offene Rechnungen oder neue Bestellungen zu ermitteln und Ihr Dashboard zu aktualisieren. Ihre Leistungsdaten sind somit immer aktuell.

Dolibarr mit Automatisierungsplattformen verbinden

Automatisierungsplattformen ohne Programmierkenntnisse ermöglichen es Ihnen, Dolibarr über seine API mit Hunderten anderer Dienste zu verbinden. So können Sie beispielsweise eine Benachrichtigung auslösen, sobald eine Rechnung bezahlt wurde, für jede neue Bestellung eine Aufgabe in Ihrem Projektmanagement-Tool erstellen oder Ihr Team per E-Mail informieren. Die Möglichkeiten sind nahezu unbegrenzt.

Mehrere Unternehmen, Reaktions- und Fehlermanagement

Wenn Sie Dolibarr im Multi-Company-Modus verwenden, verarbeitet die API dieses Szenario mithilfe eines speziellen Headers, DOLAPIENTITY , der es Ihnen ermöglicht, die für die Anfrage relevante Entität anzugeben. Dadurch können Sie mehrere Unternehmen über ein einziges Automatisierungs-Framework verwalten.

Die API liefert als Antwort stets JSON-Daten zusammen mit einem HTTP-Statuscode, der das Ergebnis angibt: einen Erfolgscode bei erfolgreicher Operation oder einen Fehlercode im Problemfall (ungültiger Schlüssel, unzureichende Berechtigungen, Daten nicht gefunden, fehlerhafte Anfrage). Ihr Code muss diesen Statuscode immer prüfen, bevor er die Antwort verwendet.

Eine effektive Fehlerbehandlung ist für eine zuverlässige Automatisierung unerlässlich. Planen Sie stets Maßnahmen zur Fehlerbehebung ein: Protokollieren Sie den Fehler, wiederholen Sie den Vorgang gegebenenfalls und benachrichtigen Sie den Benutzer, falls das Problem weiterhin besteht. Eine Automatisierung, die Fehler unbemerkt ignoriert, ist gefährlicher als gar keine Automatisierung.

Bewährte Verfahren für nachhaltige Automatisierung

Damit Ihre Automatisierungen auch langfristig zuverlässig und wartungsfreundlich bleiben, sollten Sie folgende Grundsätze beachten:

1.    Testen Sie immer zuerst im Explorer. Validieren Sie jede Anfrage in der Explorer-API, bevor Sie sie in ein Skript integrieren.

2.    Arbeiten Sie in einer Testumgebung. Entwickeln Sie Ihre Skripte niemals direkt auf Ihrem produktiven Dolibarr-System.

3.    Beschränken Sie die Rechte des API-Nutzers. Das Prinzip der minimalen Berechtigungen verringert die Auswirkungen einer potenziellen Kompromittierung.

4.    Protokollieren Sie Ihre Anrufe. Das Aufzeichnen von Anfragen erleichtert die Fehlersuche erheblich.

5.    Gehen Sie verantwortungsvoll mit großen Datenmengen um. Teilen Sie Ihre Abfragen bei umfangreichen Verarbeitungsaufgaben in Paginierungen auf, um eine Überlastung des Servers zu vermeiden.

6.    Dokumentieren Sie Ihre Integrationen. Notieren Sie, was jedes Skript bewirkt und welchen Schlüssel es verwendet: Ihr zukünftiges Ich wird es Ihnen danken.

Häufig gestellte Fragen

Müssen Sie programmieren können, um die Dolibarr-API zu nutzen?

Für Erkundungs- und Testzwecke ist die Explorer API nicht geeignet: Sie ermöglicht Anfragen direkt vom Browser aus, ohne dass Code benötigt wird. Für eine echte Automatisierung sind Programmierkenntnisse oder die Nutzung einer No-Code-Automatisierungsplattform erforderlich. Die Grundlagen genügen für den Einstieg: Die REST API ist ein einfacher und gut dokumentierter Standard.

Ist die API in allen Versionen von Dolibarr verfügbar?

Die REST-API ist seit mehreren Versionen in den Dolibarr-Kern integriert und gehört nun zum Standardmodul. Aktivieren Sie sie einfach in der Konfiguration. Halten Sie Ihre Installation stets aktuell, um von den neuesten Fehlerbehebungen und der Unterstützung aller Endpunkte zu profitieren.

Was soll ich tun, wenn eine Anfrage einen Berechtigungsfehler zurückgibt?

Ein Berechtigungsfehler bedeutet, dass der Benutzer, dem der API-Schlüssel zugeordnet ist, nicht berechtigt ist, die angeforderte Aktion auszuführen. Überprüfen Sie die Berechtigungen dieses Benutzers in Dolibarr und erteilen Sie ihm die erforderlichen Rechte – jedoch nicht mehr als unbedingt notwendig.

Kann ich Dolibarr mit meiner Website verbinden, ohne es selbst entwickeln zu müssen?

Ja. Für viele E-Commerce-Plattformen existieren Konnektoren, und No-Code-Automatisierungstools ermöglichen die Anbindung von Dolibarr an andere Dienste über die API, ohne dass Code geschrieben werden muss. Für sehr spezielle Anforderungen ist die individuelle Entwicklung jedoch nach wie vor die flexibelste Lösung.

Fazit: Lassen Sie Dolibarr für sich arbeiten

Dolibarrs REST-API ist ein echter Glücksgriff für alle, die ihre Prozesse automatisieren und Zeit sparen möchten. In nur wenigen Schritten – Modul aktivieren, Schlüssel generieren, Endpunkte erkunden und erste Abfragen schreiben – ebnen Sie den Weg für Automatisierungen, die die manuelle Dateneingabe überflüssig machen, die Datenzuverlässigkeit gewährleisten und Ihr ERP-System mit Ihrem restlichen Ökosystem verbinden.

Die Stärke dieses Ansatzes liegt in seiner schrittweisen Vorgehensweise. Sie müssen nicht alles auf einmal umkrempeln: Beginnen Sie mit einer einzelnen Automatisierung, validieren Sie diese im API Explorer und setzen Sie sie dann bedenkenlos ein. Jede automatisierte Aufgabe spart Ihnen Zeit für die wirklich wichtigen Dinge in Ihrem Unternehmen.

Der beste Tipp? Öffnen Sie noch heute den API Explorer in Ihrem Dolibarr, senden Sie Ihre erste GET-Anfrage an Ihre Drittanbieter und beobachten Sie die Antwort. Dieser kleine Schritt zeigt Ihnen das Potenzial, das Ihnen zur Verfügung steht – und weckt die Lust, noch mehr zu entdecken. Ihr ERP-System wartet nur darauf, für Sie zu arbeiten, wenn Sie ihm die nötigen Anweisungen geben.