Kowal_Affiliate - installatie- en configuratiehandleiding
Dit document beschrijft de installatie, activering en eerste configuratie van de module Kowal_Affiliate voor Magento 2. De handleiding omvat zowel de technische vereisten als de praktische stappen die nodig zijn om het affiliateprogramma in de webshop te starten.
1. Systeemvereisten
De module is bedoeld voor:
- Magento Open Source / Adobe Commerce 2.4.7+
- PHP 8.2 of 8.3
In het Magento-project moeten minimaal de volgende modules beschikbaar zijn:
Magento_StoreMagento_CmsMagento_CustomerMagento_EmailMagento_QuoteMagento_SalesMagento_SalesRuleMagento_Backend
2. Installatiemethoden
De module kan standaard als Composer-pakket worden geïmplementeerd.
2.1. Installatie via Composer
De module wordt gedistribueerd als Composer-pakket. Een voorbeeldproces ziet er als volgt uit:
composer require kowal/module-affiliatebin/magento module:enable Kowal_Affiliatebin/magento setup:upgradebin/magento setup:di:compilebin/magento cache:flush
2.3. Productiemodus
Als de webshop in production mode draait, is het na installatie ook aan te raden om uit te voeren:
bin/magento setup:static-content:deploy
3. Wat de module tijdens installatie aanmaakt
Tijdens de installatie doet de module het volgende:
- maakt eigen databasetabellen aan die verband houden met affiliatie,
- breidt
quote en sales_order uit met affiliatevelden, - voegt klantattributen toe die worden gebruikt voor affiliatebeheer,
- maakt een standaard CMS-pagina voor het partnerprogramma aan,
- bereidt systeemconfiguratie en cron jobs voor,
- registreert e-mailsjablonen en resources van het beheerpaneel.
3.1. Standaard CMS-pagina
Na installatie wordt een voorbeeldpagina voor het partnerprogramma aangemaakt:
identifier: affiliate-programtitle: Affiliate Partnership Program
De pagina heeft een universeel karakter en kan na kleine personalisatie van de inhoud in productie worden gebruikt.
De patch is idempotent:
- als een pagina met deze
identifier al bestaat, overschrijft de module deze niet.
4. Waar u de configuratie van de module vindt
Het configuratiepaneel bevindt zich in:
Stores -> Configuration -> Affiliate Program
Belangrijkste secties:
GeneralCommissionPayoutsAffiliate PortalNotificationsFraudAIReporting
5. Eerste configuratie na installatie
Na activering van de module wordt de volgende configuratievolgorde aanbevolen:
- schakel de module globaal in,
- stel affiliate-registratie in,
- configureer de commissie en hold period,
- stel de minimale uitbetalingsdrempel in,
- vul de inhoud van het affiliateportaal aan,
- configureer beheerdersmeldingen,
- configureer optioneel AI,
- voer een test uit van registratie, affiliateklik en bestelling.
6. Gedetailleerde configuratie
6.1. General
Module inschakelen
Globale schakelaar van de module.
Als de instelling is uitgeschakeld:
- zou affiliate-tracking niet moeten werken,
- zou het registratieformulier niet moeten werken,
- worden commissies en payouts niet verwerkt.
Aanbeveling:
Yes op de productieomgeving na afronding van de tests,No alleen voor de periode waarin het programma wordt uitgeschakeld.
Affiliate-registratie inschakelen
Schakelt het aanmeldformulier voor het affiliateprogramma aan de frontend van de webshop in.
Als de optie is uitgeschakeld:
- kunnen nieuwe partners zich niet zelfstandig registreren,
- kan de beheerder nog steeds handmatig een klant als affiliate markeren.
Levensduur van trackingcookie dagen
Bepaalt de levensduur van cookiegebaseerde attributie na het klikken op een affiliatelink.
Voorbeelden:
30 voor een standaard affiliateprogramma,7 voor korte campagnes,60 of 90 alleen als het programmareglement dit voorziet.
Standaard redirectpad
Fallbackpad dat wordt gebruikt wanneer de trackinglink geen geldige target bevat.
Voorbeelden:
/promotionscatalog/category/view/id/12
6.2. Commission
Commissies inschakelen
Schakelt commissieberekening voor affiliatebestellingen in.
Als het veld is uitgeschakeld:
- kan affiliatie worden opgeslagen,
- maar wordt er geen record in de commissietabel aangemaakt.
Standaard commissietarief (%)
Standaard percentage voor commissie.
Voorbeeld:
10 betekent 10% commissie over de huidige berekeningsbasis.
Commission Hold Period dagen
Het aantal dagen gedurende welke de commissie de status in behandeling behoudt.
Na afloop van deze periode kan cron de commissie automatisch goedkeuren.
Aanbeveling:
14 als veilige standaardwaarde,0 alleen bij een zeer eenvoudig programma zonder risico op retouren.
6.3. Payouts
Payouts inschakelen
Schakelt de uitbetalingsworkflow voor affiliates in.
Als de optie is uitgeschakeld:
- kan de partner geen payout aanvragen,
- kan de beheerder commissies nog steeds analyseren, maar geen uitbetaling in de module verwerken.
Minimaal payoutbedrag
Het minimale saldo dat vereist is om een uitbetaling aan te vragen.
Voorbeelden:
6.4. Affiliate Portal
Deze sectie beheert de inhoud die in het affiliatiedashboard wordt weergegeven.
Dashboard Intro
Korte beschrijving bovenaan het affiliatiedashboard.
Deze moet aan de partner uitleggen:
- waar de affiliatelink te vinden is,
- waar de commissies zichtbaar zijn,
- hoe het paneel werkt.
Program Rules
Zichtbare samenwerkingsregels voor de affiliate.
Het beste is om in te voeren:
- één regel per regel,
- korte en eenduidige berichten.
Banner Title
Standaardtitel van het voorbeeldpromotiemateriaal.
Banner Subtitle
Korte beschrijving onder de bannertitel.
Banner Target Path
Standaard targetpad voor affiliatelinks en banners.
Voorbeelden:
/promotions/springcatalog/category/view/id/24
6.5. Notifications
Meldingen inschakelen
Schakelt het interne meldingssysteem en de notificatiewachtrij in.
E-mailadres voor beheerdersmeldingen
Het e-mailadres van de beheerder dat de belangrijkste operationele berichten moet ontvangen.
Als het veld leeg blijft:
- kan de module het standaardadres
general van Magento gebruiken als fallback in geselecteerde flows.
Bewaartermijn van notificatielog dagen
Bepaalt hoe lang records in het notificatielog moeten worden bewaard voordat cleanup plaatsvindt.
6.6. Fraud
Fraudecontroles inschakelen
Schakelt basiscontroles voor antifraude in.
Self Referral blokkeren
Blokkeert de commissie wanneer de klant die de bestelling plaatst tegelijk de affiliate is die aan deze bestelling is gekoppeld.
6.7. AI
De AI-sectie is optioneel en is niet vereist voor de basiswerking van het affiliateprogramma.
AI inschakelen
Hoofdschakelaar voor AI-functies.
OpenAI API Key
API-sleutel voor communicatie met OpenAI.
Het veld wordt opgeslagen in versleutelde configuratie.
AI Model Name
Model dat voor AI-functies wordt gebruikt.
De lijst met modellen kan worden opgehaald uit OpenAI nadat de API-sleutel correct is opgeslagen.
OpenAI Request Timeout seconden
Maximale wachttijd voor een antwoord van OpenAI.
Praktische aanbeveling:
60 seconden voor stabielere werking in productie.
Diagnostische AI-logging inschakelen
Schakelt diagnostische logging van AI-requests en antwoorden in.
Nuttig bij:
- integratie,
- tests,
- analyse van time-outs en antwoordfouten.
AI Diagnostic Max Chars
Maximale lengte van de gelogde payload-preview.
Affiliate Assistant inschakelen
Schakelt de affiliateassistent in als de webshop deze functie wil gebruiken.
Wekelijkse AI-rapporten inschakelen
Maakt het mogelijk om cyclische AI-samenvattingen te genereren.
Product Knowledge Retrieval inschakelen
Maakt het mogelijk om productkennis uit Vector Store te gebruiken.
Program Knowledge Retrieval inschakelen
Maakt het mogelijk om kennis over het affiliateprogramma, FAQ en documentatie te gebruiken.
Product Vector Store Scope
Bepaalt hoe product_vector_store_id wordt opgelost.
Product Vector Store ID
Identifier van Vector Store als de webshop retrieval gebruikt.
Persoonsgegevens redigeren
Verwijdert of maskeert persoonsgegevens voordat de prompt naar de AI-laag wordt verzonden.
6.8. Reporting
Rapportage inschakelen
Schakelt het genereren van rapporten en CSV-exports in.
Export Directory
Pad naar de directory waarin gegenereerde exports moeten worden opgeslagen.
Voorbeeld:
var/export/affiliate
7. Klant configureren als affiliate
Na installatie breidt de module de Magento-klantbewerking uit met affiliatevelden.
In de klantbewerking kunt u onder andere beheren:
Affiliate ParticipantAffiliate StatusAffiliate Referral CodeAffiliate Website URLAffiliate NotesAffiliate BalanceAffiliate Coupon Discount (%)
7.1. Affiliate Participant
Geeft aan of de klant deelneemt aan het affiliateprogramma.
7.2. Affiliate Status
Belangrijkste statussen:
PendingActiveSuspendedRejectedBlocked
7.3. Affiliate Balance
Het saldo wordt automatisch berekend op basis van goedgekeurde commissies die klaar zijn voor uitbetaling.
Het veld:
- is zichtbaar in de klantbewerking,
- mag niet handmatig worden bewerkt,
- wordt automatisch bijgewerkt na wijzigingen in commissies.
7.4. Affiliate Coupon Discount (%)
Met dit veld kan aan de affiliate een kortingspercentage worden toegewezen dat werkt op zijn referral_code.
Als u een waarde groter dan 0 invoert, doet de module het volgende:
- maakt een Magento-winkelwagenregel aan of werkt deze bij,
- stelt de coupon gelijk aan de affiliatecode,
- maakt het voor klanten mogelijk om deze code als coupon in de winkelwagen te gebruiken,
- wijst de bestelling toe aan de affiliate op basis van
coupon_code.
Voorbeeld:
- de affiliate heeft de code
FMX1FBXXY3 - de beheerder voert
5 in - de klant voert
FMX1FBXXY3 in als kortingscoupon - Magento berekent 5% korting
- de module wijst de bestelling toe aan de affiliate.
8. Cron jobs van de module
De module gebruikt crons in de groep default.
8.1. Auto approve commissions
job: kowal_affiliate_auto_approve_commissionsschedule: */15 * * * *
Taak:
- controleert commissies met
pending, - wijzigt deze na afloop van de hold period naar
approved.
8.2. Process notifications
job: kowal_affiliate_process_notificationsschedule: */10 * * * *
Taak:
- verwerkt de meldingenwachtrij,
- markeert records als verzonden,
- verzendt transactionele berichten bij het e-mailkanaal.
8.3. Cleanup notification log
job: kowal_affiliate_cleanup_notification_logschedule: 30 2 * * *
Taak:
- verwijdert oude records uit het meldingenlog volgens de retentie.
8.4. Weekly AI insights
job: kowal_affiliate_generate_weekly_ai_insightsschedule: 0 6 * * 1
Taak:
- genereert wekelijkse AI-insights als de functie actief is.
9. CLI-commando's
De module biedt servicecommando's:
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-report
Het nuttigst bij de eerste opstart zijn:
bin/magento kowal:affiliate:process-notificationsbin/magento kowal:affiliate:auto-approve
10. Eerste test na installatie
Na configuratie van de module wordt een eenvoudige end-to-end-test aanbevolen.
10.1. Test van affiliate-registratie
- Ga naar het registratieformulier voor affiliates.
- Verzend de aanmelding.
- Controleer of het affiliateaccount is aangemaakt.
- Controleer of de klant de status
Pending heeft. - Controleer of notificatierecords zijn aangemaakt.
10.2. Activeringstest
- Open de klantbewerking in het adminpaneel.
- Stel de affiliatestatus in op
Active of gebruik de goedkeuringsactie. - Controleer of de klant het affiliatiedashboard ziet.
10.3. Test van de affiliatelink
- Kopieer de affiliatelink uit het dashboard.
- Ga via deze link naar de webshop.
- Voeg een product toe aan de winkelwagen.
- Plaats een bestelling.
- Controleer of de bestelling het volgende heeft:
affiliate_idaffiliate_referral_codeis_affiliate_order = 1
10.4. Test van de affiliatecoupon
- Stel voor de affiliate
Affiliate Coupon Discount (%) in, bijvoorbeeld 5. - Sla de klant op.
- Controleer of de affiliate de status
Active heeft. - Voer in de winkelwagen zijn
Referral Code in als coupon. - Plaats een bestelling.
- Controleer:
- of de korting is berekend,
- of de bestelling aan de affiliate is toegewezen,
- of de commissie is aangemaakt.
10.5. Test van payouts
- Keur de commissie goed of wacht op auto-approve.
- Controleer het affiliatesaldo.
- Dien een uitbetalingsverzoek in.
- Markeer de payout als betaald in het adminpaneel.
11. Meest voorkomende problemen na installatie
11.1. Geen commissie na bestelling
Controleer:
- of de bestelling
affiliate_id heeft, - of commissies zijn ingeschakeld,
- of de module werkt na de correctie voor het aanmaken van commissies na het opslaan van affiliategegevens op de order,
- of er een record verschijnt in de tabel
kowal_affiliate_commission.
11.2. Klantengrid toont het actuele affiliatesaldo niet
Controleer:
- of de index
customer_grid is vernieuwd, - of
reindexRow werkt na opslagen, - of de waarde in de klantbewerking overeenkomt met de waarde in de grid.
Start indien nodig:
bin/magento indexer:reindex customer_grid
11.3. AI reageert niet
Controleer:
- of
Enable AI is ingeschakeld, - of de juiste
OpenAI API Key is opgeslagen, - of een model is geselecteerd,
- of de timeout niet te laag is,
- of
var/log geen fouten toont van de request naar OpenAI.
11.4. Meldingen worden niet verzonden
Controleer:
- of Magento-crons werken,
- of
Enable Notifications actief is, - of records worden opgeslagen in
kowal_affiliate_notification_log, - of u handmatig kunt starten:
bin/magento kowal:affiliate:process-notifications
12. Aanbevolen startconfiguratie
Voor de eerste productie-implementatie wordt de volgende set aanbevolen:
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 = No bij de start, als de webshop AI niet vanaf de eerste dag nodig heeft
13. Samenvatting
Na correcte installatie en configuratie maakt Kowal_Affiliate het mogelijk om in Magento 2 een volledig partnerprogramma te starten dat bestaat uit:
- affiliates,
- referrallinks,
- affiliatecodes,
- kortingscoupons voor affiliates,
- commissies,
- payouts,
- meldingen,
- partnerdashboard,
- basisbeveiliging en automatisering.