Propojení webu s aplikací Boldem

Michal Krejčí

30. května 2022

Aby se vám do aplikace Boldem správně načítaly údaje z vašeho webu (e-shopu či jiného systému), je zapotřebí si web přidat v části Nastavení/weby a na stránky svého webu vložit speciální kód.

Pokud váš web provozujete na platformě Shoptet nebo Upgates, použijte k propojení níže uvedené postupy:

Funkce sledování aktivity na webu je součástí tarifu Profi. Pokud využíváte základní tarif Standard a přejete si využívat sledování aktivity na webu, kontaktujte našeho obchodního zástupce.

Jak propojit web s účtem Boldem

Abyste mohli sledovat aktivitu vašich příjemců na webu v účtu Boldem, zobrazovat na vašem webu sběrné formuláře, případně do účtu Boldem přenášet další data, je zapotřebí provést propojení s Boldem.

Přihlaste se do aplikace Boldem.
V levé nabídce vyberte Nastavení a klikněte na položku Weby.
V pravé části dialogu klikněte na Přidat web.

Přidání webu do nastavení v aplikaci Boldem.

Zadejte adresu URL domény vašeho webu a klikněte na tlačítko Vytvořit web.

Důležité: Zadávejte pouze základní doménu vašeho webu, bez ohledu na to, kam nakonec sledovací kód umístíte. Pokud tedy kód umístíte např. na adrese https://www.example.com/eshop/, do pole URL webu zadejte pouze samotnou doménu https://www.example.com bez přidané cesty.

Zadání údajů při přidávání webu v aplikaci Boldem.

Zobrazí se kód, který si zkopírujte do schránky buď kliknutím na ikonu kopírování, nebo po ručním označení.

Zkopírování kódu z nastavení webu v aplikaci Boldem.

Kód vložte na svůj web do stránek, na kterých chcete sledovat aktivitu návštěvníků, nebo zobrazovat formuláře. V ideálním případě byste kód měli vložit do hlavičky stránky.

Vzor kódu a jeho umístění v hlavičce HTML stránky.

Jak přenést data z webu do Boldem

Abyste mohli sledovat aktivitu příjemců na svém webu a pracovat s dalšími daty, je zapotřebí vložit do stránek kód ve skriptovacím jazyce JavaScript. Přehled událostí a příklady volání naleznete níže.

Seznam událostí

Událost	Popis	Parametry
Boldem.identifyVisitor(email)	Spáruje e-mailovou adresu s aktuálním návštěvníkem.	email – string – povinný (e-mailová adresa aktuálního návštěvníka)

Příklad volání:

Boldem.identifyVisitor('jan.novak@boldem.cz');

Událost	Popis	Parametry
Boldem.updateCartContent(items)	Odešle informaci o obsahu košíku.	Items – CartItem[]

Vlastnosti parametru CartItem:

{
    "amount": 2, // Množství produktů v košíku.
    "name": "Product item name", // Název produktu v e-shopu.
    "url": "https://example.com/eshop/url-of-item", // Adresa URL produktu v e-shopu.
    "code": "CodeOfItem", // Jednoznačný identifikátor produktu v e-shopu.
    "productImageUrl": "https://example.com/url-of-items-image", // Adresa URL obrázku produktu v košíku.
    "price": 100.00, // Cena bez DPH za jednotku produktu v košíku.
    "priceVat": 121.00, // Cena včetně DPH za jednotku produktu v košíku.
    "currency": "CZK", // Měna ceny produktu v košíku.
    "category": "Category of item", // Kategorie produktu v e-shopu.
    "manufacturer": "Manufacturer of item", // Výrobce produktu v e-shopu.
    "variant": "Variant of item" // Varianta produktu v košíku.
    "customFields": {"customField1": "item"}, // Doplňující informace k produktu v rozsahu 1-5, customField1 - customField5, pouze textove hodnoty
}

Příklad volání:

    Boldem.updateCartContent([
    {
        "amount": 1,
        "code": "1",
        "name": "Proužky Accu-Chek Performa, 50 ks",
        "price": 226.00,
        "priceVat": 260.00,
        "currency": "CZK",
        "url": "https://www.zdravicobavi.cz/testovaci-prouzky-accu-chek-performa-p1",
        "productImageUrl": "https://www.zdravicobavi.cz/product-images/snimek1_2.jpg",
        "customFields": {"customField1": "vlastni pole polozky kosiku"},
    },
    {
        "amount": 2,
        "code": "1",
        "name": "Inzulinové jehly QFINE 6 mm, 100 ks",
        "price": 170.00,
        "priceVat": 200.00,
        "currency": "CZK",
        "url": "https://www.zdravicobavi.cz/testovaci-prouzky-accu-chek-performa-p1",
        "productImageUrl": "https://www.zdravicobavi.cz/product-images/snimek1_2.jpg"
    }], 
    {"customField1": "vlastni pole kosiku"}
);

Událost	Popis	Parametry
Boldem.orderFinished(orderId, email, params)	Odešle informaci o dokončení objednávky.	– orderId – string – povinný (jednoznačný identifikátor objednávky v e-shopu) – email – string – volitený (e-mailová adresa zákazníka) – params – object – volitelný (detailní informace o objednávce)

Příklad volání:

Boldem.orderFinished('7917');
Boldem.orderFinished('7917', 'jan.novak@boldem.cz');
Boldem.orderFinished('7917', 'jan.novak@boldem.cz', {
    'deliveryInfo': 'Osobní odběr',
    'paymentInfo': 'Hotově',
    'state': 'Nová',
    'phone': '+420775123456'
});

Událost	Popis	Parametry
Boldem.pushEvent(name, data)	Odešle informaci o vlastní události	– Name – string – povinný (název vlastní události) – Data – object – volitelný (vlastní data)

Příklad volání:

Boldem.pushEvent('FormSent',
    {
        "firstName": "Jan",
        "lastName": "Novák"
    }
);