Programátorský manuál k implementaci online splátkového prodeje
Implementační manuál aplikace Essox Lite pro programátora/webmastera e-shopu
Obchodní a technická podpora ESSOX: Marek Ťoupalík, tel: 724366204, e-mail:
[email protected]
Obsah Úvod ........................................................................................................................................................ 2 Implementace .......................................................................................................................................... 3 Dokončení a otestování služby ............................................................................................................... 7 Náhledy obrazovek .................................................................................................................................. 8 Troubleshooting ....................................................................................................................................... 9
-1-
Programátorský manuál k implementaci online splátkového prodeje
Úvod Systémové požadavky Vývojová platforma e-shopu Aplikaci Essox Lite lze nasadit na většinu v současnosti používaných vývojových platforem e-shopů jako jsou PHP, ASP, ASP.net, Java. Pokud provozujete svůj e-shop na některé z méně rozšířených vývojových platforem, tak kontaktujte naši technickou podporu. OpenSource e-shopy Vzhledem k charakteru OpenSource eshopových řešení (ZenCart, CubeCart, osCommerce, apod.) lze předpokládat, že si takový e-shop uvádí do provozu „průměrně“ zdatný uživatel (nebo méně zkušený programátor). V takovém případě bude možnost implementace přímo úměrná schopnostem a znalostem webmastra e-shopu. Pro konzultace lze využít naši technickou podporu na výše uvedeném kontaktu.
Slovník pojmů Essox s.r.o. – společnost poskytující financování zboží a služeb prostřednictvím spotřebitelského úvěru Klient – zákazník objednávající zboží na eshopu partnera a žadatel o spotřebitelský úvěr prostřednictvím aplikace Essox Lite Partner – provozovatel e-shopu E-shop – internetová aplikace, prostřednictvím které klient realizuje nákup zboží Aplikace Essox Lite – internetová aplikace běžící na zabezpečeném serveru společnosti Essox s.r.o., a prostřednictvím které společnost Essox s.r.o. přijímá žádosti klientů o spotřebitelský úvěr Kalkulačka splátek – jednoduchá internetová aplikace umožňující okamžité zkušební nastavení parametrů úvěru a výpočet měsíční splátky Číslo obchodního místa (OM) – jedinečná identifikace partnera a jeho obchodního místa v obchodní síti Essoxu. Toto číslo přiděluje Essox při vzniku daného obchodního místa. Implementační balíček – komprimovaný datový soubor obsahující všechny nezbytné údaje, texty, grafiku a manuály k instalaci celého řešení na e-shop Implementační protokol – dokument obsahující klíčové informace o nastavení obchodního místa (url adresy aplikace, loginy, atd.), nacházází se v Implementačním balíčku (!Implemetacni_protokol.xls)
-2-
Programátorský manuál k implementaci online splátkového prodeje
Implementace Klíčové body implementace do e-Shopu 1) 2) 3) 4) 5) 6)
Vytvoření platebního modulu Kalkulačka splátek Nastavení nové platební metody v košíku e-shopu Přesměrování na aplikaci Essox Lite Umístění statické stránky „Podmínky nákupu na splátky“ Umístění marketingových objektů (logo, banner, upoutávka) Dokončení a otestováíní služby pracovníkem Essoxu
1) Vytvoření platebního modulu V případě, že se rozhodnete platební metodu Essoxu připravit jako nový platební modul, který by si nyní nebo v budoucnu mohl aktivovat kterýkoli váš klient (e-shop), tak jsme připravili náhled takové konfigurační stránky. Na této stránce v rámci nastavení pokladny eshopu budou informace o platební metodě Essoxu a možnosti spolupráce. Dále by po vyřízení obchodních formalit obsahovala vstupní pole pro zadání identifikačníéch údajů klienta. Po potvrzení tohoto nastavení by služba byla automaticky fukční.
Informační text o Essoxu v nastavení pokladny: Společnost Essox s.r.o. www.essox.cz Vám nabízí spolupráci při prodeji zboží a služeb prostřednictvím online spotřebitelského úvěru (tzv. „na splátky“). Tato platební metoda je vzhledem k velké popularitě mezi nakupujícími velmi efektivní nástroj pro internetové obchody. Pro aktivaci platební metody „Nákup na splátky Essox“ musíte udělat několik jednoduchých kroků: - pokud nemáte podepsanou smlouvu o spolupráci se společností Essox s.r.o., tak napište
[email protected] a zástupce Essoxu Vás bude kontaktovat - pokud již máte podepsanou smlouvu o spolupráci, tak kontaktujte Essox na emailu
[email protected] pro získání přístupů - pokud již máte přístupové údaje, tak je zadejte do políček níže a uložte nastavení Po vyplnění přístupových údajů, uložte nastavení tlačítkem „Uložit“. Uložením nastavení bude platební metoda Essox aktivní a připravena k použití. Až tak učiníte, kontaktujte svého zástupce.
-3-
Programátorský manuál k implementaci online splátkového prodeje
2) Kalkulačka splátek Kalkulačka splátek slouží k orientačním výpočtům měsíční splátky v průběhu nákupu klienta. Kalkulačku lze zobrazit jak v samostatném okně, tak v iframe jako součást eshopu. Kalkulačka může být zobrazena jak s možností ručního vyplnění vstupní ceny zboží, tak i s předem definovanou cenou. Kalkulačku doporučujeme nabídnout klientovi hlavně u detailu zboží a dále v košíku s celkovou cenou nákupu, když klient zvolí platební metodu nákup na splátky Essox. V obou případech je nutné aplikovat podmínku pro zobrazení kalkulačky... cena >= 3000 Kalkulačku splátek můžeme volat pomocí javascriptového příkazu window.open kde: {essoxURL} - je url adresa aplikace Essox Lite {OM} - je číslo obchodního místa (přiděluje Essox) Výše uvedené proměnné se definují předem na základě implementačního protokolu. {price} - je cena, kterou můžete předem vložit do pole Prodejní cena v kalkulačce splátek (pokud nechceme předvyplnit cenu, tak položku {Price} nepředáváme) Pokud chceme volat kalkulačku s možností ručního zadání celkové ceny zboží… {essoxURL}/calculator.aspx?id={OM} Pokud chceme volat kalkulačku s předem definovanou cenou zboží… {essoxURL}/calculator.aspx?id={OM}&p={price} Doporučené parametry pro zobrazení kalkulačky v samostatném okně: _blank - otevřít v samostatném okně toolbar=0 - nezobrazovat panel nástrojů v otevřeném okně resizable=1 - možnost měnit velikost okna status=1 - zobrazení stavové řádky width=650 - šířka okna height=430 - výška okna Příklad příkazu pro zavolání kalkulačky splátek v samostatném okně s předem definovanou prodejní cenou zboží: window.open('{essoxURL}/calculator.aspx?id={OM}&p={price}', '_blank', 'toolbar=0, resizable=1, status=1, width=650, height=430') Princip složení odkazu je jednoduchý a lze ho řešit i jinými způsoby v závislosti na použité platformě. Vzhled kalkulačky naleznete v sekci náhledy, obrázek 1
-4-
Programátorský manuál k implementaci online splátkového prodeje
3) Nastavení nové platební metody v košíku e-shopu Za účelem spuštění aplikace Essox Lite vytvoříme do košíku novou platební metodu nazvanou „Nákup na splátky Essox“. Tato platební metoda bude předpokládat běžné ukončení objednávky, ale s následným spuštěním funkce getEssoxLiteUrl popsané níže. Tato funkce má za úkol vygenerovat odkaz se zašifrovanými identifikátory partnera, a který klienta přesměruje na aplikaci Essox Lite.
4) Přesměrování na aplikaci Essox Lite Přesměrování na aplikaci Essox Lite se provede pomocí odkazu obsahujícího zašifrované identifikační údaje partnera. Tento odkaz se vygeneruje pomocí níže popsané funkce. Přesměrování se nejčastěji nastavuje automaticky po dokončení objednávky nebo je klientovi zobrazena průvodní informace o následném přesměrování na aplikaci Essox Lite (žádost o úvěr). Vždy jde hlavně o to, aby klient netápal v nelogických krocích a vždy věděl co následuje a proč. Přesměrování lze ale řešit i textovým odkazem, případně logem či obrázkem, který se zobrazí po dokončení objednávky. Klient je vyzván ke kliknutí na tento odkazový objekt a následně přesměrován. Finální podoba tohoto přesměrování je spíše věcí e-shopu, přičemž jedinou podmínkou je docílit, aby klient bez komplikací a složitostí přešel na aplikaci Essox Lite a vyplnil žádost o úvěr. Parametry pro zpracování funkce getEssoxLiteUrl Ve všech platformách jsou použity stejné parametry: essoxURL (string) userName (string) code (string) price (int)
- url adresa aplikace Essox Lite - uživatelské jméno - přístupový kód - celková suma objednávky, celé číslo (včetně DPH a poplatků)
PHP function getEssoxLiteUrl($essoxUrl, $userName, $code, $price) { $seed = time().rand(); $hash = sha1($userName.'#'.$code.'#'.$price.'#'.$seed); return $essoxUrl.'/Login.aspx?a='.$userName.'&b='.$price.'&c='.$seed.'&d='.$hash; }
ASP Nutno vložit skript s algoritmem SHA1, který je součástí implementačního balíčku. <<sha1.inc>> <%@ language="javascript" %> function getEssoxLiteUrl(essoxUrl, userName, code, price) { var seed = Math.random(); var hash = calcSHA1(userName + "#" + code + "#" + price + "#" + seed); return essoxUrl + "/Login.aspx?a=" + userName + "&b=" + price + "&c=" + seed + "&d=" + hash; }
C# using System; using System.Security.Cryptography; using System.Text; private static string GetEssoxLiteUrl(string essoxUrl, string userName, string code, string price)
-5-
Programátorský manuál k implementaci online splátkového prodeje
{ Guid seed = Guid.NewGuid(); byte[] hash = new SHA1CryptoServiceProvider().ComputeHash(Encoding.ASCII.GetBytes(userName + "#" + code + "#" + price + "#" + seed)); StringBuilder stringBuilder = new StringBuilder(); for (int i = 0; i < hash.Length; i++) stringBuilder.Append(hash[i].ToString("x2")); return String.Format("{0}/Login.aspx?a={1}&b={2}&c={3}&d={4}", essoxUrl, userName, price, seed, stringBuilder); } Python import random import hashlib def GetEssoxLiteUrl(essoxUrl, userName, code, price): seed = str(random.random()) hash = hashlib.sha1(userName + "#" + code + "#" + price + "#" + seed); return essoxUrl + "/Login.aspx?a=" + userName + "&b=" + price + "&c=" + seed + "&d=" + hash.hexdigest() Java import java.util.*; import java.security.*; import java.math.*; public static String getEssoxLiteUrl(String essoxUrl, String userName, String code, String price) throws NoSuchAlgorithmException { String seed = Integer.toString(new Random().nextInt()); String plainText = userName + "#" + code + "#" + price + "#" + seed; MessageDigest digest = MessageDigest.getInstance("SHA1"); digest.update(plainText.getBytes(), 0, plainText.length()); String hash = new BigInteger(1, digest.digest()).toString(16); return essoxUrl + "/Login.aspx?a=" + userName + "&b=" + price + "&c=" + seed + "&d=" + hash; } V případě že máte eshop postavený na jiné platformě, kontaktujte naši technickou podporu.
5) Umístění statické stránky „Podmínky nákupu na splátky“ Pro splnění smluvních podmínek společnosti Essox s.r.o. je nutné umístit informace o nákupu na splátky na daném e-shopu. Znění těchto podmínek je specifikováno předem a uloženo v implementačním balíčku ve složce „Texty_na_web“. Odkaz na tento text je možné umístit přímo do lišty na hlavní stránce pod názvem např. „Nákup na splátky“, Splátkový prodej“, apod. nebo ho umístit do skupiny informací popisujících podmínky nákupu na e-shopu. Vždy ale mějte na paměti, že tyto informace by měly být pro klienta snadno dostupné.
6) Umístění marketingových objektů (logo, banner, upoutávka) Jednou z nejdůležitějších součástí implementace (z obchodního pohledu) je marketingová komunikace s klientem. Vzhledem k designu či charakteru e-shopu by mělo být klientovi vhodnou formou sděleno, že na tomto e-shopu může nakupovat na splátky. Ve složce „Grafika_na_web“ v implementačním balíčku naleznete dostupná loga, grafiku, bannery apod., které lze využít na propagaci splátkového prodeje. V případě, že si nebudete jisti správným umístěním nebo volbou grafiky, konzultujte to prosím s námi.
-6-
Programátorský manuál k implementaci online splátkového prodeje
Dokončení a otestování služby Po provedení všech úkonů v předchozích krocích lze ověřit, zda vygenerované odkazy spouští kalkulačku splátek i aplikaci Essox Lite. Za tímto účelem použijte testovací přihlašovací údaje, které najdete v implementačním protokolu. Tyto údaje slouží pouze pro vyzkoušení funkčnosti odkazů na splátkovou kalkulačku a aplikaci Essox Lite bežící na testovacím serveru. Testovací i ostré přihlašovací údaje naleznete v souboru !Implementacni_protokol.xls Finální otestování služby na ostrých přihlašovacích údajích může provádět pouze zástupce Essoxu. Po otestování mohou být ještě požadovány některé drobné úpravy. Testování a oficiální spuštění za Essox s.r.o. provádí: Marek Ťoupalík
[email protected] tel: 724366204
-7-
Programátorský manuál k implementaci online splátkového prodeje
Náhledy obrazovek Obrázek 1 - Kalkulačka splátek
Obrázek 2 – Úvodní strana aplikace Essox Lite
-8-
Programátorský manuál k implementaci online splátkového prodeje
Troubleshooting
-9-