Beispiel-Erweiterung

Eine kurze Einführung in die Erweiterung. Was sie tut, für wen sie gedacht ist und wann sie sinnvoll eingesetzt wird.

Erste Schritte

Bevor Sie loslegen, sollten Sie sicherstellen, dass die Voraussetzungen erfüllt sind.

Installation

Die Erweiterung wird wie jede Shopware-6-Erweiterung über Composer oder den Shopware Store installiert:

composer require becker-enterprises/beispiel-erweiterung
bin/console plugin:refresh
bin/console plugin:install --activate BeispielErweiterung
bin/console cache:clear

Konfiguration

Nach der Installation erscheinen in der Administration unter Einstellungen → System → Plugins die Konfigurationsoptionen.

Option	Standardwert	Beschreibung
`apiKey`	leer	API-Schlüssel des externen Systems
`intervalMinutes`	60	Synchronisationsintervall in Minuten
`dryRun`	false	Testlauf ohne Datenänderungen

Erste Schritte

Nach erfolgreicher Konfiguration können Sie die Erweiterung sofort einsetzen. Wir empfehlen, den ersten Lauf mit aktivem dryRun auszuführen, um die Auswirkungen zu prüfen.

Bedienung

Hier finden Sie die wichtigsten Anwendungsbereiche der Erweiterung.

Anwendung im Admin

Im Adminbereich erscheint ein neues Modul, in dem Sie alle relevanten Aktionen ausführen können — Status prüfen, manuelle Synchronisation auslösen, Logs einsehen.

CLI-Befehle

Für Automatisierungen stehen die folgenden Befehle zur Verfügung:

bin/console becker:beispiel:sync         # einmalige Synchronisation
bin/console becker:beispiel:status       # aktuellen Status anzeigen
bin/console becker:beispiel:reset        # Zustand zurücksetzen

Geplante Tasks

Die Erweiterung registriert einen ScheduledTask, der standardmäßig stündlich läuft. Sie können den Task in den Shopware-Einstellungen aktivieren oder deaktivieren.

Erweitert

Diese Abschnitte richten sich an Entwicklerinnen und Entwickler, die tiefer in die Integration einsteigen möchten.

API-Referenz

Die Erweiterung stellt eine REST-API zur Verfügung:

GET /api/_action/becker-enterprises/example
Authorization: Bearer {token}

Antwortet mit JSON, das den aktuellen Status der Synchronisation enthält.

Events & Hooks

Folgende Events können Sie abonnieren, um eigene Logik einzuhängen:

becker_beispiel.sync.before — vor der Synchronisation
becker_beispiel.sync.after — nach erfolgreichem Lauf
becker_beispiel.sync.error — bei Fehlern

Migration aus 1.x

Wenn Sie von Version 1.x migrieren, beachten Sie bitte die geänderte Konfigurationsstruktur. Ein Migrationsbefehl ist enthalten:

bin/console becker:beispiel:migrate-from-1x

Sonstiges

Häufige Fragen

Funktioniert die Erweiterung auch in Cluster-Setups? Ja, alle Operationen sind so gestaltet, dass sie auch in horizontal skalierten Umgebungen sicher laufen.

Werden Updates automatisch eingespielt? Nein, Updates verlaufen über den regulären Composer- oder Store-Update-Prozess.

Support

Bei Fragen oder Problemen erreichen Sie mich unter info@becker.enterprises.