Platební modul GP webpay pro VirtueMart 2 a 3
Návod k instalaci

#Ver:PRV098-49-ga9cb64a5:2022-11-14#

Podmínky užívání


Nabízená rozšíření jsou společností Global Payments Europe, s.r.o. („GPE“) poskytována zdarma a výslovně nejsou součástí nabídky výrobků a služeb společnosti GPE.

Rozšíření byla testována a schválena pro plnou funkčnost při standardní konfiguraci (stav při dodání, “jak stojí a leží ”) odpovídajícího systému eshopu.

Omezení odpovědnosti:
SPOLEČNOST GPE NENESE ZA ŽÁDNÝCH OKOLNOSTÍ JAKOUKOLI ODPOVĚDNOST ZA JAKÉKOLI NÁROKY Z NEPŘÍMÝCH, NÁSLEDNÝCH, VEDLEJŠÍCH, ZVLÁŠTNÍCH, EXEMPLÁRNÍCH ČI SANKČNÍCH ŠKOD NEBO JEJICH NÁHRAD JAKÉKOLI POVAHY, MIMO JINÉ VČETNĚ: UŠLÝCH ZISKŮ, ZTRÁTY HODNOTY DOBRÉ POVĚSTI, UŠLÝCH UŽITKŮ, ZTRÁTY DAT, UŠLÝCH BUDOUCÍCH OBCHODŮ ČI UŠLÉ VÝROBY, NÁROKŮ TŘETÍCH SUBJEKTŮ, ZRUŠENÍ SMLUV VÁMI UZAVŘENÝCH NEBO JINÉ NEHMOTNÉ ÚJMY.

Společnost GPE nemůže poskytnout a neposkytuje jakoukoli záruku či garanci, kterou by se zajišťovalo, že váš software, vaše systémy nebo vaše výrobky nebudou napadnutelné nebo náchylné z hlediska možného zneužití, neoprávněného vniknutí či zásahu a/nebo případného narušení.

Vy, nikoli společnost GPE, nesete výlučnou odpovědnost za zabezpečení svého softwaru, svých systémů a svých výrobků i veškerou odpovědnost za návrh, výrobu, zkoušení, nabízení, prodej a bezpečnost svého softwaru, svých systémů a svých výrobků.

Společnost GPE neposkytuje jakoukoli záruku ani nepřijímá jakoukoli odpovědnost za jakékoli chyby vzniklé při použití v rozšířené upravené konfiguraci systému eshopu.

Provozování v rozšířené, upravené konfiguraci je na vaše vlastní riziko a vyžaduje komplexní zkušební testování ze strany uživatele rozšíření.

Zákazníci používají rozšíření na své vlastní riziko. Společnost GPE nezaručuje jejich plnou funkčnost, ani nepřebírá odpovědnost za jakékoli nevýhody související s užíváním rozšíření. Společnost GPE dále nezaručuje plnou funkčnost u upravených systémů eshopu ani u instalovaných rozšíření jiných poskytovatelů rozšíření v rámci téhož systému eshopu.

Zákazníci odpovídají za provedení testů funkčnosti rozšíření před zahájením produktivního provozu.

Instalováním rozšíření do systému eshopu vyjadřuje zákazník souhlas s těmito podmínkami užívání. Rozšíření prosím nepoužívejte, nesouhlasíte-li s těmito podmínkami užívání!

Odinstalování rozšíření může mít za následek ztrátu dat.

Právní upozornění
Na jakékoliv změny a/nebo nové implementace a ani na výsledné odlišné použití nelze poskytnout jakoukoli záruku, pokud není podporována či popsaná v této dokumentaci.

Předpoklady pro instalaci


Řešení problémů a podpora

Tato příručka obsahuje kromě popisu nastavení i postupy při řešení typických problémů s platební bránou. Pokud se v průběhu instalace objeví potíže, pročtěte pečlivě celý tento manuál. Pokud se ani tak problém nepodaří vyřešit, napište nám podrobný popis chyby a jaké kroky jste pro odstranění zkusili. Při diagnostice můžeme požadovat zaslání log souboru modulu. Přístupové údaje k eshopu zpravidla nepotřebujeme.

K modulu lze objednat službu nastavení od externího dodavatele:
Objednat instalaci a nastavení modulu

Důležitá změna při aktualizaci

Při aktualizaci modulu z původní verze starší než PRV088-35 , došlo ke změně umístění adresáře UniModul z kořenového adresáře eshopu do adresáře plugins/uniadapter/vmadapter/lib/UniModul
Při aktualizaci se řiďte prosím pokyny v sekci Aktualizace modulu.

Instalace


Generování digitálních klíčů a nastavení platební brány

GP WebPay poskytuje testovací a produkční režim. Tyto režimy jsou zcela nezávislé a mají vlastní nastavení klíče.

Pro použití GP WebPay (testovacího nebo produkčního režimu) je třeba vygenerovat digitální klíč v testovací webové administraci na https://test.portal.gpwebpay.com nebo v produkční na https://portal.gpwebpay.com v sekci správa klíčů. Následně vygenerovaný .key soubor vložit k příslušnému účtu na stejné stránce. Při instalaci modulu využijete pak tento vygenerovaný .key soubor, viz níže.

Na portálu GP WebPay zajistěte, že v nastavení pro daný eshop ve volbě "HTTP metoda pro odpověď" je nastaveno "GET".

Instalace v administraci eshopu

Nainstalujte platební pluginy

Před konfigurací je potřeba nakopírovat dodatečné soubory přes ftp.
Do adresáře plugins/uniadapter/vmadapter/lib/UniModul/certs nakopírujte .key soubor vašeho vygenerovaného privátního klíče.

V administraci VirtueMartu v menu Ovládací (Control) Panel zvolte Seznam způsobů platby (Payments Methods). V horním menu zvolte ikonu Nová položka (New). A vyplňte tato pole: Dále v horním menu zvolte ikonu Uložit (Save). A zvolte záložku Nastavení (Configuration).

Dále vyplňte následující pole: Nastaveni uložte tlačítkem Save.

Pozor: Ve VirtueMartu nepoužívejte výchozí stav "P" (Vyřizuje se) pro označení zaplacené objednávky. Tento stav VirtueMart nastavuje automaticky každé nově vytvořené objednávce, dokud jej nějaký modul nebo administrátor nezmění.

Poznámka: Pro zobrazení grafického loga u plateb překopírujte všechny .png obrázky v eshopu z adresáře plugins/uniadapter/vmadapter/lib/UniModul do adresáře /images/virtuemart/payment na eshopu. Následně je pak možné tyto obrázky zvolit v nastavení platební metody.

Nyní vyzkoušejte funkčnost modulu provedením platby v roli zákazníka. V testovacím režimu GPWebPay je třeba použít testovací kartu zaslanou spolu s podklady brány.

Vytvoření aktivačního klíče

Přechod do produkčního režimu

Po otestování platby v testovacím režimu můžete přejít na produkční provoz, kde lze již platit skutečným kartami.

Napište mail do GPE (gpwebpay@gpe.cz) s žádostí o zprovoznění produkčního prostředí, které je ve výchozím stavu zablokované. Klíč vygenerujte stejným způsobem jako v testu, případně můžete nahrát klíč z testu i do produkce. Až bude produkční provoz spuštěn, je třeba upravit nastavení modulu v administraci eshopu na produkční bránu, dle instrukcí výše.

Dílčí platební metody

Výše popsaný platební modul umožňuje platit všemi metodami poskytovanými systémem GP webpay. To je řešeno tak, že když zákazník při placení zvolí platební metodu GP webpay, je přesměrován na platební bránu, kde si nejprve vybere jednu z mnoha nabízených metod jako platba kartou, převodem, atp.

Je však také možné tyto dílčí platební metody aktivovat jako samostatné platební volby.

Dílčí platební metody mají podobu samostatný platebních modulů, které se již v administraci detailně nenastavují a přebírají veškeré nastavení základního modulu GP webpay. Tento hlavní modul musí být vždy povolený. Pokud nechcete aby se zákazníkům zobrazoval, nastavte v administraci položku "Skrýt hlavní modul "Skrýt hlavní modul a použít jen konkrétní metody" na "ano".

Instalace specializovaných modulů probíhá stejně jako základního modulu, jak je popsáno výše. Postupně je třeba nakopírovat obsah příslušného adresáře pluginu do tmp adresáře a přes extension manager nainstalovat a povolit. Následně pak modul přidat v nastavení platebních metod VirtueMartu.

Řešení problémů


Zjištění důvodu neúspěšné platby v log souboru

Technické informace o komunikaci s platební bránou jsou logovány do souboru plugins/uniadapter/vmadapter/lib/UniModul/logs/UniModul.log. V případě problémů s placením lze nalézt důvody selhání v tomto logu.

Nastavení práv pro soubory

Modul vyžaduje právo na čtení a zápis do několika souborů. Pokud standardní nastavení práv souborů neumožňuje do těchto souborů zapisovat ani v případě logu jej vytvořit, doporučujeme:
Vytvořit log soubor plugins/uniadapter/vmadapter/lib/UniModul/logs/UniModul.log ručně a nastavit mu práva pro zápis z webserveru. Používáte-li Total Commander, v příkazové řádce napište: chmod 666 UniModul.log, tím udělíte tomuto souboru maximální přístupnost. Soubory by však neměly být viditelné pro ostatní weby na daném webhostingu, proto se před spuštěním produkčního provozu ohledně nastavení práv informujte u svého webhostingu.
Dále je nutno nastavit práva pro zápis na soubor plugins/uniadapter/vmadapter/lib/UniModul/sync.lock.

Technické problémy na stranách brány GPWebPay nebo po návratu zpět do eshopu

Brána GPWebPay může odmítnout platbu jak z běžných obchodních důvodů, jako je například neověření karty zákazníka, tak i z technických důvodů problému v konfiguraci brány nebo modulu.

Při zjišťování problému s platbou se nejprve podívejte do administračním GUI GPWebPay. Prověřte tam stav plateb, pokud tam jsou evidovány jako nezaplacené, tak problém není v eshopu a obraťte GPWebPay. Pokud tam bude platba evidovaná jako zaplacená a modul ji přesto označí jako odmítnutou nebo tam platba nebude zaznamenaná vůbec, postupujte dle následujícího odstavce.

Detekce problému brány dle log souboru platebního modulu

Technický problém se projeví buď přímo na straně brány GPWebPay nebo po návratu zpět do eshopu, kdy zákazníkovi modul kromě informace o neúspěšné platbě vypíše, že šlo o technický problém V logu plugins/uniadapter/vmadapter/lib/UniModul/logs/UniModul.log naleznete na konci souboru v řádku ve tvaru:
*** Sun, 01 Feb 2014 18:48:28 +0100 REPLY Signature result=1 OK 99.99.220.216 /modules/PrestaAdapter/validation.php?uniModul=GPWebPay&unimodul=GPWebPay&OPERATION=CREATE_ORDER&ORDERNUMBER=1152&MERORDERNUM=2015090064&MD=X&PRCODE=0&SRCODE=0&RESULTTEXT=OK&DIGEST=....
Kód chyby platební brány je uveden jako PRCODE, SRCODE, a textová interpretace RESULTTEXT. Typické technické chyby, které souvisí s nastavením modulu jsou: V případě jiných chybových kódů se prosím obraťte na podporu GPWebPay. Je vhodné jim zaslat část logu s uvedeným řádkem včetně předcházejícího řádku s požadavkem na bránu obsahující text MAKING_ORDER_URL.

Detailní záznam chyb v log souboru

Pokud modul nefunguje správně a standardní logované události do plugins/uniadapter/vmadapter/lib/UniModul/logs/UniModul.log nepomohou odhalit příčinu, můžete zapnout rozšířené logování chyb do výše zmíněného log souboru. Z něj pak lze zjistit co nefunguje případně nám jej můžete zaslat pro analyzování problémů.

Záznam chyb do log souboru lze jej zapnout přidáním řádku
$GLOBALS['UniErrorControl'] = 1;
v souboru plugins/uniadapter/vmadapter/lib/UniModul/UniModulConfig.php. Tento soubor standardně není vytvořen a můžete jej nejprve okopírovat ze souboru UniModulConfig.php.example a následně upravit. Pro běžné použití doporučujeme logování chyb vypnout. Logování komunikace s platební bránou je zapnuté vždy a vypnout nelze.

Modul se nezobrazuje v nabídce plateb

Modul je v administraci nastavený, ale při objednávání se nenabízí.

Možné příčiny:

Chybí databázová tabulka unimodul_transactions

V logu při zapnutém logování chyb se objevuje chyba: Query Failed! SQL: insert into unimodul_transactions, Error: Table '.unimodul_transactions' doesn't exist
V tomto případě modul nemohl automaticky vytvořit tuto tabulku během instalace a je jí nutno vytvořit ručne:

Přihlaste se do administrace vaší databáze na web hostingu a v databázi používané Vaším eshopem vytvořte tabulky spuštěním skriptu plugins/uniadapter/vmadapter/lib/UniModul/UniModul.sql. (Stačí obsah souboru copy-pastnout do okna pro zadání SQL příkazu v PhpMyAdminu.)

Často kladené otázky


Aktualizace modulu

Při aktualizaci modulu z původní verze starší než PRV088-35 , došlo ke změně umístění adresáře UniModul z kořenového adresáře eshopu do adresáře plugins/uniadapter/vmadapter/lib/UniModul

Po instalaci upgradu z verze starší než PRV088-35 proveďte tyto kroky: Obecná pravidla pro aktualizaci:

Při aktualizaci modulu zazálohujte všechny soubory, které jste ručně měnili, obvykle se jedná o konfigurační a upravené jazykové soubory. Pak překopírujte soubory nové verze a nahraďte jimi soubory staré verze. Po té promítněte Vaše změny v zazálohovaných souborech do nových souborů modulu.

Dále prověřte, že databázové skripty odpovídají vytvořeným tabulkám. Případné změny v databázi proveďte ručně.

Nakonec v administraci ověřte nastavení modulu a doplňte případné nové položky. V některých případech může administrace hlásit při prvním spuštění chyby, ty však zmizí po prvním uložení nové konfigurace. Pokud potíže přetrvávají modul z administrace odinstalujte a po té znovu nainstalujte a nastavte.

Párování plateb

Modul automaticky páruje platby s objednávkami v eshopu a nastavuje jim příslušný stav.

Pro některé úkony, jako například ruční stornování platby v administraci platební brány, je potřeba na platební bráně dohledat transakci k dané objednávce. V administraci eshopu je číslo transakce platební brány zobrazeno v komentáři v detailu objednávky.

Někdy může být nutné dohledat k dané transakci na platební bráně příslušnou objednávku v eshopu. Číslo objednávky eshopu je na platební bránu předáno v poli Merchant order number nebo v popisu transakce, obsahuje-li písmena. Zobrazuje se v detailu transakce v administraci GPWebPay účtu a také na výpisu z banky.

Lokalizace a úprava textů

Texty a překlady modulu jsou řešeny z části standardním způsobem jako pro běžný modul, a z části specifickým způsobem, kdy jsou uloženy v souboru plugins/uniadapter/vmadapter/lib/UniModul/UniModulLang.php a plugins/uniadapter/vmadapter/lib/UniModul/UniGPWebPayLang.php. Úpravou tohoto souboru můžete změnit textace nebo přidat nový jazyk.

Přidáte-li nový jazyk do lokalizačního souboru, pošlete nám prosím upravené soubory. My je přidáme do příštích verzí, kde budou sloužit jak dalším zákazníkům, tak i Vám, pokud si budete modul v budoucnu aktualizovat.

Odinstalace

Modul nejprve odinstalujte z administrace eshopu. Dále smažte všechny nakopírované soubory, které jste při instalaci nakopírovali z instalačního adresáře ftp.