Moduly pro Magento 2 Affilbox Uživatelský manuál

Obsah stránky

- Uživatelský manuál

Affilbox

Uživatelský manuál

Zde se dozvíte, jak pracovat s nainstalovaným rozšířením Affilbox pro Magento 2 od GetReady.

Termíny použité v tomto návodu

název	typ	popis
AffilBox.cz	Provizní systém	AffilBox.cz pomáhá obchodníkovi spravovat síť partnerů, zakládat a sledovat kampaně, a partnery odměňovat za propagaci produktů.
backend	označení	Správa systému Magento 2, nebo‑li správa e‑shopu, se provádí prostřednictvím webového administračního rozhraní. Někdy toto rozhraní nazýváme 'backend'
url	označení	(Uniform Resource Locator) hovorově 'webová adresa', je kód, který směřuje na určité místo na internetu. Na začátku je vždy protokol (https://). Url v našem návodu buď směřuje na celý web, nebo jen na konkrétní soubor na webu.
OBCHODNÍK	role	Obchodník je vlastníkem Magento2 e‑shopu, ve kterém je nainstalován modul Affilbox pro Magento 2 od GetReady
INZERENT	role	Inzerent pro obchodníka a v jeho zájmu spravuje účet ve službě AffilBox.cz
PARTNER	role	Partner pomáhá propagovat a prodávat produkty, které obchodník nabízí na svém e‑shopu. Partner za to získává provizi.
KUPUJÍCÍ	role	Kupující je zákazník, který nakupuje/nakoupí v e‑shopu obchodníka.
PROKLIK	událost	Proklik nastane, pokud se kupující dostane na e‑shop obchodníka tak, že klikne na odkaz partnera.
KONVERZE	událost	Konverze nastává ihned po odeslání objednávky. (Kupující nakoupil: vidí na e‑shopu oznámení, že objednávka byla přijata, resp. obdrží potvrzení objednávky e‑mailem)
AFFILIATE DOMÉNA	kód	(též doména provizního programu, affiliate subdoména) je základní doména, kterou získáte při vytvoření účtu v AffilBoxu. Většinou má podobu `c<XXXX>.affilbox.cz`, kde `<XXXX>` je celé číslo. S touto doménou se setkát např. v url na které se přihlašujete do Affilboxu nebo v url trackovacích a konverzních javascriptů.
Trackovací JS	url	Používá se k registrování prokliků.
Konverzní JS	url	Používá se k registrování konverzí.
AFFIL ID	kód	Unikátní kód, který identifikuje uživatele systému AffilBox. Nejčastější použití, se kterým se setkáme, je kód partnera.
AFFIL LINK	url	(odkaz, také provizní odkaz, odkaz z kampaně) Hyperlink, směřující na e‑shop obchodníka. Odkaz je umístěn např. na webu partnera. Odkaz musí obsahovat parametr `?a_box` a kód partnera.
API klíč	kód	(také API KEY) Umožňuje navázání spojení mezi e‑shopem obchodníka (backendem) a AffilBoxem. Slouži hlavně k předání informace o konverzi z e‑shopu do AffilBoxu.
KÓD KUPÓNU	kód	(také affiliate kupón) Kód kupónu se vkládá v košíku, před odesláním objednávky. Díky kódu kupónu můžeme přiřazovat konverze k partnerům a kampaním.

Obecné fungování AfillBoxu

na e‑shopu jsou trackovací a konverzní kódy
zákazník se na e‑shop dostane kliknutím na link, který obsahuje kód partnera, registrovaného v AffilBoxu.
- tato návštěva je zaregistrována v AffilBoxu
kupující zákazník učiní objednávku
- tato objednávka je zaregistrována v AffilBoxu (konverze)
v AffilBoxu je možné sledovat prokliky a konverze, počítat konverze, zakládat a sledovat kampaně, spravovat síť partnerů atd.

Více je popsáno na stránkách https://www.affilbox.cz/.

Funkčnost modulu Affilbox pro Magento 2 od GetReady

Výhody propojení systému AffilBox se systémem Magento 2 pomocí našeho modulu jsou popsány v následujících scénářích. Nejprve však uvedeme nutné kroky (nastavení), které musí předcházet těmto scénářům:

Výchozí stav

Obchodník má fungující Magento 2 e‑shop	Obchodník/Inzerent má připravený účet v AffilBoxu:
- nainstalovaný a nastavený modul Affilbox pro Magento 2 od GetReady	- má partnery - má nastavenu jednu nebo více kampaní - kampaně mají nastavené kupóny, v souladu s nastavením kupónů v košíkových pravidlech v Magento 2 - kupóny mají přiřazené partnery

Scénáře propojení Magento 2 - Affilbox

Scénáře 0 až 4 jsou dílčí.
Kompletní spolupráce mezi Magento 2 a AffilBoxem je popsána ve scénáři 5.

Scénář 0

akce	výsledek
Kupující se dostane na e‑shop bez použití provizního odkazu.	Proklik není zaregistrován v Affilboxu.

Scénář 1

akce	výsledek
Kupující se dostane na e‑shop tak, že klikne na provizní odkaz.	Proklik je zaregistrován v defaultní kampani.

Scénář 2

akce	výsledek
Kupující objedná bez affiliate kupónu	Konverze se NEÚPLNĚ zaregistruje na defaultní kampaň

Scénář 3

akce	výsledek
Kupující nakoupí s affiliate kuponem	V AffilBoxu se vytvoří provize pro partnera.⁽¹⁾ Konverze má v AffilBoxu stav 'Nerozhodnutá'
Objednávka je úspěšně vyřízená. (vyfakturovaná, odeslaná)	Objednávka má v e‑shopu status 'Complete' ('Dokončená')
Pokud je objednávka po uplynutí X dní⁽²⁾ stále ve stavu 'Complete', e‑shop pošle do AffilBoxu potvrzení konverze.	Konverze má v AffilBoxu stav 'Schválená'

⁽¹⁾Partner, kampaň a kupón jsou předem "svázáni",
v nastavení e‑shopu i v nastavení kampaně v AffilBoxu)

⁽²⁾Počet dní X se nastavuje v konfiguraci e‑shopu.

Scénář 4

akce	výsledek
Kupující nakoupí s affiliate kuponem	V AffilBoxu se vytvoří provize pro partnera. Konverze má v AffilBoxu stav 'Nerozhodnutá'
Objednávka je úspěšně vyřízená.	Objednávka má v e‑shopu status 'Complete'
Během X dní po vyřízení je objednávka zrušena. (Například z důvodu nevyzvednutí apod.)	Objednávka v e-shopu má status 'Canceled' ('Zrušená'). Konverze v AffillBoxu má stav 'Zamítnutá'

Scénář 5

akce	výsledek
Kupující nakoupí s affiliate kuponem	V AffilBoxu se vytvoří provize pro partnera. Konverze má v AffilBoxu stav 'Nerozhodnutá'
V Magento 2 administraci je změněna objednávka	V e‑shopu je zrušena původní objednávka a vytvořena nová. Původní konverze v AffillBoxu má stav 'Zamítnutá' Je vytvořena nová konverze, má stav 'Nerozhodnutá'
Pokud je objednávka po uplynutí X dní stále ve stavu 'Complete', e‑shop pošle do AffilBoxu potvrzení konverze.	Konverze má v AffilBoxu stav 'Schválená'

Nastavení modulu AffilBox

Modul AffilBox se v administraci systému Magento 2 nastavuje na dvou místech: v konfiguraci a v košíkových pravidlech.

Do konfigurace vyplňujeme údaje defaultní kampaně, do košíkového pravidla (košíkových pravidel) pak údaje ke kupónovým kampaním.

Většinu hodnot budeme vyplňovat podle hodnot z účtu v AffilBoxu (affilbox.cz).

Cesta v backendu ke konfiguraci:

česky: OBCHODY > Nastavení/Nastavení > AFFILBOX > Affilbox nastavení

anglicky: STORES > Settings/Configuration > AFFILBOX > Affilbox Settings

Cesta v backendu ke košíkovým pravidlům:

česky: MARKETING > Pravidla/Cenová pravidla košíku

anglicky: MARKETING > Promotions/ Cart Price Rules

Ukázka nastavení modulu AffilBox

Pro tuto ukázku používáme vymyšlené (nefunkční) údaje.

Pro skutečné nastavení potřebujete mít připravený svůj účet v AffilBoxu, vytvořené kampaně a existující partnery.

Backend e‑shopu - konfigurace

přihlašte se do backendu
proklikejte se na nastavení AffilBoxu:
OBCHODY > Nastavení/Nastavení > AFFILBOX > Affilbox nastavení
v poli 'Zapnuto' vyberte 'Ano'
do pole 'Trackovací JS' vložte správné url. (končí názvem souboru 't3.js')
do pole 'Konverzní JS' vložte správné url. (končí názvem souboru 'c3.js')
do pole 'Inzerent' vložte ID inzerenta (celé číslo)
do pole 'Kampaň' vložte ID kampaně (celé číslo)
do pole 'API KEY' vložte API klíč. Je to speciální kód, umožňující komunikaci Magento 2 backendu s AffilBoxem.
do pole 'Potvrdit po N dnech' vložte počet dní (celé číslo, minimálně 1). Až po uplynutí tohoto počtu dní se potvrzuje konverze.
Konfiguraci uložte kliknutím na 'Uložit nastavení'.

Backend e‑shopu - košíkové pravidlo

Pro každou reklamní kampaň v AffilBoxu musí vzniknout jedno kupónové slevové pravidlo s minimálně 1 kupónem.

proklikejte se na nastavení košíkových pravidel:
MARKETING > Pravidla/Cenová pravidla košíku
klikněte na 'Přidat nové pravidlo'
začněte pojmenováním pravidla. V našem případě vytváříme pravidlo pro kampaň č.5 z AffilBoxu, a kupující s platným kupónem dostane 3 procenta slevu. Takže odpovídajícím způsobem vyplníme pole 'Název pravidla' a 'Popis' (viz obr.)
pro aktivaci pravidla nastavte pole 'Aktivní' na 'Ano'.
zvolte, jakých obchodů a jakých skupin zákazníků se pravidlo týká.

z nabídky 'Kupón' vyberte 'Určitý kupón' ('Specific Coupon')
do pole 'Slevový kód' vyplňte kupónový kód přesně tak, jak je uveden v kampani v AffilBoxu. (V tomto příkladu je to 'SLEVA')

MŮŽETE POUŽÍT I AUTOMATICKÉ GENEROVÁNÍ KUPÓNŮ
(bližší popis jak na to není předmětem tohoto návodu - zde je odkaz na oficiální Magento dokumentaci):
Generate a batch of coupons
Je však nutné upozornit, že pokud budete kupónové kódy automaticky generovat v tomto košíkovém pravidle, musíte pak vygenerované aktivní kupónové kódy zase nastavit do konkrétní kampaně v AffilBoxu!

v sekci 'Affilbox', do pole 'Inzerent' vyplňte ID inzerenta. (celé číslo) Získáte jej z nastavení kampaně v AffilBoxu.
v sekci 'Affilbox', do pole 'Kampaň' vyplňte ID kampaně. (celé číslo) Získáte jej z nastavení kampaně v AffilBoxu.

nastavíme slevu 3 procenta (dle obrázku)
Ostatní vlastnosti košíkového pravidla nastavte dle potřeby nebo je můžete vynechat: podmínky, doprava zdarma, časová platnost pravidla atd. Pro spojení s účtem AffilBox a trackování konverzí jsou nejdůležitější 'Inzerent', 'Kampaň' a 'Slevový kód'.
uložte pravidlo kliknutím na 'Uložit'

Jak získat potřebné hodnoty pro nastavení?

Před použitím modulu Affilbox pro Magento 2 od GetReady potřebujete mít připravený a nastavený účet v AffilBoxu.

Zde si ukážeme, kde v nastavení AffilBoxu najdeme potřebné hodnoty pro nastavení modulu.

pro screenshoty je použita demoverze https://demo.affilbox.cz/

hodnota	umístění v účtu AffilBox
API KEY	API klíč bjem3aldget9vvff najdeme v nastavení uživatele (v tomto případě v nastavení inzerenta)
AFFILIATE DOMÉNA	affiliate doména c9876.affilbox.cz je v kódu v proměnné 'ab_instance' (Nastavení kampaně, záložka 'Kódy')
ID inzerenta, ID kampaně	ID inzerenta 1 a id kampaně 5 najdete v kódu v proměnných 'ab_inzerent' a 'ab_kampan'
Trackovací JS, Konverzní JS	Trackovací JS (URL) https://c9876.affilbox.cz/t3.js a Konverzní JS (URL) https://c9876.affilbox.cz/c3.js najdete v kódu v atributech 'src'
KÓD KUPÓNU	Kód kupónu SLEVA najdete v kampani v záložce 'Kupóny', ve výpisu kupónů ve sloupci 'Označení'
AFFIL LINK	Provizní odkaz https://www.getready.cz/demo/?a_box=m6u2mjat najdete v nastavení uživatele/partnera, nebo, pokud jste pod tímto uživatelem přihlášení, na kartě každé kampaně.