Wdrożenie modułu płatności eservice dla systemu Zen Cart 1.3.9 1.5 - dokumentacja techniczna Wer. 01 Warszawa, styczeń 2014 1
Spis treści: 1 Wstęp... 3 1.1 Przeznaczenie dokumentu... 3 1.2 Przygotowanie do integracji... 3 2 Instalacja modułu Zen Cart... 3 2.1 Zawartość archiwum... 3 2.2 Przygotowanie bazy danych... 3 2.3 Ustalenie początkowego numeru zamówienia eservice... 5 2.4 Instalacja plików źródłowych... 5 2.5 Konfiguracja modułu płatności... 5 2.6 Przetwarzanie zamówień... 8 3 Kontakt... 9 2
1 Wstęp 1.1 Przeznaczenie dokumentu Niniejszy dokument opisuje czynności niezbędne do uruchomienia płatności eservice z wykorzystaniem modułu dla systemu Zen Cart w wersji 1.3.9 1.5. Przed przystąpieniem do wdrożenia zalecamy zapoznać się z ogólną dokumentacją techniczną integracji systemów płatności eservice. 1.2 Przygotowanie do integracji Przed rozpoczęcie procesu implementacji modułu w systemie sklepu, należy sprawdzić wersję wykorzystywanego systemu Zen Cart oraz pobrać najnowszą wersję modułu płatności eservice dla tejże wersji. Moduły dostępne są na stronie http://eserviceonline.pl 2 Instalacja modułu Zen Cart 2.1 Zawartość archiwum W pobranym archiwum ZIP znajdują się dwa katalogi: catalog database Katalog database zawiera krótki skrypt SQL, który należy wykonać za pomocą klienta bazy danych MySQL przed zainstalowaniem plików źródłowych modułu. 2.2 Przygotowanie bazy danych Plik eservice.sql należy skopiować na serwer, na którym zainstalowano klienta mysql bazy danych. 3
W linii poleceń wpisujemy: mysql h host u username p gdzie: host jest numerem IP komputera lub nazwa serwera, na którym zainstalowano serwer bazy danych. username jest nazwą użytkownika bazy danych mającego uprawnienia do tworzenia tabel w bazie danych Zen Cart. Po podaniu poprawnego hasła należy wpisać: mysql> use database; gdzie database jest nazwą bazy danych, z której korzysta sklep Zen Cart. Następnie wykonujemy polecenie mysql> source eservice.sql Na ekranie powinna pojawić się informacja o poprawnym utworzeniu nowej tabeli. Skrypt można wykonać za pomocą innego klienta bazy danych MySQL (np. phpmyadmin). W celu wykonania modyfikacji bazy danych za pomocą narzędzia phpmyadmin, należy zalogować się do serwera bazy danych oraz wybrać właściwą bazę danych, związaną z instalacją systemu Zen Cart. Następnie w menu wybieramy zakładkę SQL. W polu tekstowym wklejamy kod SQL o zawartości przedstawionej na Listingu 1. Listing 1: Kod SQL dodający tabelę niezbędną do przetwarzania płatności internetowych CREATE TABLE IF NOT EXISTS eservice ( eservice_orderid INT(11) NOT NULL auto_increment, osc_orderid INT(11) NULL, payment_status VARCHAR(48) NOT NULL DEFAULT '', payment_prevstatus VARCHAR(48) NOT NULL DEFAULT '', crdate datetime NOT NULL, moddate datetime NOT NULL, type int(4) NOT NULL DEFAULT 0, bin varchar(7) NOT NULL DEFAULT '', PRIMARY KEY(eservice_orderID) ); Po wykonaniu polecenia w bazie pojawi się pusta tabela o nazwie eservice. 4
2.3 Ustalenie początkowego numeru zamówienia eservice Jeżeli merchantid był wykorzystywany do przeprowadzania transakcji w systemie eservice, może zajść konieczność ustalenia początkowego numeru zamówienia w sklepie. W tym celu należy wykonać polecenie SQL: ALTER TABLE `eservice` AUTO_INCREMENT = 123; gdzie 123 będzie początkowym numerem zamówienia w tej instalacji sklepu Zen Cart. Uwaga: Wykonując testy systemu w środowisku testowym płatności może zajść konieczność zmiany początkowego numeru zamówienia. Jest to związane w koniecznym warunkiem unikalności pary MerchantID oraz OrderID dla Akceptanta. (Patrz: ogólna dokumentacja techniczna systemu płatności.) 2.4 Instalacja plików źródłowych Pliki źródłowe modułu płatności eservice umieszczone są w katalogu catalog. Zawartość tego katalogu należy skopiować na serwer do katalogu instalacyjnego sklepu Zen Cart. Jeżeli katalog zawierający tłumaczenia językowe /includes/languages/polish ma inną nazwę lub jeżeli katalog /admin/ został przeniesiony w inne miejsce to zawartość archiwum zawierającego moduł eservice należy skopiować do odpowiedniego katalogu na serwerze. Po poprawnym skopiowaniu plików można przystąpić do konfigurowania modułu płatności. 2.5 Konfiguracja modułu płatności W celu skonfigurowania modułu płatności należy przejść do panelu administracyjnego sklepu. W menu z panelu administracyjnego wybieramy sekcje Moduły, a następnie Płatność. Wybieramy pozycje o nazwie eservice - karta Visa, MasterCard, mtransfer, Place z Interligo,MultiTransfer, Przelewy bankowe. (Rysunek 1). 5
Rysunek 1: Instalacja modułu płatności eservice Klikamy na przycisk zainstaluj. Po prawej stronie ekranu pokaże się lista przedstawiona na rysunku (Rysunek 2). W celu dostosowania parametrów modułu płatności klikamy na przycisk edytuj. Na ekranie pokaże się formularz. Znaczenie pól formularza opisano poniżej. Włączyć płatności eservice? Zaznaczenie opcji True umożliwi dokonywanie płatności za pomocą tego modułu. Opcja False wyłącza możliwość dokonywania transakcji przez eservice. Ustaw status zamówienia Określa, jaki status zamówienia będzie ustawiony po dokonaniu płatności. Położenie w liście możliwych płatności Jeżeli sklep umożliwia kilka rodzajów płatności (np. dodatkowo jest włączona płatność przy odbiorze), pole to jest wykorzystywane do określenia pozycji w liście możliwych płatności prezentowanych klientom sklepu. Identyfikator Merchanta W polu tym należy wprowadzić identyfikator Akceptanta otrzymany z eservice. 6
Hasło dla merchanta W polu tym należy wprowadzić hasło właściwe dla Akceptanta określonego w polu Merchant ID. Język interfejsu płatności Określa domyślny język interfejsu płatności eservice jaki zostanie zaprezentowany klientowi sklepu. Automatyczne ustawianie języka Zaznaczenie opcji True, spowoduje próbę ustawienia języka interfejsu płatności takiego samego, jaki został wybrany przez klienta w sklepie Zen Cart. Jeżeli język ten nie jest jednym z umieszczonych w liście Język interfejsu płatności, moduł transakcyjny będzie prezentowany w domyślnym języku interfejsu płatności. Zaznaczenie opcji False spowoduje, że część transakcyjna interfejsu płatności eservice będzie prezentowana w domyślnym języku ustawionym w polu Język interfejsu płatności. UWAGA: Waluty w sklepie Zen Cart są definiowane niezależnie od modułów płatności. W sklepie musi być zdefiniowana waluta PLN. Niezdefiniowanie tej waluty spowoduje nieokreślone zachowanie się systemu. 7
Rysunek 2: Domyślne parametry modułu płatności eservice 2.6 Przetwarzanie zamówień Jeżeli płatność za towar sprzedawany w sklepie nastąpi za pomocą modułu płatności eservice, w module obsługi zamówień sklepu (Klienci >> Zamówienia), na karcie szczegółowego podglądu zamówienia pojawi się informacja pokazana na rysunku (Rysunek 3) Rysunek 3: Informacja o płatności w module obsługi zamówień sklepu Poszczególne pola w tabeli oznaczają: ID płatności eservice identyfikator płatności przekazywany do eservice; Poprzedni status płatności oraz Status płatności szczegółowe informacje o statusach płatności; Data utworzenia data rozpoczęcia transakcji; 8
Data modyfikacji data modyfikacji danych przedstawionych w tabeli. Dane w tabeli aktualizowane są za pomocą powiadomień POST. Status eservice może przyjmować poniższe wartości: Approved transakcja udana, można wysłać towar do klienta Pending transakcja oczekuje na potwierdzenie z banku, nie można wysłać towaru Declined transakcja nieudana, nie można wysłać towaru 3 Kontakt W razie jakichkolwiek pytań podczas wdrożenia prosimy o kontakt z Zespołem Wdrożeniowym eservice: tel.: +48 22 533 22 44 email: Wdrożenia_eCommerce@eservice.com.pl Problemy powdrożeniowe występujące na środowisku produkcyjnym prosimy zgłaszać na skrzynkę pocztową Wsparcie_eCommerce@eservice.com.pl 9