Popis integrace s Leady API
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.
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á
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)
/>
<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í
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á, nebereme ho 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. Další kroky jsou společné pro existující i nově vytvořenou společnost.
Společnost 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 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.