Open

Wstęp

Niniejsza instrukcja przedstawia proces instalacji oraz konfiguracji wtyczki, umożliwiającej wprowadzenie InPost Pay w sklepie PrestaShop.

Wtyczka

Wersja 1.10.0 (28.10.2024):

Open

*Wtyczka obecnie jest jeszcze rozwijana, będą pojawiały się nowe wersje wtyczki, śledź changelog i instaluj nowe wersje, jak tylko będą dostępne.

Changelog

Na tej stronie

Wymagania

Do poprawnego działania wymagana jest instalacja PrestaShop w wersji nie niższej niż 1.7.1 oraz PHP w wersji nie niższej niż 7.1.

Instalacja

W celu instalacji wtyczki postępuj zgodnie z poniższymi krokami:

1. Pobierz spakowaną wtyczkę PrestaShop ze strony InPost i nie rozpakowuj jej

2. Zaloguj się do sekcji administracyjnej swojego sklepu

3. Z menu po lewej stronie wybierz “Moduły” a następnie “Menedżer modułów”.

   Open

   

4. Na górze strony kliknij “Załaduj moduł”.
   
   

5. Do otwartego okna przeciągnij uprzednio pobrany moduł.
   
   

Konfiguracja modułu

W celu wstępnej konfiguracji przejdź do listy modułów i kliknij “Konfiguruj” obok modułu InPost Pay. Po jego kliknięciu pokaże się formularz umożliwiający konfigurację wtyczki.

Ustawienia podstawowe

Zakładka “Ustawienia” w konfiguracji modułu zawiera podstawowe ustawienia konfiguracyjne modułu.

Ustawienia środowiska i klucze API

Konfiguracja środowiska zawiera wymagane pola, które trzeba uzupełnić jako pierwsze przy konfiguracji wtyczki.

Środowisko

Konfiguracja środowiska zawiera trzy typy środowiska:

• UAT - testowe środowisko przeznaczone dla developerów

• Sandbox - testowe środowisko przeznaczone dla merchantów w celu testów wtyczki przed uruchomieniem produkcyjnym

• Produkcja - środowisko produkcyjne, używaj tylko i wyłącznie jeśli przetestowałeś już wtyczkę na środowisku sandbox

Wyświetlanie widgetu

W konfiguracji modułu możesz ustawić widoczność widgetu.

Dostępne są dwie opcje:

• wszystkim - widget widoczny jest dla każdego kto dokonuje zakupy na sklepie, uruchamiaj tylko gdy wtyczka jest już skonfigurowana produkcyjnie i przetestowana

• testerom - widget widoczny jest tylko po dodaniu parametru showIzi=true do url strony. Przykład https://mojsklep.pl?showIzi=true

Client ID

Wymagane pole konfiguracyjne.

Client ID różni w zależności od wybranego środowiska. Aby uzyskać sandboxowe Client ID skontaktuj się z nami przez formularz kontaktowy. Aby uzyskać produkcyjne Client ID zaloguj się do InPost i uzupełnij dane sklepu.

Client secret

Client Secret różni się w zależności od wybranego środowiska. Aby uzyskać sandboxowe Client Secret skontaktuj się z nami przez formularz kontaktowy. Aby uzyskać produkcyjne Client Secret zaloguj się do InPost i uzupełnij dane sklepu.

POS ID

Wymagane pole konfiguracyjne.

W przypadku środowiska sandbox - otrzymasz tą wartość razem z Client Id i Client Secret po uzupełnieniu formularza. W przypadku środowiska produkcyjnego - zaloguj się do InPost i pobierz POS ID.

Konfiguracja metod płatności

Konfiguracja dotycząca metod płatności jakimi będzie można dokonać płatność aplikacji InPost.

Dostępne metody płatności

Metody płatności zostały określone na umowie o obsługę bramki płatniczej.

Wybierz z listy rozwijanej metody płatności, które powinny być dostępne.

Płatność przy odbiorze

Płatność przy odbiorze będzie dostępna tylko wtedy, kiedy posiadasz podpisaną umowę z InPost na świadczenie tej usługi w Twoim sklepie.

Konfiguracja statusów zamówień

Gdy zamówienie zostanie utworzone z użyciem InPostPay możesz przypisać dla nich odpowiednie statusu zamówienia w swoim sklepie PrestaShop.

Początkowy status zamówienia utworzonego przez InPost Pay

Początkowy status dla zamówienia utworzonego poprzez aplikację InPost. Status możesz dowolnie zmieniać tworząc swój status zamówienia w panelu PrestaShop.

Status zamówienia utworzonego przez InPost Pay (płatność za pobraniem)

Początkowy status dla zamówienia utworzonego poprzez aplikację InPost dla płatności za pobraniem. Status możesz dowolnie zmieniać tworząc swój status zamówienia w panelu PrestaShop.

Status dla zamówienia opłaconego przez InPost Pay

Status dla zamówienia, które zostało opłacone poprawnie przez klienta w aplikacji InPost. Status możesz dowolnie zmieniać tworząc swój status zamówienia w panelu PrestaShop.

Wyświetlanie widgetu na stronie potwierdzenia zamówienia

Widget na stronie potwierdzenia zamówienia możesz wyświetlać przez konfiguracje w trzech hookach. Wybierz ten, który najbardziej odpowiada twojemu szablonowi w sklepie. Widget musi być widoczny na górze strony od razu przy przekierowaniu na stronę potwierdzenia zamówienia.

Dostępne są trzy hooki:

• displayPaymentReturn - domyślny hook w PrestaShop widoczny na stronie potwierdzenia zamówienia

• displayOrderConfirmation - domyślny hook w PrestaShop widoczny na stronie potwierdzenia zamówienia

• displayIziThankYou - hook modułu InPostPay, który umożliwia Ci użycie widgetu na stronie thank you page w dowolnym miejscu, jeśli hooki domyślne nie spełniają poprawnie swojej roli. Wymagana jest ręczna implementacja takiego hooka w pliku templates/checkout/order-confirmation.tpl dodajemy {hook h="displayIziThankYou" order=$order}.

Wyświetlanie widgetu na karcie produktu

Widget na karcie produktu możesz wyświetlać przez konfiguracje w dwóch hookach. Wybierz ten, który najbardziej odpowiada twojemu szablonowi w sklepie.

Dostępne są dwa hooki:

• displayProductActions - domyślny hook w PrestaShop widoczny na stronie produktu

• displayProductAdditionaInfo - domyślny hook w PrestaShop widoczny na stronie produktu

Wyświetlanie widgetu w checkoucie

Widget w checkoucie możesz wyświetlać przez konfiguracje w dwóch hookach.

Dostępne są dwa hooki:

• displayCheckoutSummaryTop

• displayIziCheckoutButton - wymagana jest ręczna implementacja w pliku szablonu {hook h="displayIziCheckoutButton" order=$order}.

Statusy zamówień

Nazwy statusów zamówień możesz zmieniać dla zamówień złożonych poprzez aplikację InPost.

Jeśli nie zostanie zmieniony jakiś status zamówienie to będzie wyświetlany nazwa w zależności od konfiguracji danego statusu w PrestaShop.

Komentarz zamówienia

Moduł pozwala na opcjonalne umieszczenie dodatkowych informacji w komentarzu do zamówienia w przypadku, gdy klient wybierze dostawę do Paczkomatu:

W szablonie wiadomości dostępne do użycia są następujące parametry:

• payment_type - kod wybranej przez klienta metody płatności

• delivery_point - numer wybranego Paczkomatu

• delivery_codes - lista kodów wybranych przez klienta usług dodatkowych

• is_pww - czy klient wybrał usługę Paczka w Weekend (prawda/fałsz)

• is_cod - czy klient wybrał usługę płatności pobraniowej (prawda/fałsz)

Fragmenty odpowiadające nazwie parametru umieszczonej w nawiasach klamrowych (“{ }”) zastępowane są wartością parametru - np. jeżeli klient wybrał dostawę do Paczkomatu “ABC123”, szablon:

Wybrany Paczkomat: {delivery_point}.
poskutkuje wiadomością treści:

Wybrany Paczkomat: ABC123.
Wartości logiczne wypisywane są jako “true” lub “false”, listy - ograniczone nawiasami kwadratowymi (“[ ]”).

Podwójne nawiasy klamrowe (“{{ }}“) pozwalają na wypisanie wyliczonej wartości wyrażenia - np. szablon:

Paczka w Weekend: {{ is_pww ? "tak" : "nie" }}.
poskutkuje wiadomością treści:

Paczka w Weekend: tak.
lub

Paczka w Weekend: nie.
w zależności od tego, czy klient wybrał odpowiednią opcjonalną usługę.

Szczegółowe informacje na temat składni wyrażeń można znaleźć w dokumentacji komponentu Expression Language w wersji odpowiedniej dla używanej wersji PrestaShop (2.x dla PS 1.7.0 - 1.7.3, 3.x dla pozostałych wersji 1.7, 4.x dla PS 8.x). Funkcja constant nie jest dostępna.

Sugerowane produkty

W konfiguracji modułu możesz ustawić maksymalną ilość produktów sugerowanych jakie mają być wyświetlane w aplikacji w podglądzie koszyka.

Gdy wartość jest pusta ilość produktów będzie wyświetlana bez limitu. Produkty sugerowane są pobierane z produktów powiązanych, które aktualnie są dodane w do koszyka. Produkty powiązane możemy znaleźć na stronie konfiguracji danego produktu w zakładce “Ustawienia podstawowe”. Produkty powiązane są domyślną funkcją PrestaShop.

Zgody

W zakładce “Zgody” możemy dodać zgody, jakie będą wyświetlane w aplikacji InPost na etapie składania zamówienia. Przy dodawaniu zgody jest możliwość aby wskazać dodatkowe linki do wyświetlenia przy niej w aplikacji mobilnej. Nowe zgody możemy dodawać poprzez wybranie przycisku “Dodaj kolejną zgodę”.

Opis wyświetlany w aplikacji

W polu “Opis wyświetlany w aplikacji” - wpisujemy treść danej zgody jaka ma być wyświetlana w aplikacji InPost. Pole jest wielojęzyczne.

Obligacja zgody

Zgoda może być obligatoryjna do złożenia zamówienia lub opcjonalna.

Pole przyjmuje wartości:

• Opcjonalny - zgoda nie jest wymagana na etapie składania zamówienia

• Zawsze wymagany - zgoda jest wymagana za każdym razem na etapie składania zamówienia

• Wymagany raz - zgoda jest wymagana tylko raz na etapie składania zamówienia.

Identyfikator

Unikalny identyfikator linku. W opisie zgody fragmenty powstałe przez dodanie do ID przedrostka “#” zostaną zastąpione odpowiadającymi linkami.

Adres zgody

W polu “Adres zgody” wybieramy stronę CMS, do której ma linkować dana zgoda w celu przeczytania informacji na temat danej zgody.

Tekst na przycisku

Tekst, który zostanie wyświetlony na przycisku linku zgody. W przypadku pozostawienia pola pustego zostanie wyświetlony tekst “link”.

Cena transportu

Zakładka “Cena transportu” zawiera pola konfiguracje dotyczące mapowania metod dostawy, kosztów oraz dostępności dostawy. Konfiguracje ustawiamy osobno dla usługi “Kurier” oraz “Paczkomat”.

Kurier

Konfiguracja usługi kuriera.

Mapowanie metody dostawy - Kurier

Pole Mapowanie przewoźnika jest odpowiedzialne za zmapowanie metody dostawy z PrestaShop dla usługi Kuriera. W przypadku gdy dla usługi Kuriera i opcji płatności za pobraniem występuje osobna metoda dostawy wykonujemy mapowanie tej usługi w polu Mapowanie przewoźnika (Płatność za pobraniem).

Kurier pobranie

Pole Płatność za pobraniem (Dodatkowy koszt) zawiera wartość netto kwoty do doliczenia w przypadku gdy usługa zostanie wybrana.

Paczkomat

Konfiguracja usługi Paczkomat.

Mapowanie metody dostawy - Paczkomat

Pole Mapowanie przewoźnika jest odpowiedzialne za zmapowanie metod dostawy z PrestaShop dla usługi Paczkomat. W sytuacji gdy dla opcji dodatkowych dostawy do Paczkomatu Płatność za pobraniem i Paczka w weekend występują osobne metody dostawy w PrestaShop wykonujemy mapowanie w odpowiednich polach Mapowanie przewoźnika (Płatność za pobraniem), Mapowanie przewoźnika (Paczka w Weekend), Mapowanie przewoźnika (Płatność za pobraniem + Paczka w Weekend).

Paczkomat pobranie

Pole Płatność za pobraniem (Dodatkowy koszt) zawiera wartość netto kwoty do doliczenia w przypadku gdy usługa zostanie wybrana.

Koszt dla usługi Paczkomat paczka w weekend

Pole Paczka w Weekend (Dodatkowy koszt) jest odpowiedzialne za koszt netto usługi Paczkomat w weekend. Stawka VAT pobierana jest z konfiguracji przewoźnika zmapowanego w polu “Paczkomat”.

Dostępność usługi Paczkomat paczka w weekend

Za dostępność usługi “Paczkomat paczka w weekend” odpowiadają pola dostępności. “Dostępny od” - “Dostępny do” określa okres czasu od jakiego ma być dostępna usługa paczki w weekend w aplikacji InPost.

Ustawienia GUI

Zakładka “Ustawienia GUI” jest odpowiedzialna za konfiguracja wyświetlania widgetu przycisku na stronie produktu oraz koszyka. Przyciski poglądowe są odświeżane dynamicznie aby zaprezentować aktualny wygląd przycisku z danymi ustawieniami. Trzeba pamiętać o kliknięciu w przycisk “Zapisz” aby zapisać aktualne zmiany dokonane w konfiguracji.

Strona koszyka

Widget przycisku wyświetlany jest na stronie koszyka i umożliwia połączenie koszyka z aplikacją InPost oraz jego realizację z poziomu aplikacji.

Strona produktu

Widget przycisku wyświetlany jest na karcie produktu i umożliwia on połączenie koszyka z aplikacją InPost. Wybranie przycisku jednoczenie dodaje produkt do koszyka. Pozwala także na ograniczenie wyświetlania widgetu parowania koszyka na stronach produktów w zależności od typu, domyślnej kategorii, producenta lub atrybutów produktu.

Strona logowania

Widget przycisku wyświetlany jest na stronie logowania pod formularzem logowania.

Strona rejestracji

Widget wyświetlany jest na stronie rejestracji nad formularzem rejestracji.

Strona zamówienia

Widget przycisku wyświetlany jest na stronie realizacji zamówienia powyżej podsumowania zamówienia.

Podgląd koszyka

• Widget przycisku wyświetlany jest na podglądzie koszyka. Wymaga użycia niestandardowego hooku – należy zaimplementować w szablonie
  {hook h="displayIziCartPreviewButton"}.

Konfiguracja widgetu

Pola dla konfiguracji widgetu na stronie koszyka oraz produktu są takie same. Jednak wygląd każdego przycisku może się różnić i moduł daje możliwość konfiguracji tych pól osobno dla każdego umiejscowienia.

Wyświetlanie widgetu

Moduł umożliwia wyłączenie wyświetlania takiego przycisku dla strony produktu oraz koszyka. Zalecane jest w celu zwiększenia konwersji by widget był widoczny na stronie koszyka, zarówno jak na karcie produktu.

Wyrównanie widgetu

Określa orientację widżetu w dostępnej dla niego przestrzeni. Jeśli szablon przydziela wąską przestrzeń dla widżetu, ustawienie to nie wpłynie na jego wygląd.

Dostępne opcje wyrównania:

• Do lewej - powoduje przesunięcie widgetu do lewej strony

• Wyśrodkowane - powoduje wyśrodkowanie widgetu

• Do prawej - powoduje przesunięcie widgetu do prawej strony

Tło widgetu

Określa czy widget znajduje się na jasnym czy ciemnym tle w Twoim sklepie. Ustawienie ma wpływ na kolor czcionki, zadbaj o to, aby była widoczna.

Tło widget zawiera dwie opcje:

• Jasne - wybierz tą opcję jeśli przycisk jest wyświetlany na jasnym tle

• Ciemne - wybierz tą opcję jeśli przycisk jest wyświetlany na ciemnym tle

Wariant widgetu

Widget dostępny jest w 2 wariantach kolorystycznych. Wybierz ten, bardziej odpowiadający kolorystyce Twojego sklepu.

Wariant widgetu zawiera dwie opcje do wyboru:

• Żółty - wybierz tą opcję jeśli chcesz by przycisk miał kolor żółty

• Czarny - wybierz tą opcję jeśli chcesz by przycisk miał kolor czarny

Styl ramki widgetu

Pole konfiguracyjne określa w jakim stylu powinien być wyświetlony przycisk na stronie sklepu.

Konfiguracja stylu ramki zawiera trzy warianty:

• Kwadratowe - wybierz tą opcję jeśli chcesz by przycisk nie miał zaokrąglonych rogów

• Zaokrąglone - wybierz tą opcję jeśli chcesz by rogi były nieznacznie zaokrąglone

• Okrągłe - wybierz tą opcję jeśli chcesz by rogi były mocno zaokrąglone.

Szerokość widgetu

Moduł umożliwia nam ustawienia dla widgetu:

• minimalnej wartości szerokości – wartość pomiędzy 220 a 1200

• minimalnej wartości szerokości – wartość pomiędzy 220 a 1200

• maksymalnej wartości wysokości – wartość pomiędzy 48 a 64

W pole wpisujemy tylko wartości numeryczne bez przyrostka “px”.

Marginesy widgetu

Jeżeli przycisk jest źle ułożony lub “styka” się z innymi elementami UI na stronie sklepu, masz możliwość określenia marginesów dla widgetu.

Wszystkie pola marginesów przyjmują wartość numeryczną bez przyrostka “px”.

Ograniczenia produktów

Konfiguracja warunków przy których widget nie zostanie wyświetlony na stronach produktów.

Typ produktu

Pole konfiguracyjne określa na produktach jakiego typu widget nie będzie wyświetlany.

Konfiguracja typu produktu posiada sześć wariantów:

• Zaznacz wszystkie pola – zaznacza wszystkie poniższe pola

• Standardowe produkty - podstawowy rodzaj produktu, który nie ma opcji do wyboru ani wariantów

• Produkty z kombinacjami - produkty, które mają różne warianty, takie jak rozmiary, kolory, czy inne cechy, które wpływają na cenę i dostępność

• Dostosowywalne produkty - produkty, które można dostosować przez klienta, na przykład poprzez dodanie personalizacji, takiej jak grawerowanie lub druk

• Zestawy produktów - grupa produktów sprzedawanych razem jako zestaw, często z niższą ceną niż zakup pojedynczych produktów osobno

• Produkty wirtualne - produkty, które nie istnieją fizycznie, na przykład pliki do pobrania, subskrypcje lub usługi internetowe.

Marka produktu

Pole konfiguracyjne określa na produktach jakiej marki widget nie będzie wyświetlany.

Ilość wyświetlanych wariantów jest zależna od indywidualnej ilości marek w danym sklepie.

Grupa atrybutów

Pole konfiguracyjne określa na produktach z jakim atrybutem widget nie będzie wyświetlany.

Ilość wyświetlanych wariantów jest zależna od indywidualnej ilości atrybutów w danym sklepie.

Kategorie

Pole konfiguracyjne określa na produktach jakiej kategorii widget nie będzie wyświetlany.

Ilość wyświetlanych wariantów jest zależna od indywidualnej ilości kategorii w danym sklepie.

Zakładka Support

Zakładka “Support” zawiera przydatne informacja min. status wtyczki, który informuje czy wtyczka została poprawnie skonfigurowana. Umożliwia nam włączyć tryb debugowania oraz pobrać logi wraz z przydatnymi informacjami, która mogą pomóc przy rozwiązać problem podczas kontaktu z supportem.

Status wtyczki

Status wtyczki informuje nas czy moduł jest poprawnie skonfigurowany. Jeśli moduł jest poprawnie skonfigurowany wyświetla on status “OK”.

Jeśli występują jakieś problemy z konfiguracją wyświetlana jest status “BŁĄD” i moduł dostarcza informacji na temat błędu w konfiguracji.

Pobieranie danych wtyczki oraz logów

Moduł umożliwia pobranie danych na temat wtyczki oraz logów modułu, które pomogą przy rozwiązaniu problemów związanych z wtyczką.

Tryb debugowania

Włącznie trybu debugowania zwiększa ilość informacji jaka jest zawarta w logach modułów. Może być przydatne w ramach supportu wtyczki gdzie wszelkie informację zawarte w logach mogą pomóc w rozwiązaniu problemu.