Popis integrace s Leady API

Leady.cz je česká služba, která identifikuje návštěvníky vašeho webu. 

Náš konektor data automaticky synchronizuje do eWay-CRM a páruje se společnostmi a příležitostmi. Díky tomu krásně uvidíte, kteří z vašich stávajících či potenciálních klientů brouzdali vašimi stránkami, co konkrétně navštívili a jak dlouho tam strávili. 

Obchodníci díky tomu mohou snadno identifikovat skryté poptávky nebo navést diskusi s klientem tím správným směrem. 

Integrace je prováděna pomocí samostatné aplikace, která komunikuje jednak s Leady API a posléze i s eWay-CRM API. Data putují z Leady API do samostatné aplikace, zde se zpracují a dále pokračují do eWay-CRM API a nakonec do eWay-CRM databáze.

Obsah článku

• Jak to funguje?
• Údaje importované do společnosti a příležitosti
• Požadavky
• Důležité kroky před nasazením integrace
• Proces integrace
• Výstupy a případné chyby
• Propojit eWay-CRM s Leady.cz 

Jak to funguje?

Pokud máte eWay-CRM na našem cloudu, napište nám a můstek společně nastavíme. Jestliže používáte eWay-CRM na vlastních serverech, níže přikládáme návod. 

Synchronizační můstek v pravidelných intervalech (typicky každé ráno) kontaktuje Leady.cz a vyžádá si seznam návštěv za předchozích 24 hod. 

Každou návštěvu uloží do deníku a v závislosti na parametrech konfigurace vytvoří příležitost/společnost, popř. deník naváže na existující záznamy. 

Režim 1 – Vytvoř Příležitosti, pokud neexistují Společnosti

• Pokud příležitost v eWay-CRM neexistuje (hledáme podle názvu společnosti) A SOUČASNĚ neexistuje společnost, zakládáme příležitost a deník s ní provazujeme. 
• Pokud příležitost v eWay-CRM existuje (hledáme podle názvu společnosti), zakládáme deník a provazujeme s příležitostí (pokud má příležitost vyplněného odběratele, navazujeme na deník i společnost). 

Režim 2 – Vytvoř Společnosti

• Pokud společnost v eWay-CRM neexistuje (hledáme podle IČ), zakládáme ji a deník s ní provazujeme. 
• Pokud společnost v eWay-CRM existuje (hledáme podle IČ), zakládáme deník a provazujeme se společností. 

Režim 3 – Vytvořit Příležitosti bez ohledu na to, jestli Společnosti existují nebo ne 

• Pokud v eWay-CRM neexistuje příležitost A SOUČASNĚ existuje společnost, příležitost založíme. Zároveň zakládáme i deník a navážeme ho jak na příležitost, tak na společnost. 
• Pokud v eWay-CRM neexistuje příležitost A SOUČASNĚ neexistuje společnost, příležitost založíme. Zároveň zakládáme i deník a navážeme ho na příležitost. 

• Pokud v eWay-CRM existuje příležitost A SOUČASNĚ neexistuje společnost, zakládáme deník a navážeme na ho příležitost. 
• Pokud v eWay-CRM existuje příležitost i společnost, zakládáme deník a svazujeme s oběma.

Obchodníci si ráno v eWay-CRM v modulu deník najdou záznamy s typem Leady.cz, kde jsou uvedeni jako vlastníci (deníky dostávají vlastníka dle vlastníka příležitosti, resp. vlastníka společnosti). 

Pokud má deník vyplněnou nadřazenou položku, jedná se o záznam k potenciálnímu klientovi. 

Pokud deník nemá vyplněnou nadřazenou položku, jedná se o záznam k existujícímu klientovi. 

V poznámce deníku je možné zjistit seznam stránek, kterými návštěvník brouzdal. Kliknutím na název nadřazené položky, popř. společnosti lze otevřít klienta a pustit se do práce! 

Pozn.: K revizi deníků doporučujeme použít eWay-CRM Online a Panel náhledu. Šipkami nahoru a dolů návštěvy projdete rychleji!

Údaje importované do společnosti a příležitosti

eWay-CRM si z Leady bere následující data (pokud je nalezne):

Údaj z Leady	Pole na společnosti	Pole na příležitosti
Název společnosti	Název	Název
Adresa	Adresní pole	Adresní pole
Telefonní číslo	Telefon	Kontaktní telefon
Další telefonní čísla	Poznámka	Poznámka
E-mail	E-mail	Kontaktní e-mail
Odvětví	Obor	Poznámka
Webová adresa	WWW	Poznámka
Kontaktní osoby	Poznámka	Poznámka
Právní forma	Poznámka	Poznámka
Obrat	Poznámka	Poznámka
Počet zaměstnanců	Poznámka	Poznámka
Odkaz na Merk	Poznámka	Poznámka

Například společnost pak vypadá obdobně:

A příležitost takto:

Požadavky

Pro fungování u klienta by mělo jeho prostředí splňovat stejné požadavky jako pro fungování serverové eWay-CRM. Aplikace vyžaduje Microsoft .NET Framework 4.5.2 nebo vyšší.

Důležité kroky před nasazením integrace

Pro nasazení integrace je potřeba kontaktovat technickou podporu eWay-CRM.

Aplikace podporuje tyto konfigurační hodnoty v LeadyConnector.exe.config:

<leadyConnection
    url="https://api.leady.com/v1"     - Adresa zůstává stejná
    domains="eway-crm.com,eway-crm.cz" - Čárkou oddělené sledované domény
    userName=""                        - Uživatelské jméno pro Leady.cz   
    password=""                        - Heslo pro Leady.cz
    spentSecondsThreshold=""           - Minimální počet sekund ztrávených na stránce, aby se záznam evidoval
    periodStart=""                     - Od kdy se budou počítat záznamy při prvním spuštění (formát YYYY-MM-DD)
    createCompanies=""                 - Chci vytvářet společnosti (1 = ano; 0 = ne)
    createLeadsWhenCompanyExists=""    - Chci vytvářet příležitosti, jen když společnost existuje (1 = ano; 0 = ne)
    savedFilterId=""                   - ID filtru v leady.cz, umožňuje nastavit si vlastní podmínky určující, které záznamy
                                       - se budou synchronizovat. Funguje pouze s jednou sledovanou doménou. Parametr spentSecondsThreshold
                                       - je v tomto případě ignorován, je potřeba si nastavit ručně ve filtru.
                                       - Vice informací o filtrech: https://podpora.imper.cz/leady/jak-leady-pouzivat/filtrace/
    />
<eWayCRMConnection
    url=""                          - URL adresa webové služby
    userName=""                     - Uživatelské jméno API uživatele v eWay-CRM
    password=""                     - Zašifrované heslo uživatele. Pro zašifrování hesla využijte aplikaci HashPassword,
                                    - která je ve složce bin webové služby.
    journalType=""                  - GUID typu deníku návštěvy
    groupLeady=""                   - GUID kategorie "Leady"
    countryEnumType=""              - GUID seznamu typu "Země" ("Country")
    leadyIdField=""                 - Název uživatelského pole LeadyIdField, v eWay-CRM se používá pole s databázovým názvem LeadyComId
    leadyRegNoField=""              - Název uživatelského pole pro IČO firmy, které se uloží do deníku
    />

Proces integrace

Aplikace se nasazuje do složky .\bin\LeadyConnector. Dále se do složky Triggers přidává definice pro spouštění.

1) Aktivace

Aktivuje se skrze klasický XML trigger v hodinových intervalech od času 00:40. Tyto hodnoty mohou být změněny podle potřeby klienta.

2) Kontrola prvního spuštění

Po spuštění aplikace zahájí kontrolu prvního spuštění. Kontrola se provádí na základě souboru FirstRunCheck.txt umístěného ve stejném místě jako aplikace. Pokud je soubor prázdný nebo neexistuje, znamená to, že je toto první spuštění aplikace. V případě, že aplikace již někdy běžela, je v souboru zapsáno Yes. Díky tomu se dá první spuštění nastavit ručně - stačí soubor smazat. Kontrola slouží k tomu, aby při prvním spuštění bylo možné načíst data z historie delší, než je náš interval. Od jakého data chceme při prvním spuštění načíst, lze nastavit v LeadyConnector.exe.config.

Po každém dalším spuštění už je interval nastaven na 24 hodin zpět od aktuálního času.

3) Načtení návštěv

Po kontrole prvního spuštění aplikace zkontaktuje Leady API za účelem získání požadovaných dat. Komunikace s API probíhá v podobě požadavku ve formě URL adresy. Základ zůstává stejný (https://api.leady.com/v1/) a za něj se skládají různé funkce, které API umí - v našem případě vypsat aktivitu na stránkách.

Ilustrační obrázek ukazuje data jedné návštěvy:

 

4) Načtení společností / příležitostí

Obdobným způsobem se pak aplikace dotáže eWay-CRM API na seznam všech společností. Fungování eWay-CRM API zde: https://github.com/rstefko/eway-crm-php-lib .

5) Párování společností

Nyní aplikace projde seznam návštěv (v LeadyConnector.exe.config lze nastavit, jak dlouhé návštěvy mají být sledovány). Klíčový je záznam regno, pokud ho záznam nemá, nebere se v potaz. Pokud ano, zkontroluje se, jestli již existuje společnost s odpovídajícím identifikačním číslem (IdentificationNumber). Pokud se najde více než jedna odpovídající společnost, pracuje se s tou, která byla vytvořena jako první.

Aplikace je schopna párovat i záznamy, kde se regno a IdentificationNumber liší jen tím, že je zde na začátku nula (například 1 = 01).

6) Vytváření záznamů

Pokud společnost, kde se regno rovná IdentificationNumber existuje, nová se nezakládá. Pokud neexistuje, založí se nová s údaji získanými z Leady API.

Společnost / příležitost se prováže s kategorií Leady vazbou GROUP.

Dále se vytvoří deník s předmětem Návštěva, vazbou na danou společnost či příležitost a detailem návštěvy, jmenovitě začátek a konec návštěvy, počet navštívených stránek, z jaké stránky přišla a další podrobnosti.

 

Takto se naloží s každým záznamem získaným z Leady API.

Výstup a případné chyby

Ve složce Log webové služby je soubor LeadyConnector.txt. V něm najdeme zapsané Start a End pro každý běh aplikace. Pokud chybí pro čas spuštění aplikace Start, žádná z funkcí aplikace nejspíš neproběhla. Chybí-li End, aplikace se zastavil někde uprostřed běhu, nebo stále běží.

Dále zde naleznete výjimky, které nastaly v běhu aplikace.

Propojit eWay-CRM s Leady.cz 

Máte už Leady.cz nasazené na webu? Propojte je s eWay-CRM ještě dnes!

Napište nám.