Kowal_Affiliate - Installations- und Konfigurationsanleitung
Dieses Dokument beschreibt die Installation, Aktivierung und Erstkonfiguration des Moduls Kowal_Affiliate für Magento 2. Die Anleitung umfasst sowohl technische Anforderungen als auch praktische Schritte, die zum Start eines Affiliate-Programms im Shop erforderlich sind.
1. Systemanforderungen
Das Modul ist vorgesehen für:
- Magento Open Source / Adobe Commerce 2.4.7+
- PHP 8.2 oder 8.3
Im Magento-Projekt sollten mindestens folgende Module verfügbar sein:
Magento_StoreMagento_CmsMagento_CustomerMagento_EmailMagento_QuoteMagento_SalesMagento_SalesRuleMagento_Backend
2. Installationsmethoden
Das Modul kann standardmäßig als Composer-Paket implementiert werden.
2.1. Installation über Composer
Das Modul wird als Composer-Paket verteilt, ein beispielhafter Prozess sieht wie folgt aus:
composer require kowal/module-affiliatebin/magento module:enable Kowal_Affiliatebin/magento setup:upgradebin/magento setup:di:compilebin/magento cache:flush2.3. Produktionsmodus
Wenn der Shop im production mode läuft, empfiehlt es sich nach der Installation außerdem, Folgendes auszuführen:
bin/magento setup:static-content:deploy3. Was das Modul während der Installation erstellt
Während der Installation führt das Modul Folgendes aus:
- erstellt eigene Datenbanktabellen im Zusammenhang mit Affiliate-Funktionen,
- erweitert
quoteundsales_orderum Affiliate-Felder, - fügt Kundenattribute hinzu, die zur Verwaltung des Affiliates verwendet werden,
- erstellt eine Standard-CMS-Seite für das Partnerprogramm,
- bereitet Systemkonfiguration und Cron Jobs vor,
- registriert E-Mail-Vorlagen und Ressourcen des Adminbereichs.
3.1. Standard-CMS-Seite
Nach der Installation wird eine beispielhafte Seite des Partnerprogramms erstellt:
identifier: affiliate-programtitle: Affiliate Partnership ProgramDie Seite ist universell gehalten und kann nach einer kleinen Personalisierung der Inhalte produktiv verwendet werden.
Der Patch ist idempotent:
- wenn eine Seite mit diesem
identifierbereits existiert, wird das Modul sie nicht überschreiben.
4. Wo die Modulkonfiguration zu finden ist
Das Konfigurationspanel befindet sich unter:
Stores -> Configuration -> Affiliate ProgramDie wichtigsten Bereiche:
GeneralCommissionPayoutsAffiliate PortalNotificationsFraudAIReporting
5. Erste Konfiguration nach der Installation
Nach der Aktivierung des Moduls wird folgende Reihenfolge der Konfiguration empfohlen:
- Modul global aktivieren,
- Affiliate-Registrierung einrichten,
- Provision und Hold Period konfigurieren,
- Mindestschwelle für Auszahlungen festlegen,
- Inhalte des Affiliate-Portals ergänzen,
- Administrator-Benachrichtigungen konfigurieren,
- optional AI konfigurieren,
- Registrierung, Affiliate-Klick und Bestellung testen.
6. Detaillierte Konfiguration
6.1. General
Enable Module
Globaler Schalter des Moduls.
Wenn die Einstellung deaktiviert ist:
- sollte Affiliate-Tracking nicht funktionieren,
- sollte das Registrierungsformular nicht funktionieren,
- werden Provisionen und Payouts nicht verarbeitet.
Empfehlung:
Yesin der Produktionsumgebung nach Abschluss der Tests,Nonur für die Dauer der Deaktivierung des Programms.
Enable Affiliate Registration
Aktiviert das Anmeldeformular des Affiliate-Programms im Shop-Frontend.
Wenn die Option deaktiviert ist:
- können sich neue Partner nicht selbst registrieren,
- kann der Administrator einen Kunden weiterhin manuell als Affiliate markieren.
Tracking Cookie Lifetime (days)
Legt die Lebensdauer der cookiebasierten Attribution nach dem Klick auf einen Affiliate-Link fest.
Beispiele:
30für ein standardmäßiges Affiliate-Programm,7für kurze Kampagnen,60oder90nur dann, wenn die Programmbedingungen dies vorsehen.
Default Redirect Path
Ersatzpfad, der verwendet wird, wenn der Tracking-Link kein gültiges target enthält.
Beispiele:
/promotionscatalog/category/view/id/12
6.2. Commission
Enable Commissions
Aktiviert die Provisionsberechnung für Affiliate-Bestellungen.
Wenn das Feld deaktiviert ist:
- kann die Affiliate-Zuordnung gespeichert werden,
- aber es wird kein Eintrag in der Provisionstabelle erstellt.
Default Commission Rate (%)
Standardprovisionssatz in Prozent.
Beispiel:
10bedeutet eine Provision von 10% auf die aktuelle Berechnungsgrundlage.
Commission Hold Period (days)
Anzahl der Tage, für die die Provision im ausstehenden Status bleibt.
Nach Ablauf dieses Zeitraums kann Cron die Provision automatisch freigeben.
Empfehlung:
14als sicherer Standardwert,0nur bei einem sehr einfachen Programm ohne Rückgaberisiko.
6.3. Payouts
Enable Payouts
Aktiviert den Auszahlungs-Workflow für Affiliates.
Wenn die Option deaktiviert ist:
- kann der Partner keinen Payout-Antrag stellen,
- kann der Administrator Provisionen weiterhin analysieren, aber keine Auszahlung im Modul bearbeiten.
Minimum Payout Amount
Mindestguthaben, das für die Beantragung einer Auszahlung erforderlich ist.
Beispiele:
100250500
6.4. Affiliate Portal
Dieser Bereich steuert die Inhalte, die im Affiliate-Dashboard angezeigt werden.
Dashboard Intro
Kurze Beschreibung oben im Affiliate-Dashboard.
Sie sollte dem Partner erklären:
- wo er den Affiliate-Link findet,
- wo er Provisionen sieht,
- wie das Panel funktioniert.
Program Rules
Sichtbare Kooperationsregeln für den Affiliate.
Am besten eintragen:
- eine Regel pro Zeile,
- kurze und eindeutige Aussagen.
Banner Title
Standardtitel des beispielhaften Werbematerials.
Banner Subtitle
Kurze Beschreibung unter dem Bannertitel.
Banner Target Path
Standard-Zielpfad für Affiliate-Links und Banner.
Beispiele:
/promotions/springcatalog/category/view/id/24
6.5. Notifications
Enable Notifications
Aktiviert das interne Benachrichtigungssystem und die Notification-Queue.
Admin Notification Email
E-Mail-Adresse des Administrators, der die wichtigsten operativen Mitteilungen erhalten soll.
Wenn das Feld leer bleibt:
- kann das Modul in ausgewählten Flows die Standardadresse
generalvon Magento als Fallback verwenden.
Notification Log Retention (days)
Legt fest, wie lange Einträge im Notification-Log vor dem Cleanup gespeichert werden sollen.
6.6. Fraud
Enable Fraud Checks
Aktiviert grundlegende Anti-Fraud-Prüfungen.
Block Self Referral
Blockiert die Provision, wenn der Kunde, der die Bestellung aufgibt, gleichzeitig der mit dieser Bestellung verknüpfte Affiliate ist.
6.7. AI
Der AI-Bereich ist optional und für den grundlegenden Betrieb des Affiliate-Programms nicht erforderlich.
Enable AI
Hauptschalter der AI-Funktionen.
OpenAI API Key
API-Schlüssel für die Kommunikation mit OpenAI.
Das Feld wird in der verschlüsselten Konfiguration gespeichert.
AI Model Name
Modell, das für AI-Funktionen verwendet wird.
Die Modellliste kann nach korrektem Speichern des API-Schlüssels von OpenAI abgerufen werden.
OpenAI Request Timeout (seconds)
Maximale Wartezeit auf eine Antwort von OpenAI.
Praktische Empfehlung:
60Sekunden für stabilere Arbeit in der Produktion.
Enable AI Diagnostic Logging
Aktiviert diagnostisches Logging von AI-Requests und -Antworten.
Nützlich bei:
- Integration,
- Tests,
- Analyse von Timeouts und Antwortfehlern.
AI Diagnostic Max Chars
Maximale Länge der geloggten Payload-Vorschau.
Enable Affiliate Assistant
Aktiviert den Affiliate-Assistenten, wenn der Shop diese Funktion nutzen möchte.
Enable Weekly AI Reports
Ermöglicht die Generierung regelmäßiger AI-Zusammenfassungen.
Enable Product Knowledge Retrieval
Ermöglicht die Nutzung von Produktwissen aus Vector Store.
Enable Program Knowledge Retrieval
Ermöglicht die Nutzung von Wissen über das Affiliate-Programm, FAQ und Dokumentation.
Product Vector Store Scope
Legt fest, wie product_vector_store_id aufgelöst wird.
Product Vector Store ID
Kennung des Vector Store, wenn der Shop Retrieval nutzt.
Redact Personal Data
Entfernt oder maskiert personenbezogene Daten, bevor der Prompt an die AI-Schicht gesendet wird.
6.8. Reporting
Enable Reporting
Aktiviert die Generierung von Berichten und CSV-Exporten.
Export Directory
Pfad des Verzeichnisses, in dem generierte Exporte gespeichert werden sollen.
Beispiel:
var/export/affiliate7. Konfiguration eines Kunden als Affiliate
Nach der Installation erweitert das Modul die Magento-Kundenbearbeitung um Affiliate-Felder.
In der Kundenbearbeitung können unter anderem verwaltet werden:
Affiliate ParticipantAffiliate StatusAffiliate Referral CodeAffiliate Website URLAffiliate NotesAffiliate BalanceAffiliate Coupon Discount (%)
7.1. Affiliate Participant
Gibt an, ob der Kunde zum Affiliate-Programm gehört.
7.2. Affiliate Status
Die wichtigsten Status:
PendingActiveSuspendedRejectedBlocked
7.3. Affiliate Balance
Das Guthaben wird automatisch aus freigegebenen und auszahlungsbereiten Provisionen berechnet.
Das Feld:
- ist in der Kundenbearbeitung sichtbar,
- sollte nicht manuell bearbeitet werden,
- aktualisiert sich automatisch nach Provisionsänderungen.
7.4. Affiliate Coupon Discount (%)
Dieses Feld ermöglicht es, dem Affiliate einen Rabattprozentsatz zuzuweisen, der für seinen referral_code gilt.
Wenn Sie einen Wert größer als 0 eingeben, führt das Modul Folgendes aus:
- erstellt oder aktualisiert eine Magento-Warenkorbregel,
- setzt den Coupon gleich dem Affiliate-Code,
- ermöglicht Kunden, diesen Code als Coupon im Warenkorb zu verwenden,
- ordnet die Bestellung dem Affiliate auf Basis von
coupon_codezu.
Beispiel:
- der Affiliate hat den Code
FMX1FBXXY3 - der Administrator gibt
5ein - der Kunde gibt
FMX1FBXXY3als Rabattcoupon ein - Magento berechnet 5% Rabatt
- das Modul ordnet die Bestellung dem Affiliate zu.
8. Cron Jobs des Moduls
Das Modul verwendet Crons in der Gruppe default.
8.1. Auto approve commissions
job: kowal_affiliate_auto_approve_commissionsschedule: */15 * * * *Die Aufgabe:
- prüft Provisionen mit
pending, - ändert sie nach Ablauf der Hold Period auf
approved.
8.2. Process notifications
job: kowal_affiliate_process_notificationsschedule: */10 * * * *Die Aufgabe:
- verarbeitet die Benachrichtigungs-Queue,
- markiert Einträge als gesendet,
- versendet bei E-Mail-Kanal transaktionale Nachrichten.
8.3. Cleanup notification log
job: kowal_affiliate_cleanup_notification_logschedule: 30 2 * * *Die Aufgabe:
- entfernt alte Einträge aus dem Benachrichtigungslog gemäß der Retention.
8.4. Weekly AI insights
job: kowal_affiliate_generate_weekly_ai_insightsschedule: 0 6 * * 1Die Aufgabe:
- generiert wöchentliche AI-Insights, wenn die Funktion aktiv ist.
9. CLI-Befehle
Das Modul stellt Service-Befehle bereit:
bin/magento kowal:affiliate:auto-approvebin/magento kowal:affiliate:process-notificationsbin/magento kowal:affiliate:cleanup-notificationsbin/magento kowal:affiliate:generate-ai-insightsbin/magento kowal:affiliate:export-reportBei der ersten Inbetriebnahme sind am nützlichsten:
bin/magento kowal:affiliate:process-notificationsbin/magento kowal:affiliate:auto-approve10. Erster Test nach der Installation
Nach der Konfiguration des Moduls wird ein einfacher End-to-End-Test empfohlen.
10.1. Test der Affiliate-Registrierung
- Öffnen Sie das Affiliate-Registrierungsformular.
- Senden Sie die Bewerbung ab.
- Prüfen Sie, ob das Affiliate-Konto erstellt wurde.
- Prüfen Sie, ob der Kunde den Status
Pendinghat. - Prüfen Sie, ob Benachrichtigungseinträge erstellt wurden.
10.2. Aktivierungstest
- Öffnen Sie die Kundenbearbeitung im Adminbereich.
- Setzen Sie den Affiliate-Status auf
Activeoder verwenden Sie die Freigabeaktion. - Prüfen Sie, ob der Kunde das Affiliate-Dashboard sieht.
10.3. Test des Affiliate-Links
- Kopieren Sie den Affiliate-Link aus dem Dashboard.
- Öffnen Sie den Shop über diesen Link.
- Legen Sie ein Produkt in den Warenkorb.
- Geben Sie eine Bestellung auf.
- Prüfen Sie, ob die Bestellung Folgendes enthält:
affiliate_idaffiliate_referral_codeis_affiliate_order = 1
10.4. Test des Affiliate-Coupons
- Legen Sie für den Affiliate
Affiliate Coupon Discount (%)fest, z. B.5. - Speichern Sie den Kunden.
- Stellen Sie sicher, dass der Affiliate den Status
Activehat. - Geben Sie im Warenkorb seinen
Referral Codeals Coupon ein. - Geben Sie eine Bestellung auf.
- Prüfen Sie:
- ob der Rabatt berechnet wurde,
- ob die Bestellung dem Affiliate zugeordnet wurde,
- ob eine Provision erstellt wurde.
10.5. Test der Payouts
- Geben Sie die Provision frei oder warten Sie auf Auto-Approve.
- Prüfen Sie das Affiliate-Guthaben.
- Stellen Sie einen Auszahlungsantrag.
- Markieren Sie den Payout im Adminbereich als bezahlt.
11. Häufigste Probleme nach der Installation
11.1. Keine Provision nach der Bestellung
Prüfen Sie:
- ob die Bestellung
affiliate_identhält, - ob Provisionen aktiviert sind,
- ob das Modul nach dem Fix zur Erstellung der Provision nach dem Speichern der Affiliate-Daten auf der Order funktioniert,
- ob in der Tabelle
kowal_affiliate_commissionein Datensatz erscheint.
11.2. Kunden-Grid zeigt das aktuelle Affiliate-Guthaben nicht an
Prüfen Sie:
- ob der Index
customer_gridaktualisiert wurde, - ob nach dem Speichern
reindexRowfunktioniert, - ob der Wert in der Kundenbearbeitung mit dem Wert im Grid übereinstimmt.
Falls erforderlich, führen Sie aus:
bin/magento indexer:reindex customer_grid11.3. AI antwortet nicht
Prüfen Sie:
- ob
Enable AIaktiviert ist, - ob ein korrekter
OpenAI API Keygespeichert wurde, - ob ein Modell ausgewählt wurde,
- ob der Timeout nicht zu niedrig ist,
- ob
var/logkeine Request-Fehler zu OpenAI anzeigt.
11.4. Benachrichtigungen werden nicht gesendet
Prüfen Sie:
- ob Magento-Crons funktionieren,
- ob
Enable Notificationsaktiv ist, - ob Einträge in
kowal_affiliate_notification_loggespeichert werden, - ob Folgendes manuell ausgeführt werden kann:
bin/magento kowal:affiliate:process-notifications12. Empfohlene Startkonfiguration
Für die erste produktive Implementierung wird folgendes Set empfohlen:
Enable Module = YesEnable Affiliate Registration = YesTracking Cookie Lifetime = 30Enable Commissions = YesDefault Commission Rate = 10Commission Hold Period = 14Enable Payouts = YesMinimum Payout Amount = 100Enable Notifications = YesBlock Self Referral = YesEnable AI = Nozum Start, wenn der Shop AI nicht ab dem ersten Tag benötigt
13. Zusammenfassung
Nach korrekter Installation und Konfiguration ermöglicht Kowal_Affiliate den Start eines vollständigen Partnerprogramms in Magento 2, das Folgendes umfasst:
- Affiliates,
- Empfehlungslinks,
- Affiliate-Codes,
- Rabattcoupons für Affiliates,
- Provisionen,
- Payouts,
- Benachrichtigungen,
- Partner-Dashboard,
- grundlegende Sicherheit und Automatisierung.



















