Dokumentacja integracji PrestaShop z allegro v5.0

Pełna dokumentacja w trakcie przygotowywania.
Ostatnia aktualizacja 28 Lipiec 2019

Informacje ogólne

Dokumentacja integracji z allegro dla PrestaShop - wersja 5.x.

Obsługiwane wersje:
  • PrestaShop 1.6x
  • PrestaShop 1.7x

Wymagania

Moduł wymaga do swojego działania wersji PHP przynajmniej 5.6 (zalecana 7.1).

Instalacja modułu

Aby zainstalować moduł zaloguj się do panelu administracyjnego PrestaShop i przejdź do zakładki Moduły i usługi. Następnie kliknij przycisk Dodaj nowy moduł (na górze strony). Pojawi się formularz przesyłania pliku, wybierz plik *.zip z modułem i kliknij Prześlij moduł.

Po przesłaniu pliku moduł powinien pojawić się na liście modułów. Jeśli tak się nie stanie sprawdź filtry Zainstalowane i niezainstalowane, Aktywne i nieaktywne, Autorzy. Jeśli mimo to modułu nie ma na liście możesz rozpakować plik *.zip i umieścić go ręcznie na FTP w katalogu modules (struktura powinna wyglądać następująco /modules/allegro/allegro.php).

Aby zainstalować moduł kliknij przycisk Instaluj na liście obok modułu.

Może pojawić się ostrzeżenie:

Czy chcesz zainstalować ten moduł, który nie mógł być zweryfikowany przez PrestaShop?

Kliknij Kontynuuj instalację po czym zostaniesz przeniesiony do konfiguracji modułu. Jeśli tak się nie stanie odśwież stronę i przejdź do konfiguracji modułu.

Aktualizacja modułu

Ważne jest aby zawsze korzystać z aktualnej wersji aplikacji. Informacje o nowych wydaniach powinny pojawić się w module automatycznie na stronie listy produktów.

Przed aktualizacją zalecamy wykonanie pełnej kopii bezpieczeństwa plików oraz bazy danych.

Aktualizacja

Proces aktualizacji w ramach wersji 4.x czyli najnowszej jest bardzo prosty i polega jedynie na przesłaniu nowej wersji na serwer przy pomocy panelu PrestaShop lub opcjonalnie ręcznie przez FTP.

Aby tego dokonać zaloguj się do panelu administracyjnego PrestaShop i przejdź do zakładki Moduły i usługi. Następnie kliknij przycisk Dodaj nowy moduł (na górze strony).

Pojawi się formularz przesyłania pliku, wybierz plik *.zip z modułem i kliknij Prześlij moduł.

Po przesłaniu modułu masz już aktualną wersję, aby się upewnić sprawdź na liście modułów jaka wersja widnieje obok modułu allegro.

Nie odinstalowywuj modułu, proces aktualizacji nie wymaga tego - jeśli odinstalujesz moduł utracisz wszystkie zapisane dane.

Jeśli aktualizujesz moduł z wersji 4.x zapoznaj się najpierw z informacją o migracji z wersji 4.x.

Rejestracja aplikacji & konfiguracja API

Środowisko produkcyjne

Moduł korzysta z nowej wersji (REST) API dlatego przed rozpoczęciem działania konieczna jest dodatkowa rejestracja aplikacji na stronie allegro.

Aby zarejestrować aplikację przejdź na stronę: https://apps.developer.allegro.pl/ a następnie po zalogowaniu się na swoje konto allegro będzie dostępny formularz rejestracji.

Opis aplikacji - dowolna nazwa np. nazwa sklepu.

Adres aplikacji - Adres URL pod którym instalujesz moduł, domena sklepu. Bardzo ważne aby podać właściwy adres - bez tego aplikacja nie będzie działać poprawnie (np.: "https://example.com").

Musimy podać domenę z "www" jeśli taką mamy oraz https jeśli korzystamy z SSL, tylko z podanej domeny będziemy mogli korzystać z modułu nawet jeśli korzystamy z multistore i posiadamy kilka domen..

Po rejestracji otrzymasz 3 klucze: Client ID oraz Client Secret które musisz wprowadzić w konfiguracji modułu.

Po wprowadzeniu w konfiguracji moduł allegro w panelu sklepu PrestaShop i zapisaniu formularza w menu panelu administracyjnego sklepu pojawi się dodatkowa zakładka Allegro.

Szablony aukcji

Aby w pełni wykorzystać możliwości tworzenia opisu oferty w allegro moduł udostępnia funkcję tworzenia szablonów oferty.

Aby dodać własny szablon przejdź do zakładki Allegro > Szablony. Na tej stronie możesz zarządzać i tworzyć nowe szablony aukcji.

Edytor szablonów działa w sposób zbliżony do edytora w panelu allegro, możesz dodawać sekcje i kolumny a w nich umieszczać zdjęcia produktów, treść statyczną oraz specjalne znaczniki które podczas tworzenia oferty zostaną zastąpione przez właściwą treść.

Poniżej znajduje się tabela dostępnych znaczników które możesz umieścić w swoim szablonie:

ZnacznikOpis
[offer_name]Wyświetla tytuł aukcji - jeśli nie wpiszemy własnej frazy będzie to nazwa produktu - jeśli wprowadzimy będzie to właśnie wprowadzona i zapisana wartość.
[offer_price]Cena “Kup teraz” oferty.
[product_description]Pełny opis produktu z katalogu.
[product_description_short]Krótki opis produktu.
[product_ean13]Kod EAN produktu.
[product_weight]Waga produktu z jednostką “gr” lub “kg”.
[product_reference]Kod produktu / kombinacji.
[product_features]Lista cech produktu.
[product_attributes]Lista nazw atrybutów produktu np. " XL, zielony ".
[product_attributes_full]Lista nazw atrybutów produktu np. "Rozmiar - XL, Kolor - zielony".
[product_attributes_list]Lista atrybutów produktu w formie listy HTML nieuporządkowanej ul.
[manufacturer_id]Identyfikator producenta produktu.
[manufacturer_name]Nazwa producenta produktu.
[product_id]Identyfikator produktu w sklepie.
[product_attribute_id]Identyfikator kombinacji atrybutu.

Nowy format tworzenia opisów aukcji

  • Dopuszczalne są tylko wybrane znaczniki HTML: h1, h2, p, ul, ol, li b. Moduł próbuje oczyścić szablon z wszystkich innych znaczników przed wystawieniem aukcji (również w przypadku treści ładowanych przez znaczniki jak [product_description]).
  • Puste sekcje zostaną automatycznie usunięte

Częste problemy

Unprocessable Entity / Błąd podczas tworzenia oferty, sprawdź poprawność parametrów lub/i spróbuj ponownie za kilka minut

Problem najczęściej jest spowodowany aktualizacją oferty tuż po wystawieniu (jeśli występuje chwilowo) lub błędnymi parametrami oferty (np. ujemna ilość lub błędny kod HTML opisu).

Jeśli parametry produktu są poprawne a błąd mimo to występuje należy w preferencjach modułu w łączyć opcję Tryb debugowania a następnie po występieniu błędu pobrać plik z logiem: /modules/allegro/log/dump.json i przesłać na adres email mail@addonspresta.com w celu weryfikacji.


Biała strona zakładkach modułu lub w konfiguracji

Problem najczęściej jest spowodowany wersją PHP niższą niż wymagana, nietypową konfiguracją serwera lub konfliktem z innymi modułami / modyfikacjami.

W takim wypadku należy włączyć tryb debugowania PrestaShop (DEV_MODE), na stronie powinien być widoczny błąd PHP który należy przesłać na adres email mail@addonspresta.com.