EdeeShop modul

Modul EdeeShop je součástí platformy Edee.one a poskytuje kompletní logiku pro provoz e-shopu -- produkty, objednávky, košík, uživatelé a další. Funkční specifikace je k dispozici zde.

Zkopírovat odkaz na sekciPřehled dokumentace

Pro vyhledávání v dokumentaci je možné využít projekt Jolanda.

Oblast	Popis	Odkaz
Začínáme	Instalace a první kroky	Začínáme
Architektura	Datový model, publikační proces	Architektura
Rozšíření	Katalog, objednávky, zákazník, slevy, exporty, integrace	Rozšíření
Další nastavení	Profily katalogů, mailing, audit	Další nastavení
REST API	Backend a frontend API	REST API
Projektové úpravy	Rozšíření a customizace modulu	Projektové úpravy
Integrační testy	Podpora pro integrační testy	Integrační testy
Reference	Konvence, oprávnění, lokalizace	Reference
Návody a postupy	Praktické návody pro práci s modulem	Návody a postupy

Zkopírovat odkaz na sekciZačínáme

Následující kroky popisují, jak nainstalovat modul EdeeShop do projektu. Instalace samotné platformy Edee.one je k dispozici zde.

Zapnout modul obnáší následující kroky:

Inicializace projektu - vytvoření nového projektu, jako vzor či inspiraci lze použít skeleton.
Závislost na EdeeShop modulu - přidat/upravit závislost na modulu EdeeShop v projektovém pom.xml, například:
xml
```
1 <dependency>2    <groupId>com.fg.cps.eshop</groupId>3    <artifactId>lib_eshop</artifactId>4    <version>${eshop.version}</version>5    <type>pom</type>6</dependency>
```
Přehled verzí modulu EdeeShop naleznete zde. Obsahuje informace o změnách, novinkách a kompatibilitě s ostatními moduly.
Konfigurace modulu - konfigurace EdeeShop modulu je popsána zde.

Zkopírovat odkaz na sekciArchitektura

Zkopírovat odkaz na sekciDatový model

Modul EdeeShop pracuje s dvěma typy dat: primární a publikovaná data. Rozdíl mezi těmito daty je, kde jsou uložena a jaké je jejich určení.

Primární data jsou data, která jsou uložena v databázi a jsou určena pro definici a správu dat v rámci modulu EdeeShop. Jedná se o veškeré informace o produktech, kategoriích, objednávkách, uživatelích atd., se kterými modul pracuje.

Tato data je možné spravovat pomocí administrace modulu EdeeShop, nebo pomocí API.

Publikovaná data jsou vytvářena pomocí publikačního procesu z primárních dat, při kterém se vybraná primární data transformují do podoby optimalizované pro zobrazení a práci na webu.

Jedná se o data, která jsou zobrazena na webu e-shopu, jako například produkty, kategorie, parametry atd. nebo data, která jsou potřeba pro rychlou a efektivní práci na webu, jako například vyhledávání nebo nákupní proces.

Tedy s publikovanými daty by se mělo pracovat vždy, pokud se jedná o zobrazení nebo práci s daty na webu.

Tato data jsou uložena v EvitaDb.

Data, která jsou publikována:

E-shop entity, jejichž výčet je definován typem CatalogEntityType. Tyto entity implementují rozhraní EdeeShopEntity.
Edee štítky

Zkopírovat odkaz na sekciPublikační proces

Popis publikačního procesu bude doplněn ve verzi v11.

Zkopírovat odkaz na sekciRozšíření (features)

Modul EdeeShop je rozdělen do menších funkčních celků, které se nazývají features (rozšíření). Každé rozšíření obsahuje logiku pro určitou funkcionalitu, například pro práci s produkty, objednávkami, nebo s košíkem. Některá rozšíření mohou být povinná, ale většinou jsou nepovinná a záleží na konkrétních potřebách daného projektu. Některá rozšíření stačí pouze zapnout, některá vyžadují pokročilejší konfiguraci.

Jak vytvořit nové rozšíření naleznete zde.

Rozšíření označená anotací @Mail umožňují odesílat e-mailové notifikace, více zde.

Zkopírovat odkaz na sekciKatalog

Rozšíření týkající se produktů a jejich zařazení do kategorií, skupin a značek.

Produkt - nastavení produktů, parametrů, skladů a dalších funkcí
Kategorie - zařazení produktů do stromové struktury kategorií
Skupiny - zařazení produktů do skupin
Značky - evidence značky/výrobce u produktu

Zkopírovat odkaz na sekciObjednávky

Rozšíření umožňující vložit produkty z katalogu do nákupního košíku, vytvořit objednávku a následně objednávky spravovat. Konfigurace objednávek je popsána zde.

Nákupní košík - nákupní košík a nákupní proces
Aktualizace košíku - operace pro aktualizaci nákupního košíku
Vytvoření objednávky z košíku - proces vytvoření objednávky
Cenové politiky - popis cenových politik
Modifikace objednávek - úpravy existujících objednávek
Stavy objednávek - životní cyklus objednávky
Číselné řady objednávek - přiřazování čísel objednávkám
Zaokrouhlení - zaokrouhlení částky k úhradě objednávky
Platební metody - správa a konfigurace platebních metod
Dopravy - správa a konfigurace doprav
Faktury - správa a generování faktur
Reklamace - možnosti reklamací
Rezervace na prodejně - rezervace produktů na prodejně

Zkopírovat odkaz na sekciZákazník

Rozšíření související se zákazníky e-shopu.

Uživatel - oprávnění, správa adres, B2B
Uživatelské seznamy - uživatelské seznamy produktů (wishlist, nákupní seznam atd.)
Hlídací pes - hlídání dostupnosti nebo ceny produktu

Zkopírovat odkaz na sekciVěrnostní a slevové programy

Rozšíření věrnostních a slevových programů.

Slevové kódy a dárkové poukazy - podpora pro slevové kupóny a dárkové poukazy
Bonusové produkty - podpora pro bonusové produkty
Kredit - podpora pro kreditní systém

Zkopírovat odkaz na sekciExporty a importy dat

Rozšíření umožňující importovat nebo exportovat data modulu EdeeShop.

CSV import/export - import a export zdrojových dat pomocí souborů CSV
XML feedy - generování feedů např. pro srovnávače
REST API - REST API pro primární i publikovaná data

Zkopírovat odkaz na sekciIntegrace třetích stran

Rozšíření umožňující napojení na systémy třetích stran.

Affiliate - napojení na affiliate programy
Balíkobot - napojení na Balíkobot
Facebook - napojení na Facebook Conversion API
GTM - napojení na Google Analytics
Heuréka.cz - napojení na Heuréka.cz
Zboží.cz - napojení na Zboží.cz

Zkopírovat odkaz na sekciDalší nastavení

Propojení obsahových bloků a entit e-shopu
Specifická konfigurace pro konkrétní katalog
Profily katalogů
Mailing - konfigurace e-mailových notifikací
Audit - konfigurace auditu
Bankovní kódy - číselník bankovních kódů ČNB

Zkopírovat odkaz na sekciREST API

EdeeShop modul poskytuje dvě základní části REST API: backend a frontend. Každá část má své specifické využití a je určena pro různé typy operací.

Zkopírovat odkaz na sekciBackend API

Backend API je určeno především pro práci s primárními daty a slouží ke správě e-shopu, tedy administraci. Pomocí tohoto API lze spravovat produkty, objednávky, uživatele a další entity, které jsou klíčové pro provoz e-shopu. Více informací o backend API naleznete zde.

Zkopírovat odkaz na sekciFrontend API

Frontend API je určeno pro operace, které vykonává zákazník na frontendu e-shopu. Toto API pracuje jak s primárními, tak i s publikovanými daty. Umožňuje například vyhledávání produktů, přidávání položek do košíku, vytváření objednávek a další operace, které jsou nezbytné pro interakci zákazníka s e-shopem. Více informací o frontend API naleznete zde.

Architektura REST API je podrobněji popsána zde.

Některé publikované data nelze získat pomocí REST API, ale pouze přímým dotazem do EvitaDb.

Zkopírovat odkaz na sekciProjektové úpravy

Kompletní přehled možností projektových úprav a rozšíření modulu EdeeShop naleznete zde.

Zkopírovat odkaz na sekciIntegrační testy

Podpora pro integrační testy je popsána zde.

Zkopírovat odkaz na sekciReference

Referenční dokumentace zde.

Zkopírovat odkaz na sekciNávody a postupy

Pro návody a postupy, jak provést určité operace v modulu EdeeShop použijte https://q2a.fg.cz/e-shop.

REST APIDalší