Inhaltsverzeichnis

  1. Einführung

  2. Überblick über die modulare Architektur von Dolibarr

  3. Was ist Stancer und warum sollte man es verwenden?

  4. Einrichten der Entwicklungsumgebung

  5. Die Modulstruktur von Dolibarr verstehen

  6. Erstellen des Modulgerüsts

  7. Konfigurieren von Moduleigenschaften und Abhängigkeiten

  8. Authentifizierung mit der Stancer-API

  9. Erstellen von Zahlungsschnittstellen in Dolibarr

  10. Abwicklung von Zahlungstransaktionen

  11. Speichern von Transaktionen in der Datenbank

  12. Hinzufügen von Hooks und Triggern

  13. Integration mit Rechnungen und Bestellungen

  14. Zahlungsstatus verwalten

  15. Fehlerbehandlung und Protokollierung

  16. Testen und Debuggen des Moduls

  17. Sichern der API-Kommunikation

  18. Übersetzen und Lokalisieren des Moduls

  19. Verpacken und Verteilen des Moduls

  20. Wartung und Versionierung

  21. Zusammenfassung und Empfehlungen

1. Einleitung

Da digitale Zahlungen im modernen Geschäftsbetrieb immer wichtiger werden, ist eine nahtlose Integration zwischen ERP-Systemen und Zahlungsgateways unerlässlich. Dolibarr ERP & CRM ist Open Source und modular aufgebaut und ermöglicht die individuelle Integration mit Drittanbieterdiensten. Dieser Artikel bietet eine Schritt-für-Schritt-Anleitung zum Erstellen eines benutzerdefinierten Zahlungsmoduls mit der Stancer-API für Dolibarr.

2. Überblick über die modulare Architektur von Dolibarr

Dolibarr verwendet ein modulares Design, das es Entwicklern ermöglicht, neue Funktionen zu erstellen und zu integrieren. Module sind isolierte Verzeichnisse, die PHP-Dateien, Vorlagen, Konfigurationsskripte und Hooks enthalten. Ein gut strukturiertes Modul kann aktiviert oder deaktiviert werden, ohne das Kernsystem zu beeinträchtigen.

3. Was ist Stancer und warum sollte man es verwenden?

Stancer ist eine Zahlungsplattform mit RESTful-APIs zur Annahme und Verwaltung von Kreditkarten- und SEPA-Transaktionen. Sie ist für Entwickler konzipiert und unterstützt wiederkehrende Zahlungen, Rückerstattungen und Betrugserkennung.

Gründe für die Integration von Stancer mit Dolibarr sind:

  • Einfache API-Schnittstelle

  • Wettbewerbsfähige Preise

  • Echtzeitverarbeitung

  • Kompatibilität mit dem französischen und europäischen Markt

4. Einrichten der Entwicklungsumgebung

Beginnen:

  • Installieren Sie Dolibarr lokal oder auf einem Entwicklungsserver

  • Richten Sie Apache, MySQL und PHP ein (vorzugsweise über einen LAMP/WAMP-Stack)

  • Klonen Sie das Dolibarr GitHub-Repository für Modulreferenzen

  • Registrieren Sie sich für ein Stancer-Entwicklerkonto, um API-Anmeldeinformationen zu erhalten

5. Die Dolibarr-Modulstruktur verstehen

Ein Dolibarr-Modul umfasst im Allgemeinen:

  • modMyModule.class.php: Moduldeskriptor

  • /core/ für Konfigurationsdateien und Helfer

  • /admin/ für die Konfigurations-UI

  • /class/ für Business-Logik-Klassen

  • /scripts/ für CRON-Jobs oder CLI-Tools

  • /tpl/ für HTML-Vorlagen

6. Erstellen des Modulgerüsts

Beginnen Sie, indem Sie ein Basismodul duplizieren und alle Vorkommen umbenennen:

  • Ersetzen Sie Namen durch stancerpayment

  • Aktualisieren Sie Klassennamen und Dateireferenzen

7. Konfigurieren von Moduleigenschaften und Abhängigkeiten

Bearbeiten modStancerPayment.class.php:

  • Name, Version und Beschreibung festlegen

  • Abhängigkeiten deklarieren (zB Rechnung, Zahlung)

  • Definieren Sie Registerkarten, Berechtigungen und Setup-Werte

Registrieren Sie das Modul im Admin-Panel von Dolibarr.

8. Authentifizierung mit der Stancer-API

Stancer verwendet eine grundlegende HTTP-Authentifizierung:

  • API-Schlüssel sicher in der Modulkonfiguration speichern

  • Erstellen Sie eine Serviceklasse zum Verarbeiten von HTTP-Anfragen

  • Verwenden Sie curl oder Guzzle, um die Kommunikation zu verwalten

9. Erstellen von Zahlungsschnittstellen in Dolibarr

Zahlungsformulare und Schnittstellen gestalten:

  • Fügen Sie auf Rechnungen eine Schaltfläche „Mit Stancer bezahlen“ hinzu

  • Erstellen Sie einen Controller (/stancer/payment.php) zur Bearbeitung von Anfragen

  • Verwenden Sie die Vorlagen-Engine von Dolibarr, um das UI-Design anzupassen

10. Abwicklung des Zahlungsverkehrs

Wenn der Benutzer die Zahlung übermittelt:

  • Erfassen von Rechnungsdaten und Kundeninformationen

  • Transaktion über die Stancer-API einleiten

  • Behandeln von Erfolgs- oder Fehlerantworten

  • Aktualisieren Sie die Dolibarr-Rechnung entsprechend

11. Transaktionen in der Datenbank speichern

Erstellen Sie eine benutzerdefinierte SQL-Tabelle (z. B. llx_stancer_transactions) zum Speichern von:

  • Zahlungs-ID

  • Rechnungs-ID

  • Summe

  • Status

  • Timestamp

Verwenden Sie die DoliDB-API von Dolibarr, um Einträge zu verwalten.

12. Hinzufügen von Hooks und Triggern

Nutzen Sie den Hook-Manager von Dolibarr zur Erweiterung:

  • Rechnungsseiten

  • Zahlungsbestätigungs-Workflows

Beispiel: Fügen Sie einen Hook hinzu, um den Zahlungsstatus in der Rechnungsdetailansicht anzuzeigen.

13. Integration mit Rechnungen und Bestellungen

Stellen Sie sicher, dass das Modul mit dem Rechnungsstatus verknüpft ist:

  • Aktualisieren Sie die Rechnung auf „Bezahlt“, wenn die Transaktion erfolgreich war

  • Zahlungsbeleg generieren

  • Verweis auf die Stancer-Zahlungs-ID hinzufügen

14. Zahlungsstatus verwalten

Erstellen Sie eine Logik zum Synchronisieren oder Abfragen des Status von Stancer:

  • Erfolg

  • Zu überprüfen

  • Gescheitert

  • Erstattet

Stellen Sie eine Administratoransicht zum Überprüfen und Verwalten von Transaktionen bereit.

15. Fehlerbehandlung und Protokollierung

Implementieren Sie detaillierte Fehlermeldungen und Protokollierung:

  • Benutzerfreundliche Anzeige von Fehlern auf der Benutzeroberfläche

  • Schreiben Sie Fehler in Dolibarr-Protokolle oder eine benutzerdefinierte Protokolldatei

  • Behandeln Sie Timeouts, ungültige API-Schlüssel und Eingabevalidierung

16. Testen und Debuggen des Moduls

Führen Sie Unit- und Integrationstests durch:

  • Simulieren Sie verschiedene Transaktionsergebnisse

  • Verwenden Sie die Sandbox-Umgebung von Stancer

  • Datenbankeinträge validieren

  • Verwenden Sie XDebug- oder PHP-Fehlerprotokolle

17. Sicherung der API-Kommunikation

  • Verwenden Sie HTTPS für alle API-Aufrufe

  • Geben Sie Anmeldeinformationen niemals in Protokollen preis

  • Bereinigen Sie alle Eingaben vor dem Senden

  • Sichern Sie den Konfigurationsbildschirm mit Administratorrechten

18. Übersetzen und Lokalisieren des Moduls

Unterstützung mehrerer Sprachen:

  • Nutzen Sie langs->trans() für Saiten

  • Bereitstellung eines .lang Dateien unter /langs/

  • Übersetzen Sie Admin-Oberflächen und Fehlermeldungen

19. Verpacken und Verteilen des Moduls

  • Zippen Sie den Modulordner (stancerpayment/)

  • Stellen Sie eine README-Datei mit Installationsanweisungen bereit

  • Optionales Senden an Dolistore zur öffentlichen Verfügbarkeit

20. Wartung und Versionierung

Befolgen Sie die semantische Versionierung:

  • Verwenden Sie Änderungsprotokolle, um Updates zu verfolgen

  • Behalten Sie die Kompatibilität mit neuen Dolibarr-Versionen bei

  • Überwachen Sie regelmäßig Änderungen an der Stancer-API

21. Zusammenfassung und Empfehlungen

Die Entwicklung eines Zahlungsmoduls für Dolibarr mithilfe der Stancer-API ist eine wertvolle Investition für Unternehmen, die automatisierte Zahlungsabläufe anstreben. Durch die Nutzung des modularen Systems von Dolibarr und der robusten Stancer-API können Entwickler ein nahtloses, sicheres und benutzerfreundliches Erlebnis für Administratoren und Kunden schaffen.

Sorgfältige Beachtung von Authentifizierung, Berechtigungsverwaltung und UI-Konsistenz gewährleistet langfristigen Erfolg und einfache Wartung. Die Einhaltung bewährter Verfahren für Sicherheit, Übersetzung und Dokumentation macht das Modul anpassungsfähiger und professioneller.

Ob für den internen Gebrauch oder die kommerzielle Verteilung, diese Integration demoveranschaulicht die Flexibilität und Erweiterbarkeit von Dolibarr als vollständige ERP-Lösung.