Developer DocumentationsInPost Pay - PrestaShop

InPost Pay - PrestaShop

 

 

Dokumentacja techniczna wtyczki InPost Pay dla PrestraShop. Wtyczka dodaje do sklepu
PrestaShop funkcjonalność dokonywania zamówień przez aplikację InPost przez:

  • Dodanie tabeli w bazie danych,

  • Dodanie przycisku “Utwórz koszyk z InPost Pay” na listingu produktów,

  • Dodanie przycisku “Utwórz koszyk z InPost Pay” na karcie produktu,

  • Dodanie przycisku “Utwórz koszyk z InPost Pay” na stronie koszyka,

  • Dodanie przycisku “Utwórz koszyk z InPost Pay” na stronie zamówienia,

  • Akcji wykonywanych na standardowe hook’i,

  • Dodaniu pola na stronie zamówienia,

  • Dodaniu sekcji administracyjnej,

  • Udostępnienia REST API,

  • Dołączenia do strony pliku JS serwowanego z webserwera oraz pliku serwowanego z zasobu zewnętrznego.

 

Changelog:

  • Nowa wersja 22.09.2023r - 1.3.14

  • Poprzednie wersje:

    • 12.09.2023r - 1.3.13

    • 23.08.2023r - 1.3.12

    • 23.08.2023r - 1.3.11

    • 09.08.2023r - 1.3.8

    • 31.07.2023r


 

Contents

 

Wymagania

Do poprawnego działania wtyczka wymaga:

  • Prestashop w wersji nie niższej niż 1.7.0 oraz nie wyższej niż 8.0

  • PHP w wersji nie niższej niż 7.1.


 

 

Instalacja

Podczas instalacji wtyczka dodaje do bazy danych tabelę opisaną w

 

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” → “Menedżer modułów” a następnie “Załaduj moduł

4. Umieszczamy moduł w ramce i następuje instalacja wtyczki

5. Wybieramy “Konfiguruj” - należy skonfigurować wtyczkę


 

 

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ą

 

  1. 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 ustawa 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

  1. Wypełnij dane dostępowe do API, które otrzymałeś od InPost w polach
    a. Client
    b. Client Secret.

  1. Włącz możliwość płatności

  1. Z listy wybierz adresy zgód wymaganych w Twoim sklepie. Na przykład regulamin. W celu zaznaczeniu więcej niż jednej trzymaj wciśnięty klawisz CTRL.

  1. Podaj tekst jaki zostanie wyświetlony w aplikacji InPost obok linku do zgód wymaganych.

  1. Wybierz status zamówienia, jakie zostanie nadane zamówieniom opłaconym poprzez InPost Pay

  1. 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

  1. 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.

  1. 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ą:

  1. 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”


 

Wtyczka logistyczna

 

InPost dostarcza dedykowaną wtyczkę do integracji z InPost dla Klientów Prestashop.
Wtyczka ta pozwala na w pełni zautomatyzowany przebieg procesu zakupowego łącznie z nadaniem numeru przesyłki i wysłaniem go do Twoich klientów przez aplikację InPost w procesie zakupowym InPost Pay.


Pobierz wtyczkę z:
1.7 - https://inpost.pl/sites/default/files/2023-07/PrestaShop-1.7.0-1.7.8.5-ver-1.20.0.zip

8.X - https://inpost.pl/sites/default/files/2023-07/PrestaShop-8.%2B-ver-2.5.0.zip

Dokumentacja: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/61669420


Jak nadać paczkę jeśli mam wtyczkę logistyczną InPost?


Sposób wysyłki, adres oraz identyfikator paczkomatu automatycznie zostaną przekazane do wtyczki logistycznej. Ty nie musisz znać danych klienta. Musisz nadać paczkę zgodnie z instrukcją wtyczki.


Jak nadać paczkę jeśli nie mam wtyczki logistycznej InPost?


Na stronie zamówienia dokonanego przez InPost Pay dostępne są informacje mówiące o sposobie wysyłki oraz numerze paczkomatu w formie okienka.
Skopiuj je i postępuj zgodnie z Twoim standardowym procesem nadawania paczek.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Konfiguracja Pełna

Po instalacji wtyczki w celu konfiguracji należy przejść do “Moduły” → “Menedżer modułów” i w wyszukiwarce musimy wpisać Inpost. Wybieramy wtyczkę “InPost Pay”. Po kliknięciu pokaże się formularz umożliwiający konfigurację wtyczki.

 

W tej sekcji ustawia się dane dostępowe do systemu, rodzaje obsługiwanych metod płatności oraz informacja wymieniane mę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ć:

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ć:

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ć:

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ć:

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 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ć:

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ć:

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 metody mają być dostępne

 

Status zamówienia dla zamówienia opłaconego przez InPost Pay

 

Do czego służy:

Jak ustawić:

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

 

Status zamówień

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa jakie nazwy statusów mają pojawić się w aplikacji InPost Pay (kolumna po prawej) dla zamówień w Twoim sklepie (kolumna po prawej)

Zweryfikuj czy poniższe statusy odpowiadają statusom, które Twój klient otrzymuje w komunikacji dotyczącej zamówienia. Zaznacz metody dostępne dla Twoich klientów

 

Maksymalna liczba produktów sugerowanych

 

Do czego służy:

Jak ustawić:

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 Prestashop

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:

 

Zgody wymagane

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa stronę, na którą zostanie przekierowany Twój klient w celu
przeczytania zgody. Lista stron odzwierciedla strony CMS dostępne w sklepie

Zaznacz zgody wymagane od Twoich klientów. Wybierz kilka trzymając klawisz CTRL i
klikając na wybrane pozycje

 

Zgody wymagane Tekst

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa tekst wyświetlany w aplikacji InPost przy zgodach wymaganych

Wpisz treść wiadomości

 

Zgody wymagane raz

 

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa stronę, na którą zostanie przekierowany Twój klient w celu
przeczytania zgody.

Zaznacz zgody wymagane raz od Twoich klientów. Wybierz kilka trzymając klawisz CTRL i
klikając na wybrane pozycje.

 

Zgody wymagane raz Tekst

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa tekst wyświetlany w aplikacji InPost przy zgodach wymaganych raz

Wpisz treść wiadomości

 

Zgody dodatkowe

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa stronę, na którą zostanie przekierowany Twój klient w celu
przeczytania zgody

Zaznacz zgody dodatkowe możliwe do zaznaczenia przez Twoich klientów Wybierz kilka trzymając klawisz CTRL i klikając na wybrane pozycje

 

Zgody dodatkowe Tekst

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa tekst wyświetlany w aplikacji InPost przy zgodach dodatkowych

Wpisz treść wiadomości

 

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

 

Status zamówień

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa jakie nazwy statusów mają pojawić się w aplikacji InPost Pay (kolumna po prawej) dla zamówień w Twoim sklepie (kolumna po prawej)

Zweryfikuj czy poniższe statusy odpowiadają statusom, które Twój klient otrzymuje w komunikacji dotyczącej zamówienia

 


 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ć:

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 Prestashop metody wysyłki

Wybierz wysyłkę dostępną w Twoim sklepie z listy rozwijalnej

 

Opcje dla PWW oaz COD

Pamiętaj!
Poniższe opcje ustaw zgodnie z umową z InPost

 

Kurier/Paczkomat [opcja] netto:

Do czego służy:

Jak ustawić:

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ć:

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ć:

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ć:

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ć:

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ć:

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ć:

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ć:

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 orientację z listy rozwijalnej

 

Wariant

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Widget dostępny jest w 2 wariantach kolorystycznych. Wybierz ten, bardziej odpowiadający Twojemu sklepowi

Wybierz orientację z listy rozwijalnej

 

 

Margines

Do czego służy:

Jak ustawić:

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


 

 

 

Widok w koszyku

Po konfiguracji wtyczki w koszyku przy produktach pojawi się przycisk Utwórz koszyk z InPost Pay:

 

 

 

 

Wyświetlanie w niestandardowym miejscu

W celu wyświetlenia widgetu w niestandardowym miejscu użyj poniższego kodu w swoim szablonie:

\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

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

bindingPlace

Miejsce parowania

PRODUCT_CARD |
BASKET_POPUP |
BASKET_SUMMARY

 

 


Dezinstalacja

 

Dezinstalacja wtyczki usuwa pliki wtyczki. Baza danych i dane nie zostają zmienione.

 

 

 

Zasoby zewnętrzne

 

Wtyczka wykorzystuje plik JS z zewnętrznego zasobu pod adresem https://izi.inpost.pl/inpostizi.js. Plik zawiera funkcje niezbędne do obsługi funkcjonalności InPost Pay.