Dolibarr ist ein Open-Source-ERP- und CRM-System, das von Unternehmen zur Verwaltung ihrer geschäftlichen, finanziellen und administrativen Prozesse verwendet wird. Eine der leistungsstärksten Funktionen ist die REST-API, die es Entwicklern ermöglicht, Aufgaben zu automatisieren und Dolibarr mit anderen Anwendungen zu integrieren.
In diesem Artikel erklären wir wie man die REST-API von Dolibarr verwendet, um typische Aufgaben wie das Verwalten von Kunden, das Erstellen von Rechnungen, das Aktualisieren von Produkten und die Synchronisation von Daten mit externen Diensten zu automatisieren.
1. Einführung in die REST-API von Dolibarr
Die REST-API von Dolibarr ermöglicht die Interaktion mit dem System über HTTP-Anfragen. Sie wurde entwickelt, um sicheren Zugriff auf die Daten und Funktionen von Dolibarr zu ermöglichen und so die Integration mit anderen Tools zu erleichtern.
Hauptfunktionen der REST-API
- Verwaltung von Kunden und Kontakten (Hinzufügen, Aktualisieren, Löschen).
- Erstellung und Aktualisierung von Rechnungen und Angeboten.
- Verwaltung von Produkten und Dienstleistungen.
- Zugriff auf Bestellungen und Zahlungen.
- Lesen und Schreiben von Buchhaltungsdaten.
2. Aktivieren der REST-API in Dolibarr
Bevor die REST-API verwendet werden kann, muss sie in Dolibarr aktiviert und die Zugriffsrechte konfiguriert werden.
Schritte zum Aktivieren der API
- Als Administrator anmelden in Dolibarr.
- Navigieren zu "Startseite" → "Einstellungen" → "Module/Anwendungen".
- Das Modul "REST-API" suchen und aktivieren.
- Im Tab Konfiguration einen API-Schlüssel für jeden Benutzer oder jede Anwendung generieren, die Zugriff benötigt.
- API-Berechtigungen festlegen, um den Zugriff auf sensible Daten zu beschränken.
Sobald die API aktiviert ist, kann sie über die folgende URL aufgerufen werden:
3. Authentifizierung und Sicherheit
Dolibarr verwendet ein Token-basiertes Authentifizierungssystem, um den API-Zugriff zu schützen.
Abrufen eines Authentifizierungstokens
Die Authentifizierung erfolgt durch eine POST-Anfrage mit den API-Zugangsdaten:
Die Antwort enthält ein Authentifizierungstoken, das in jeder API-Anfrage im DOLAPIKEY-Header angegeben werden muss:
Sicherung der API
- Immer HTTPS verwenden, um Datenabfang zu verhindern.
- Zugriff mit spezifischen Benutzerberechtigungen einschränken.
- API-Schlüssel regelmäßig erneuern.
- API-Zugriffsprotokolle überwachen, um verdächtige Aktivitäten zu erkennen.
4. Automatisierung der Kundenverwaltung
Die REST-API ermöglicht das Hinzufügen und Bearbeiten von Kunden ohne die Dolibarr-Benutzeroberfläche.
Einen neuen Kunden anlegen
Beispiel für eine POST-Anfrage zum Hinzufügen eines Kunden:
Dolibarr gibt eine eindeutige ID für diesen Kunden zurück, die für weitere Aktionen verwendet werden kann.
Einen bestehenden Kunden aktualisieren
Um einen Kunden zu bearbeiten, wird eine PUT-Anfrage mit der Kunden-ID verwendet:
5. Automatisierung der Rechnungsstellung
Eine Rechnung über die REST-API erstellen
Um eine Rechnung zu generieren, wird der /invoices-Endpunkt genutzt:
Dolibarr gibt die Rechnungs-ID zurück, die für den Versand per E-Mail oder den Download als PDF verwendet werden kann.
6. Synchronisierung von Dolibarr mit anderen Tools
Die REST-API von Dolibarr kann verwendet werden, um Daten mit externen Tools wie WooCommerce, Prestashop, Zapier, Google Sheets, Power BI usw. zu synchronisieren.
Beispiel: Synchronisation mit einem E-Commerce-Shop
Wenn die Produktliste für einen WooCommerce-Shop abgerufen werden soll, kann die folgende Anfrage verwendet werden:
Diese Anfrage gibt die Produktinformationen von Dolibarr zurück, die dann über die REST-API in WooCommerce importiert werden können.
7. Automatisierung von Berichten und Analysen
Die API von Dolibarr ermöglicht das Extrahieren von Daten, um benutzerdefinierte Berichte zu erstellen.
Export der Verkäufe des aktuellen Monats
Um die Verkäufe des Monats abzurufen:
Diese Daten können in Google Sheets, Power BI oder Excel für eine weiterführende Analyse importiert werden.
Fazit
Die REST-API von Dolibarr ist ein leistungsstarkes Werkzeug, das die Automatisierung vieler Aufgaben und die Integration von Dolibarr mit anderen Systemen ermöglicht. Durch das Aktivieren und die richtige Sicherung der API können Kunden verwaltet, Rechnungen erstellt, Daten mit externen Plattformen synchronisiert und benutzerdefinierte Berichte generiert werden.
Ob für die Integration mit einem E-Commerce-Shop, einer mobilen App oder einem externen CRM – die REST-API von Dolibarr erleichtert die Automatisierung und steigert die Produktivität.
Wenn du noch weiter gehen möchtest, empfehlen wir, die offizielle Dolibarr-Dokumentation zu durchsuchen oder Tools wie Postman zu nutzen, um API-Anfragen zu testen und zu optimieren.