Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

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

Link do wtyczki: (01.01.2023r)

…………………………………………………………..

Changelog:

1.0.0:


Na tej stronie

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:

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

  2. Zaloguj się do sekcji administracyjnej swojego sklepu

  3. Z menu po lewej stronie wybierz “Wtyczki” a następnie “Dodaj nową

  4. Na górze strony wybierz “Wyślij wtyczkę na serwer” następnie “Wybierz plik” i
    odszukaj spakowaną wtyczkę pobraną w punkcie 1

  5. Kliknij “Zainstaluj

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

id

MEDIUMINT

Klucz główny.

session_id

TEXT

Dane sesji użytkownika potrzebne do manipulacji
koszykiem przez REST API.

cart_id

VARCHAR(255)

Identyfikator koszyka InPost Pay.

order_id

INT

ID zamówienia Woocommerce.

redirect_id

VARCHAR(255)

URL strony z podziękowaniem za zamówienie.


Hooks wykorzystywane

Hook

Zastosowanie

woocommerce_add_to_cart

Wysyłamy zawartość koszyka Woocommerce do InPost Pay.

woocommerce_update_cart_action_cart_updated

Wysyłamy zawartość koszyka Woocommerce do InPost Pay.

woocommerce_cart_item_removed

Wysyłamy zawartość koszyka Woocommerce do InPost Pay.

woocommerce_cart_item_set_quantity

Wysyłamy zawartość koszyka Woocommerce do InPost Pay.

woocommerce_after_shop_loop_item

Wyświetlamy przycisk “Utwórz koszyk z InPost Pay”.

woocommerce_checkout_process

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

woocommerce_thankyou_order_received_text

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

woocommerce_set_cart_cookies

Zapisujemy sesje użytkownika w bazie danych.

woocommerce_before_cart
woocommerce_before_cart_table
woocommerce_before_cart_contents
woocommerce_cart_contents
woocommerce_cart_coupon
woocommerce_after_cart_contents
woocommerce_after_cart_table
woocommerce_cart_collaterals
woocommerce_before_cart_totals
woocommerce_cart_totals_before_shipping
woocommerce_before_shipping_calculator
woocommerce_after_shipping_calculator
woocommerce_cart_totals_after_shipping
woocommerce_cart_totals_before_order_total
woocommerce_cart_totals_after_order_total
woocommerce_proceed_to_checkout
woocommerce_after_cart_totals
woocommerce_after_cart

Wyświetlamy przycisk “Utwórz koszyk z InPost Pay” w jednym z wybranych miejsc. Hook możliwy do wyboru w sekcji administracyjnej.

woocommerce_before_checkout_form
woocommerce_checkout_before_customer_details
woocommerce_before_checkout_billing_form
woocommerce_after_checkout_billing_form
woocommerce_before_checkout_shipping_form
woocommerce_after_checkout_shipping_form
woocommerce_before_order_notes
woocommerce_after_order_notes
woocommerce_checkout_after_customer_details
woocommerce_checkout_before_order_review
woocommerce_review_order_before_cart_contents
woocommerce_review_order_after_cart_contents
woocommerce_review_order_before_shipping
woocommerce_review_order_after_shipping
woocommerce_review_order_before_order_total
woocommerce_review_order_after_order_total
woocommerce_review_order_before_payment
woocommerce_review_order_before_submit
woocommerce_review_order_after_submit
woocommerce_review_order_after_payment
woocommerce_checkout_after_order_review
woocommerce_after_checkout_form

Wyświetlamy przycisk “Utwórz koszyk z InPost Pay” w jednym z wybranych miejsc. Hook możliwy do wyboru w sekcji administracyjnej.


Filtry

Filtr

Zastosowanie

woocommerce_checkout_fields

Dodaje pole z prefixem numeru telefonu na stronie zamówienia.


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.


  • No labels