Shopware Plugin Installation

Installation und Konfiguration des Shopware-Plugins für das PDF-Dokument-Modul.

Das Solutioo Invoice Documents Plugin erweitert Shopware um die Fähigkeit, PDF-Dokumente aus Business Central zu empfangen und im Kundenportal anzuzeigen.

1. Installation

1.1 Via Composer (empfohlen)

composer require solutioo/invoice-documents
bin/console plugin:refresh
bin/console plugin:install --activate SolutiooInvoiceDocuments
bin/console cache:clear

1.2 Manuelle Installation

1. Laden Sie das Plugin herunter.
2. Entpacken Sie es nach custom/plugins/SolutiooInvoiceDocuments
3. Führen Sie folgende Befehle aus:

bin/console plugin:refresh
bin/console plugin:install --activate SolutiooInvoiceDocuments
bin/console cache:clear
bin/console theme:compile

2. Plugin-Funktionen

2.1 API-Endpunkte

Das Plugin stellt folgende API-Endpunkte bereit:

Endpunkt	Methode	Beschreibung
/api/solutioo-invoice-document/import	POST	Importiert ein neues Dokument
/api/solutioo-invoice-document/by-reference/{ref}	GET	Prüft ob Dokument existiert
/api/solutioo-invoice-document/update/{id}	PATCH	Aktualisiert ein Dokument
/api/solutioo-invoice-document/delete/{id}	DELETE	Löscht ein Dokument
/api/solutioo-invoice-document/bulk	POST	Massenimport von Dokumenten

2.2 Kundenportal

Nach der Installation erscheint im Kundenbereich ein neuer Menüpunkt "Dokumente":

3. Kundenzuordnung

Das Plugin unterstützt verschiedene Methoden zur Kundenzuordnung:

Priorität der Zuordnung

Kunden-ID

Direkte Shopware-Kunden-ID (höchste Priorität)

E-Mail-Adresse

Suche nach Kunden-E-Mail

Kundennummer

Suche nach Kundennummer

Die E-Mail-Zuordnung ist besonders nützlich, wenn die Kundennummern zwischen den Systemen nicht übereinstimmen.

4. API-Authentifizierung

Die API verwendet die Standard-Shopware Admin-API-Authentifizierung:

Integration (empfohlen)

1. Erstellen Sie eine Integration in Shopware unter Einstellungen System Integrationen
2. Notieren Sie Access Key ID und Secret Access Key
3. Tragen Sie diese in Business Central ein

Benutzerauthentifizierung

Alternativ kann ein Admin-Benutzer verwendet werden:

1. Erstellen Sie einen Admin-Benutzer in Shopware
2. Nutzen Sie Benutzername und Passwort in Business Central

5. Dokumenttypen

Das Plugin unterstützt folgende Dokumenttypen:

API-Wert	Deutsche Bezeichnung	Englische Bezeichnung
invoice	Rechnung	Invoice
credit_note	Gutschrift	Credit Note
delivery_note	Lieferschein	Delivery Note
cancellation	Storno	Cancellation
other	Sonstiges	Other

6. Datenbankstruktur

Das Plugin erstellt eine neue Tabelle solutioo_invoice_document:

Feld	Typ	Beschreibung
id	binary(16)	Primärschlüssel (UUID)
customer_id	binary(16)	Zugehöriger Kunde
invoice_number	varchar(255)	Dokumentennummer
invoice_date	date	Dokumentdatum
document_type	varchar(50)	Dokumenttyp
external_reference	varchar(255)	Externe Referenz (BC-Nummer)
media_id	binary(16)	Verknüpfte Mediendatei
original_filename	varchar(255)	Originaler Dateiname

7. Updates

# Plugin aktualisieren
composer update solutioo/invoice-documents
bin/console plugin:update SolutiooInvoiceDocuments
bin/console cache:clear
bin/console theme:compile

Erstellen Sie vor Updates immer ein Backup Ihrer Datenbank!