edee.oneDocs
EdeeShop · Implementace

Affiliate

Upraveno

Rozšíření, které umožňuje napojení na affiliate programy. Více informací naleznete zde.

Toto rozšíření umožňuje přiřadit k objednávkám informace o affiliate partnerovi, který zprostředkoval daný nákup.

Uložení affiliate parametrů k objednávce je možné pomocí update košíku affiliateDataUpdate, viz dokumentace.

Lze přiřadit pouze parametry, které jsou definovány v konfiguračním souboru.

Konfigurační soubor se standardně nachází v adresáři:
config/module-edeeshop/features/third-party/affiliate.xml

Příklad konfigurace

xml
<affiliate>    <cj>        <cid>123456</cid>        <type>123456</type>        <apiUrl>https://www.kdukvh.com/u</apiUrl>        <includeUsedCreditInDiscount/>    </cj>    <ehub>        <campaignId>123456</campaignId>        <apiUrl>https://ehub.cz/system/scripts/sale.php</apiUrl>        <debugMode>false</debugMode>        <defaultProductCategoryCode>def</defaultProductCategoryCode>        <productCategories>            <category>CATEGORYA</category>        </productCategories>        <sendOrderItems>false</sendOrderItems>        <validity>14d</validity>        <zeroPricePayment>zdarma</zeroPricePayment>    </ehub>    <attemptCountLimit>5</attemptCountLimit>    <avoidSending>5</avoidSending>    <catalogSpecific>        <catalogCode/>        <cj>            <cid>123456</cid>            <type>123456</type>            <apiUrl>https://www.kdukvh.com/u</apiUrl>            <includeUsedCreditInDiscount/>        </cj>        <ehub>            <campaignId>123456</campaignId>            <apiUrl>https://ehub.cz/system/scripts/sale.php</apiUrl>            <debugMode>false</debugMode>            <defaultProductCategoryCode>def</defaultProductCategoryCode>            <productCategories>                <category>CATEGORYA</category>            </productCategories>            <sendOrderItems>false</sendOrderItems>            <validity>14d</validity>            <zeroPricePayment>zdarma</zeroPricePayment>        </ehub>        <avoidSending>5</avoidSending>    </catalogSpecific></affiliate>

Popis

affiliate

Konfigurace affiliate feature a zapnutí jednotlivých služeb, které lze v rámci affiliate feature použít.

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
cj

Konfigurace služby CJ.

Pozn.: Pro jeden katalog je možné definovat pouze jednu affiliate službu. Tedy není možné povolit CJ a další službu.

cj

-

-

ehub

Konfigurace služby eHub.

Pozn.: Pro jeden katalog je možné definovat pouze jednu affiliate službu. Tedy není možné povolit eHub a další službu.

ehub

-

-

attemptCountLimit

Počet pokusů o odeslání objednávky.

Nad tento počet pokusů se systém již znovu nepokouší objednávky odeslat.

Hodnota má globální charakter a nelze ji specifikovat pro konkrétní katalog.

Výchozí hodnota je 5.

Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde.

Integer

-

5

avoidSending

Umožňuje vypnout odesílání objednávek, slouží pro testovací a development prostředí.

Pozn.: Zpracované objednávky přejdou do stavu AffiliateStatus#AVOIDED.

Výchozí hodnota je false, tedy objednávky se odesílají.

boolean

-

false

catalogSpecific

Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.

-

-

cj

Konfigurace služby CJ.

Pozn.: Pro jeden katalog je možné definovat pouze jednu affiliate službu. Tedy není možné povolit CJ a další službu.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
cid

Identifikátor účtu v CJ, dodá klient.

Povinná hodnota.

String

-

-

type

ID akce asociované s určitým typem konverze, dodá klient.

Povinná hodnota.

String

-

-

apiUrl

URL api, kam se odesílají objednávky.

Výchozí hodnota je "https://www.kdukvh.com/u".

String

-

https://www.kdukvh.com/u

includeUsedCreditInDiscount

Nastavuje jestli se v rámci údaje DISCOUNT má do CJ odeslat i hodnota použitého kreditu.

boolean

-

false

ehub

Konfigurace služby eHub.

Pozn.: Pro jeden katalog je možné definovat pouze jednu affiliate službu. Tedy není možné povolit eHub a další službu.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
campaignId

Identifikátor kampaně v eHub, dodá klient.

Povinná hodnota.

String

-

-

apiUrl

URL webservisu kam se odesílají objednávky.

Výchozí hodnota je "https://ehub.cz/system/scripts/sale.php".

String

-

https://ehub.cz/system/scripts/sale.php

debugMode

Zapnutí debug mode, při kterém proti-strana vrací objekt s informacemi o výsledku zpracování a popis případné chyby.

Výchozí hodnota je 'false'.

boolean

-

false

defaultProductCategoryCode

Výchozí typ produktu pro eHub po produkty bez explicitního přiřazeného typu.

Výchozí hodnota je "def".

String

-

def

productCategories/category

Seznam kódů možných kategorií produktu pro eHub. Z tohoto seznamu je pak možné v administraci entit zvolit odpovídající kategorii. V AR se zobrazuje kód, které je ale možné lokalizovat pod klíčem affiliate.ehub.category.[kod_kategorie], tedy např. 'affiliate.ehub.category.CATEGORYA'.

Pokud entita nemá přiřazenou žádnou z těch kategorií, použije se hodnota z defaultProductCategoryCode.

V případě, že

List: String

-

-

sendOrderItems

Zapnutí odesílání rozkladu položek objednávky místo sum za jednotlivé kategorie produktů eHubu.

boolean

-

false

validity

Doba platnosti trackovacího kódu.

Výchozí hodnota je "14d".

TimeInterval

-

14d

zeroPricePayment

Hodnota ceny, která se v objednávce vyplní do platební metody, pokud je objednávka zdarma.

Výchozí hodnota je "zdarma".

String

-

zdarma

Juan

Konfigurace jednotlivých affiliate programů způsobí změnu v juanConfig.

Ukázka části konfigurace pro affiliate program:

json
{  "shop": {    "affiliate": {      "parameters": {        "cjevent": {},        "ehub": {        }      }    }  }}