Wdrożenie modułu płatności eservice dla systemu Magento 1.4 1.9 - 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 Magento... 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 3 Przetwarzanie zamówień... 8 4 Kontakt... 8 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 Magento w wersji 1.4 1.9. 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 Magento 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 Magento 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 Magento Po podaniu poprawnego hasła należy wpisać: mysql> use database; gdzie database jest nazwą bazy danych, z której korzysta sklep Magento. 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 Magento. 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 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, 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 Magento. 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 Magento. 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 System > Konfiguracja > Sposoby płatności, a następnie moduł o nazwie Eservice. (Rysunek 1). 5
Rysunek 1: Konfiguracja modułu płatności eservice Na ekranie pokaże się formularz. Znaczenie pól formularza opisano poniżej. Włączony Zaznaczenie opcji Yes umożliwi dokonywanie płatności za pomocą tego modułu. Opcja No wyłącza możliwość dokonywania transakcji przez eservice. Tytuł Nazwa płatności jaka pojawi się dla klienta. Merchant ID W polu tym należy wprowadzić identyfikator Akceptanta otrzymany z eservice. Hasło dla merchanta W polu tym należy wprowadzić hasło właściwe dla Akceptanta określonego w polu Merchant ID. StoreKey W polu tym należy wprowadzić wartość parametru StoreKey otrzymany od eservice. 6
Połącz z Moduł płatności umożliwia zarówno łączenie ze środowiskiem testowym płatności jak i z systemem produkcyjnym umożliwiającym dokonywanie realnych płatności. W celach testowych należy wybrać opcję Środowisko testowe. Po przyznaniu własnego, unikalnego numeru MerchantID należy wybrać opcję Środowisko produkcyjne. StoreType Wybór typu sprzedawcy, 3d_pay_hosting jest wartością domyślną zalecaną. Status nowego zamówienia Określa, jaki status zamówienia będzie ustawiony po dokonaniu płatności. 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 Yes, spowoduje próbę ustawienia języka interfejsu płatności takiego samego, jaki został wybrany przez klienta w sklepie Magento. 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 No 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. Bezwzględna ścieżka do katalogu z plikiem logów eservice System ma możliwość zapisywania informacji diagnostycznych. W celu ich zapisywania, w polu tekstowym należy podać pełną ścieżkę do pliku, w którym mają być zapisywane logi pracy systemu. Uwaga: system (użytkownik na prawach którego działa serwer Apache) musi mieć uprawnienia do tworzenia i zapisu plików w wybranym katalogu. 7
3 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, na karcie szczegółowego podglądu zamówienia pojawi się informacja pokazana na rysunku (Rysunek 2) Rysunek 2: 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 Status płatności status płatności który został otrzymany z eservice (patrz dokumentacja eservice) Poprzedni status płatności poprzedni status płatności który został otrzymany z eservice (patrz dokumentacja eservice) Data utworzenia data rozpoczęcia transakcji Data modyfikacji data modyfikacji danych przedstawionych w tabeli. 4 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 8