Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Dokumentacja techniczna wtyczki InPost Pay dla Woocommerce. Wtyczka dodaje do sklepu
Woocommerce funkcjonalność dokonywania zamówień przez aplikację InPost przez:
Dodanie tabeli w bazie danych,
Dodanie przycisku “Zamów i zapłać “Utwórz koszyk z InPost Pay” na listingu produktów,
Dodanie przycisku “Zamów i zapłać “Utwórz koszyk z InPost Pay” na karcie produktu,
Dodanie przycisku “Zamów i zapłać “Utwórz koszyk z InPost Pay” na stronie koszyka,
Dodanie przycisku “Zamów i zapłać “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.
Na tej stronie
| Table of Contents |
|---|
Wymagania
Do poprawnego działania wtyczka wymaga:
PHP w wersji nie niższej niż 7.4
Woocommerce w wersji nie niższej niż 7.3.0
Instalacja
Podczas instalacji wtyczka dodaje do bazy danych tabelę opisaną w https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/132382721/InPost+Pay+-+Woocommerce#Baza-danych.
W celu instalacji wtyczki postępuj zgodnie z poniższymi krokami:
Pobierz spakowaną wtyczkę Woocommerce ze strony inpost InPost i nie rozpakowuj jej
Zaloguj się do sekcji administracyjnej swojego sklepu
Z menu po lewej stronie wybierz “Wtyczki” a następnie “Dodaj nową”
Na górze strony wybierz “Wyślij wtyczkę na serwer” następnie “Wybierz plik” i
odszukaj spakowaną wtyczkę pobraną w punkcie 1
Kliknij “Zainstaluj”
W następnym oknie kliknij “Aktywuj wtyczkę”
Konfiguracja
Po instalacji wtyczki w menu po lewej stronie sekcji administracyjnej zobaczysz nowe menu “InPost Pay”. Po jego kliknięciu pokaże się formularz umożliwiający konfigurację wtyczki. Wypełnij pola zgodnie z poniższą tabelą:
Nazwa pola | Opis |
|---|---|
Środowisko | Którego środowiska dotyczą dane dostępowe |
Pokazuj widget | Czy pokazywać widget wszystkim czy osobom, które w adresie strony dodadzą parametr GET showIzi=true |
Client ID | Identyfikator nadany przy zakładaniu konta |
Client Secret | Klucz nadany przy zakładaniu konta |
Metody płatności | Obsługiwane przez Twój sklep metody płatności |
Dodatkowa zgoda | Wybierz stronę, która zawiera zgodę, którą musi zatwierdzić osoba kupująca w aplikacji |
Status zamówienia dla AUTHORIZED | Status zamówienia, jakie otrzyma poprawnej płatności w aplikacji |
Status zamówienia dla DECLINED | Ustawienie nieużywane |
Status zamówienia dla CANCELLED | Ustawienie nieużywane |
Status zamówienia dla ERROR | Ustawienie nieużywane |
Kurier | Cena transportu jaka użytkownik zobaczy w aplikacji Inpost |
Paczkomat | Cena transportu jaka użytkownik zobaczy w aplikacji Inpost |
Paczka w Weekend | Cena transportu jaka użytkownik zobaczy w aplikacji Inpost |
Pobranie | Cena transportu jaka użytkownik zobaczy w aplikacji Inpost |
Umiejscowienie widgetu w koszyku | Wybór umiejscowienia widgetu na stronie koszyka |
Umiejscowienie widgetu w zamówieniu | Wybór umiejscowienia widgetu na stronie zamówienia |
Widok w koszyku
Po konfiguracji wtyczki w koszyku przy produktach pojawi się przycisk Utwórz koszyk z InPost Pay:
Dezinstalacja
Dezinstalacja wtyczki usuwa pliki wtyczki. Baza danych i dane nie zostają zmienione.
Baza danych
Wtyczka do poprawnego działania wykorzystuje tabelę w bazie danych o strukturze:
Nazwa | Typ | Funkcja |
|---|---|---|
| MEDIUMINT | Klucz główny. |
| TEXT | Dane sesji użytkownika potrzebne do manipulacji |
| VARCHAR(255) | Identyfikator koszyka InPost Pay. |
| INT | ID zamówienia Woocommerce. |
| VARCHAR(255) | URL strony z podziękowaniem za zamówienie. |
Hooks wykorzystywane
Hook | Zastosowanie |
|---|---|
| Wysyłamy zawartość koszyka Woocommerce do InPost Pay. |
| Wysyłamy zawartość koszyka Woocommerce do InPost Pay. |
| Wysyłamy zawartość koszyka Woocommerce do InPost Pay. |
| Wysyłamy zawartość koszyka Woocommerce do InPost Pay. |
| Wyświetlamy przycisk “Zamów i zapłać “Utwórz koszyk z InPost Pay”. |
| Do zamówienia dodajemy billing_phone wydzielony połączony z prefiksu oraz numeru telefonu. Pola dodane w https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/132382721/InPost+Pay+-+Woocommerce#Filtry |
| Dodajemy podziękowanie za zakupy renderowane przez kod z https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/132382721/InPost+Pay+-+Woocommerce#Zasoby-zewn%C4%99trzne |
| Zapisujemy sesje użytkownika w bazie danych. |
| Wyświetlamy przycisk “Zamów i zapłać “Utwórz koszyk z InPost Pay” w jednym z wybranych miejsc. Hook możliwy do wyboru w sekcji administracyjnej. |
| Wyświetlamy przycisk “Zamów i zapłać “Utwórz koszyk z InPost Pay” w jednym z wybranych miejsc. Hook możliwy do wyboru w sekcji administracyjnej. |
Filtry
Filtr | Zastosowanie |
|---|---|
| Dodaje pole z prefixem numeru telefonu na stronie zamówienia. |
Panel administracyjny
Wtyczka dodaje w sekcji administracyjnej zakładkę InPost Pay zawierającą konfiguracjęwtyczki. Dane tam zawarte przechowywane są jako Wordpress Option
. |
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.