Wstęp
Niniejsza instrukcja przedstawia proces instalacji oraz konfiguracji wtyczki, umożliwiającej wprowadzenie InPost Pay w sklepie Magento.
Wtyczka: (23.08.2023 r.) wersja 1.0.15
| View file | ||
|---|---|---|
|
*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:
Nowa wersja 23.08.2023r - 1.0.15
Poprzednie wersje:
23.08.2023r - 1.0.14
17.08.2023r
Wymagania
Do poprawnego działania wymagana jest instalacja Magento w wersji nie niższej niż 2.4.5 i wyższejx oraz PHP w wersji nie niższej niż 7.4.
Instalacja
W celu instalacji wtyczki postępuj zgodnie z poniższymi krokami:
Pobierz spakowaną wtyczkę Magento ze strony inpost i rozpakuj ją.
Za pomocą FTP umieść rozpakowaną wtyczkę w katalogu /app/code swojego sklepu.
Wykonaj polecenie `bin/magento setup`
Na tej stronie
| Table of Contents |
|---|
Konfiguracja Testowa
W tym rozdziale opisujemy skrócony proces konfiguracji potrzebny do przeprowadzenia testów działania integracji z InPost Pay. 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. Wypełnij pola zgodnie z poniższą listą:
Wybierz środowisko i opcje wyświetlania.
a. Środowisko ustaw na “Sandbox” - w ten sposób pieniądze nie będą pobierane z konta podczas testów.
b. Pokazuj widget ustaw na “Testerom” - w ten sposób widget będzie widoczny tylko dla osób, które mają go zobaczyć. Ustawienie innej opcji wyświetli widget działający bądź nie wszystkim osobom odwiedzającym Twój sklep.
W celu wyświetlenia widgetu w przeglądarce internetowej wpisz adres Twojego sklepu z dopiskiem ?showIzi=true. Przykład: https://mojsklep.pl?showIzi=true
Wypełnij dane dostępowe do API, które otrzymałeś od InPost w polach
a. Client
b. Client Secret.
Włącz możliwość płatności.
Dodaj zgody, które będą wymagane w Twoim sklepie. Szczegółowy opis każdej z opcji znajdziesz w rozdziale Pełna konfiguracja -https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/173932552/InPost+Pay+-+Magento#Pe%C5%82na-Konfiguracja.
Wybierz status zamówienia, jakie zostanie nadane zamówieniom opłaconym poprzez InPost Pay.
Połącz wysyłkę Kurierem z wysyłką systemową. Po wybraniu z listy rozwijalnej sposobu wysyłki te same reguły dostępności i cen dla wybranej metody będą obowiązywać dla wysyłki Kurierem w aplikacji InPost.
Połącz wysyłkę przez Paczkomat z wysyłką systemową. Po wybraniu z listy rozwijalnej sposobu wysyłki te same reguły dostępności i cen dla wybranej metody będą obowiązywać dla wysyłki Paczkomat w aplikacji InPost.
Określ gdzie widget powinien być dostępny na Twojej stronie. Możesz wyświetlać go na liście produktów, karcie produktu oraz w koszyku. Dla każdego miejsca wyświetlania możesz określić, do której strony przycisk InPost Pay będzie wyrównany. Dla każdego miejsca możesz osobno wybrać, czy tło na stronie jest jasne czy ciemne co zapewni poprawne wyświetlanie tekstów. Dla każdego miejsca możesz oddzielnie wybrać wariant wyświetlania. Przycisk może być amarantowy bądź żółty.
Konfiguracja Produkcyjna
Po poprawnej konfiguracji testowej i upewnieniu się, że integracja w środowisku Sandbox działa należy udostępnić InPost Pay wszystkim użytkownikom.
W celu 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. Zmień konfigurację zgodnie z poniższą listą:
Wybierz środowisko i opcje wyświetlania.
a. Środowisko ustaw na “Produkcyjne” - w ten sposób pieniądze będą pobierane z konta podczas testów.
b. Pokazuj widget ustawa na “Wszystkim”
Pełna Konfiguracja
Rozdział zawiera pełną listę dostępnych opcji konfiguracji InPost Pay.
Ustawienia API
W tej sekcji ustawia się dane dostępowe do systemu, rodzaje obsługiwanych metod płatności oraz informacja wymieniane między InPost Pay a sklepem.
Dane dostępowe do środowiska sandbox uzyskasz pisząc maila na skrzynkę integracjapay@inpost.pl
Dane produkcyjne otrzymasz po podpisaniu umowy o usługę InPost Pay
Opis dostępnych opcji:
Środowisko:
Do czego służy: | Jak ustawić: |
|---|---|
Określa czy sklep wysyła dane do środowiska UAT, Sandbox czy produkcyjnego. | Kiedy testujesz integrację ustaw środowisko Sandbox. Jeśli testy przebiegły pomyślnie i chcesz włączyć możliwość kupna przez InPost Pay ustaw środowisko Produkcyjne. |
Pokazuj widget:
Do czego służy: | Jak ustawić: |
|---|---|
Podczas testów nie chcemy, żeby widget InPost Pay wyświetlał się wszystkim klientom. Niezależnie od tego jakie środowisko zostało ustawione możesz tymczasowo ukryć widget i pokazywać go tylko wybranym osobom. W celu wyświetlenia widgetu w trybie tylko dla testerów wejdź na stronę główną sklepu i dodaj na końcu adresu url ?showIzi=true Na przykład https://outofthebox.pl?showIzi=true | Kiedy konfigurujesz integrację wybierz Testerom. W celu pokazania widgetu wszystkim już po wykonaniu testów konfiguracji ustaw Wszystkim. |
Client ID:
Do czego służy: | Jak ustawić: |
|---|---|
Dana dostępowa do API. | Zgodnie z danymi otrzymanymi od InPost. |
Client Secret:
Do czego służy: | Jak ustawić: |
|---|---|
Dana dostępowa do API. | Zgodnie z danymi otrzymanymi od InPost. |
POS ID:
Do czego służy: | Jak ustawić: |
|---|---|
Do określenia stanowiska POS. | Zgodnie z danymi otrzymanymi od InPost. |
Włącz płatności zgodne z podpisaną umową z Aion:
Do czego służy: | Jak ustawić: |
|---|---|
Określa, czy Twoi klienci będą mogli dokonywać płatności przez bramki płatnicze, które są zawarte w Twojej umowie z Aion takie jak Blik, Apple Pay, płatność kartą. | Zaznacz Tak jeśli metody mają być dostępne. |
Włącz płatność przy odbiorze zgodnie z podpisaną umową z InPost:
Do czego służy: | Jak ustawić: |
|---|---|
Określa, czy Twoi klienci będą mogli dokonywać płatności przy odbiorze zgodnie z umową z InPost. | Zaznacz Tak jeśli metoda ma być dostępna. |
Status zamówienia dla zamówienia opłaconego przez InPost Pay:
Do czego służy: | Jak ustawić: |
|---|---|
Określa jaki status mają mieć zamówienia, które zostaną opłacone przez InPost Pay. | Wybierz z listy status jaki mają mieć zamówienia opłacone. |
Maksymalna liczba produktów sugerowanych:
Do czego służy: | Jak ustawić: |
|---|---|
Określa maksymalną liczbę produktów, jakie zostaną zasugerowane Twojemu klientowi w aplikacji Inpost do produktów jakie już ma w koszyku. Produkty sugerowane pobierane są ze standardowego mechanizmu Magento. | Wpisz maksymalną liczbę produktów. |
Zgody
Sekcja służy do ustawienia zgód wyświetlanych klientom w aplikacji InPost podczas zakupów z InPost Pay.
Opis dostępnych opcji:
Adres zgody:
Do czego służy: | Jak ustawić: |
|---|---|
Określa stronę, na którą zostanie przekierowany Twój klient w celu przeczytania zgody. Strony widoczne na liście to standardowe Strony dostępne w Wordpress. | Wybierz jedną ze stron Twojego sklepu z listy rozwijalnej. |
Opis wyświetlany w aplikacji:
Do czego służy: | Jak ustawić: |
|---|---|
Określa opis wyświetlany w aplikacji. | Wpisz opis, jaki ma zostać wyświetlony. |
Czy wymagane:
Do czego służy: | Jak ustawić: |
|---|---|
Określa czy zgoda jest wymagana. | Wpisz wymagalność zgody z listy. |
Wskazówka: Jeśli chcesz utworzyć jeden checkbox w aplikacji służący do akceptacji więcej niż jednego dokumentu stwórz stronę, na której umieścisz odnośniki do wszystkich wymaganych zgód.
Cena transportu netto
Sekcja odpowiedzialna za mapowanie form transportu oraz określenie dostępności i cen opcji dodatkowych transportu.
Opis dostępnych opcji: Ustawienia tej sekcji są analogiczne dla wszystkich typów wysyłki i dla wszystkich opcji.
Poniżej generyczny opis gdzie jako typ wysyłki zostało użyte typ oraz opcja dla opcji wysyłki:
Kurier/Paczkomat:
Do czego służy: | Jak ustawić: |
|---|---|
Określa, która z dostępnych w sklepie metod wysyłki określa ceny i zasady dla wysyłki typu kurier/paczkomat. Lista zawiera standardowe, dostępne w Systemie metody wysyłki. | Wybierz wysyłkę dostępną w Twoim sklepie z listy rozwijalnej. |
Opcje dla PWW oraz COD:
Pamiętaj!
Poniższe opcje ustaw zgodnie z umową z InPost.
Kurier/Paczkomat [opcja] netto:
Do czego służy: | Jak ustawić: |
|---|---|
Określa cenę opcji dodatkowej. | Wpisz kwotę netto. |
Kurier/Paczkomat [opcja] dostępne od dnia:
Do czego służy: | Jak ustawić: |
|---|---|
Określa od którego dnia tygodnia opcja jest dostępna. | Wybierz dzień tygodnia, od którego opcja będzie dostępna dla Twoich klientów |
Kurier/Paczkomat [opcja] dostępne od godziny:
Do czego służy: | Jak ustawić: |
|---|---|
Określa od której godziny opcja jest dostępna. | Wybierz godzinę, od której opcja będzie dostępna dla Twoich klientów. |
Kurier/Paczkomat [opcja] dostępne do dnia:
Do czego służy: | Jak ustawić: |
|---|---|
Określa. do którego dnia tygodnia opcja jest dostępna. | Wybierz dzień tygodnia, do którego opcja będzie dostępna dla Twoich klientów. |
Kurier/Paczkomat [opcja] dostępne do godziny:
Do czego służy: | Jak ustawić: |
|---|---|
Określa do której godziny opcja jest dostępna. | Wybierz godzinę, do której opcja będzie dostępna dla Twoich klientów. |
Ustawienia GUI
Tu ustawisz czy i gdzie wyświetlać widget InPost Pay. Sekcja została podzielona na podsekcje odpowiadające różnym podstronom Twojego sklepu.
Pamiętaj! Ustawiamy GUI zgodnie z Przewodnikiem merchanta, który otrzymałeś w mailu od InPost.
Opis dostępnych opcji:
Wyświetlaj:
Do czego służy: | Jak ustawić: |
|---|---|
Określa czy widget ma wyświetlać się na danej podstronie. | Zaznacz jeśli widget ma się wyświetlać. |
Wyrównanie:
Do czego służy: | Jak ustawić: |
|---|---|
Określa orientację widgetu w dostępnej dla niego przestrzeni. Jeśli Twój szablon przeznacza wąską przestrzeń na widget ustawienie nie będzie miało wpływu na wygląd. | Wybierz orientację z listy rozwijalnej. |
Tło:
Do czego służy: | Jak ustawić: |
|---|---|
Określa czy widget znajduje się na jasnym czy ciemnym tle. Ustawienie ma wpływ na kolor czcionki. | Wybierz z listy rozwijalnej. |
Wariant:
Do czego służy: | Jak ustawić: |
|---|---|
Widget dostępny jest w 2 wariantach kolorystycznych. Wybierz ten, bardziej odpowiadający Twojemu sklepowi. | Wybierz z listy rozwijalnej. |
Margines:
Do czego służy: | Jak ustawić: |
|---|---|
Określa marginesy widgetu na stronie koszyka. | W razie niepoprawnego wyświetlania widgetu na stronie koszyka dostosuj wyświetlanie dodając margines. |
Wyświetlanie w niestandardowym miejscu
W celu wyświetlenia widgetu w niestandardowym miejscu użyj poniższego kodu w swoim szablonie:
| Code Block |
|---|
\izi\InPostIzi::render( $productId = null, $name = '', $maskedPhoneNumber = '', $inpost_basket_id = '', $echo = true, $addBasketId = false, $variationId = '', $count = 0, $dark = false, $yellow = false, $cart = false, $float = 'left', $bindingPlace = 'BASKET_POPUP' ); |
Opis parametrów:
Parametr | Opis | Wartości |
|---|---|---|
productId | Id produktu, który zostanie dodany do koszyka przed parowaniem. | int |
name | Imię klienta, które otrzymujesz z API | string |
maskedPhoneNumber | Zamaskowany numer telefonu, który otrzymujesz z API | string |
inpost_basket_id | ID koszyka, który otrzymujesz z API | string |
echo | Czy wyświetlać? | bool |
addBasketId | Czy wyświetlać id koszyka w HTML? | bool |
variationId | ID wariantu. | int |
count | Liczba produktów w koszyku. | int |
dark | Czy wyświetlić w ciemnym trybie? | bool |
yellow | Czy wyświetlić wariant żółty? Amarantowy zostanie wyświetlony domyślnie. | bool |
cart | Czy znajdujemy się na stronie koszyka? | bool |
float | CSS float | left | right | center |
binding Place | Miejsce parowania. | PRODUCT_CARD | |