Verwendung der Dolibarr-REST-API zur Anbindung einer mobilen Anwendung: Umfassender Leitfaden für Entwickler und KMU
   05/15/2025 00:00:00     Dolibarr , Wiki Dolibarr    0 Bemerkungen
Verwendung der Dolibarr-REST-API zur Anbindung einer mobilen Anwendung: Umfassender Leitfaden für Entwickler und KMU

Im Zeitalter der mobilen digitalen Transformation ist die Integration von Unternehmensanwendungen in mobile Plattformen keine bloße Option mehr, sondern eine strategische Notwendigkeit. Dolibarr ERP & CRM, bekannt für seine modulare Open-Source-Architektur, bietet eine leistungsstarke REST-API, mit der Entwickler externe Anwendungen – einschließlich mobiler Apps – direkt an das zentrale System anschließen können. Diese Flexibilität ermöglicht optimierte Workflows, Echtzeit-Datensynchronisierung und ein verbessertes Nutzererlebnis.

Ob Sie ein kleines Unternehmen sind, das seine internen Tools erweitern möchte, ein Softwarehaus, das einen mobilen Dolibarr-Client entwickelt, oder ein IT-Berater, der eine hybride Lösung plant – dieser Artikel ist Ihr umfassender Leitfaden. Wir behandeln alles: API-Grundlagen, Authentifizierung, Endpunkte, Anwendungsfälle, Fehlerbehandlung und Best Practices für eine sichere und skalierbare mobile Integration.

Verständnis der Dolibarr-REST-API

Die REST-API von Dolibarr stellt eine breite Palette von Endpunkten bereit, die den Hauptmodulen des Systems entsprechen, darunter Rechnungen, Kunden, Produkte, Bestellungen und Projekte. Sie basiert auf den HTTP-Standardmethoden (GET, POST, PUT, DELETE) und folgt RESTful-Prinzipien. Dadurch lässt sie sich einfach von jeder Plattform aus nutzen, die HTTP unterstützt.

Die API wurde in Version 5.0 eingeführt und zwischen den Versionen 10 und 16 erheblich verbessert. Im Jahr 2025 ist sie mit Dolibarr-Versionen ab 14 vollständig kompatibel und beinhaltet die neuesten Sicherheits- und Datenstrukturverbesserungen.

Warum die REST-API für eine mobile App nutzen?

Die Integration einer mobilen App mit der Dolibarr-API bietet zahlreiche Vorteile:

  • Echtzeit-Synchronisierung von Produkt-, Lager- und Rechnungsdaten

  • Benutzerspezifischer Zugriff auf CRM-, Buchhaltungs- oder HR-Module

  • Mobiler Zugriff für Außendienstmitarbeiter, Techniker oder Zusteller

  • Push-Benachrichtigungen bei Leads oder überfälligen Zahlungen

  • Offline-Funktionalität mit späterer Synchronisation

Voraussetzungen und Umgebungseinrichtung

Was Sie benötigen:

  • Eine funktionierende Dolibarr-Installation (Version 14+ empfohlen)

  • Administratorzugriff auf Dolibarr

  • Aktiviertes API-Modul

  • Einen API-Schlüssel oder OAuth-Token

  • Eine mobile App oder ein Entwicklungsframework (Flutter, React Native, Android Studio etc.)

Aktivieren Sie das API-Modul in Dolibarr:

  1. Gehen Sie zu Konfiguration > Module/Anwendungen

  2. Aktivieren Sie das Modul REST API

  3. Gehen Sie zu Benutzer > Liste > Bearbeiten

  4. Generieren und kopieren Sie den API-Schlüssel für den Benutzer

Optional: Installieren Sie das Plugin APIGateway oder konfigurieren Sie CORS, falls Ihre App webbasiert ist.

Authentifizierung: API-Schlüssel vs. OAuth2

Dolibarr unterstützt zwei Authentifizierungsmethoden:

API-Schlüssel (Token)

  • Einfach zu implementieren

  • Ideal für interne oder Einzelnutzer-Apps

  • Im Header gesendet: DOLAPIKEY: ihr_schlüssel

OAuth2

  • Sicherer und skalierbarer

  • Empfohlen für öffentliche Apps mit mehreren Nutzern

  • Erfordert Client-ID, Secret und Redirect-URIs

Nutzen Sie OAuth2 für öffentliche oder App-Store-Apps.

Struktur und Endpunkte der REST-API

Basispfad:

https://ihredomain.com/api/index.php

Typische Endpunkte:

  • GET /thirdparties – Kunden-/Lieferantenliste

  • POST /thirdparties – Neuen Kunden erstellen

  • GET /products – Produktliste abrufen

  • POST /invoices – Neue Rechnung erstellen

  • GET /users/me – Aktuellen Benutzer abrufen

Antworten sind JSON-formatiert und erfordern Authentifizierung.

Typische Anwendungsfälle für mobile Apps

1. Mobile CRM-App

  • Kundenlisten und Kontaktinformationen anzeigen

  • Leads unterwegs erfassen oder ändern

  • Aktivitätenhistorie einsehen

  • Aufgaben planen

2. Verkaufs- und Bestell-App

  • Produkte durchsuchen mit Bildern und Preisen

  • Angebote oder Aufträge erstellen

  • Verfügbarkeit in Echtzeit prüfen

  • Angebote in Rechnungen umwandeln

3. Außendienst-Techniker-App

  • Zuweisungen einsehen

  • Projektstatus aktualisieren

  • Arbeitszeit erfassen

  • Fotos oder Dokumente anhängen

4. Inventur-App

  • Barcodes scannen

  • Lagerbestände anpassen

  • Wareneingänge verbuchen

  • Lagerbewegungen erzeugen

Antwortverarbeitung und Fehlerbehandlung

HTTP-Statuscodes:

  • 200 OK – Erfolgreiche Abfrage

  • 201 Created – Erfolgreiche Erstellung

  • 400 Bad Request – Ungültige Eingaben

  • 401 Unauthorized – Falsche Authentifizierung

  • 403 Forbidden – Kein Zugriff

  • 500 Internal Server Error – API-Fehler

Typisches JSON:

{
  "success": true,
  "error": null,
  "data": {...}
}

Fehler sollten in der App sinnvoll behandelt werden.

Paginierung und Filter

Für Listen bietet die API Parameter wie:

  • limit=25&sortfield=lastname&sortorder=asc

  • sqlfilters=(status:in:(1,2))

Das spart Bandbreite und Ladezeit.

Datei-Uploads und Anhänge

Unterstützt werden Uploads z. B. für Verträge, Bilder, PDFs:

POST /documents/upload
Header:
  DOLAPIKEY: ihr_schlüssel
Body (multipart/form-data):
  refid, ref, modulepart, file

Ideal für Anhänge bei Rechnungen oder Serviceberichten.

Sicherheitsempfehlungen

  • Immer HTTPS verwenden

  • IP-Zugriff einschränken, wenn möglich

  • OAuth2 für öffentliche Apps nutzen

  • Rate Limiting in der App umsetzen

  • API-Schlüssel nicht im Quellcode speichern

Mobile Entwicklung: empfohlene Frameworks

Optionen:

  • Flutter – Schnell und plattformübergreifend

  • React Native – JS-basiert mit großem Ökosystem

  • Native Android/iOS – Für Höchstleistung

Bibliotheken: axios (JS), http (Dart), Retrofit (Java)

Best Practices beim Deployment

  • API-Versionierung verwalten

  • Statische Daten lokal cachen

  • Fehler über Logs und Analytics überwachen

  • Hintergrundsynchronisierung ermöglichen

  • Umfangreiche Tests (auch offline)

Häufige Probleme und Lösungen

401 Unauthorized: Header und Schlüssel prüfen

CORS-Probleme: Serverkonfiguration oder Proxy verwenden

HTML statt JSON: Richtiger Endpoint und Accept: application/json setzen

Praxisbeispiel: Flutter-App für Kundenverwaltung

Eine einfache App kann:

  • Per API-Key authentifizieren

  • Kundenliste via GET /thirdparties laden

  • Daten anzeigen

  • Bestellungen über GET /orders?fk_soc=ID anzeigen

  • Kundendaten via PUT /thirdparties/ID aktualisieren

Fazit

Die Anbindung einer mobilen App an Dolibarr via REST-API ermöglicht eine moderne, effiziente und flexible Verwaltung. Ob intern oder kommerziell – die REST-API ist das Tor zur mobilen Erweiterung von Dolibarr mit voller Kontrolle, Sicherheit und Skalierbarkeit.

Bemerkungen

Loggen Sie sich ein oder registrieren Sie sich, um Kommentare zu schreiben