Doplňky - Vývoj doplňku (technická dokumentace)
Rozcestník:
- Vytváření a správa doplňku
- Vývoj doplňku
- API dokumentace (jak propojit produkty, kategorie, objednávky, atd.)
- Pravidla a Best Practices
- Webhooky
- Discord Developer forum (Chcete vědět co se chystá, anebo jen potřebujete poradit?)
Vývoj doplňku
Vývojová část doplňku (záložka Vývoj doplňku) slouží pro napojení doplňku do Upgates administrace a je rozdělena na dvě sekce.
TIP! Než začnete doplněk vytvářet, ikdyž jste prošli úvodní online konzultací, neváhejte hned ze startu založit ticket z vašeho vývojového projektu (případně napište na Discord) a proberme krok za krokem jak by se měl doplněk chovat od aktivace, přes běžný provoz až po speciální případy jako například co dělat s doplňkem, když klient přestave vaši službu platit. Raději vždy pomůžeme v průběhu vývoje samotného doplňku, než abychom narazili na překážky ve schválení doplňku až při samotném testování.
ENDPOINTY
Sekce Endpointy se skládá ze dvou částí API nastavení a API přístupy.
Pozor! Pro správné fungování doplňku (aktivaci) je nutné vyplnit obě tyto sekce.
API nastavení
V sekci API nastavení najdete endpointy, které musíte na své straně vytvořit. Z naší strany na ně budou chodit požadavky týkající se funkce doplňku.
Endpointy musí být veřejně dostupné a vyžadujeme SSL certifikát na všech API endpointech.

(screen z Marketplace / Moje doplňky - Váš doplněk - Vývoj doplňku)
- Instalační endpoint: Slouží při aktivaci doplňku ze strany klienta.
- Otevírací endpoint: Slouží pro otevření Iframe části doplňku. Z naší strany posíláme informaci Klient X, s tokenem Y chce otevřít váš doplněk. Z vaší strany vracíte v těle požadavku adresu daného iframu.
- Odinstalační endpoint: Slouží při při deaktivaci doplňku. Z naší strany posíláme informaci, že klient doplněk deaktivoval a mažou se API přístupy. Není zapotřebí vaše odpověď.
- Verzovácí endpoint: Slouží k případům kdy zákazník bude přecházet na novou verzi doplňu, na tuto adresu se následně zasílá informace na jakou verzi přechází, abyste mu mohli vrátit správné informace například do iframu / založit konverzní kód, atd.
- Signature_token: Jedinečný identifikátor k vašemu doplňku, sloužící k sestavení podpisu (viz Aktivace, Otevření, Změna verze a Deaktivace)
API přístupy
Tyto API přístupy je nutné navolit podle toho, jak váš doplněk pracuje.
Například: Pokud potřebujete stahovat objednávky, založíte Typ přístupu Objednávky, část GET Objednávky, a nastavíte frekvenci v jaké budete GET provolávat.
Popis účelu využití API přístupu: Slouží pro nás jako informace o tom, proč API přístup potřebujete a jakou u vás plní funkci.
Frekvence volání: slouží při automatické kontrole vašeho doplňku. Automatická kontrola vyhodnocuje zda-li se váš doplněk drží v nastavených mezích. Tato kontrola je pro nás důležitá, aby pravidelně nebylo přetěžováno API a nefunguje jinak, než způsobem, který jsme si řekli v konzultaci, anebo při testování z naší strany.
Pozor! Dbejte prosím na správný a detailní popis frekvence provolávání a popisu účelu proč daný API přístup zakládáte.

Pravidla a Best practices
Základním cílem ověřeného doplňku je přinést klientům co největší automatizaci v propojení bez zbytečných klikání a vyplňování formulářů.
Využívejte vždy aktuální loga Upgates.
Obecné
- Doplněk funguje díky komunikaci přes API. Základní BestPractices v používání API najdete zde.
- V případě práce s API více e-shopů na jednom serveru je potřeba vytížení rozdělit časově během celého dne, a nestahovat data např. pouze během noci nebo v 00:00 apod.
- Např. si rozdělit pool e-shopů a přidávat offsety po hodinách nebo jiných větších časových úsecích:
- 2 e-shopy v 00:00
- 2 e-shopy v 01:00
atd.
- Např. si rozdělit pool e-shopů a přidávat offsety po hodinách nebo jiných větších časových úsecích:
- Brát v úvahu, že Upgates umožňuje multijazyčnost a multidoménovost.
- Co to pro vás znamená?
Je zapotřebí se připravit na to, že produkty, kategorie, články, a další sekce jsou ve více jazycích pod více doménami, ale pouze pod jednou administrací.
Tedy například produkt "Tričko" může být v jazyce CZ, SK, EN, může mít pro každou mutaci vlastní doménu, ale stále bude v jedné administraci pod jedním jedinečným ID.
Dále může být produkt "Bunda", který bude v jazyce pouze SK, ale stále bude spadat pod tu jednu samou administraci jako produkt "Tričko". - Pokud řešíte multijazyčnost u produkt, kategorií atd. Stahujte je jako celek (bez omezení URL na jazyky).
Rozdělení na samotné jazyky vyřešte až na své straně. Stahování konkrétních jazyků byste měli využít například v moment, kdy řešíte věc týkající se konkrétní jazykové mutace. Například reakci na webhook languages.create - kdy vzniká nová jazyková mutace.
- Co to pro vás znamená?
- Využívejte webhooky - Porušení může způsobit neschválení doplňku, popřípadě pozdější blokaci pokud je zjištěno automatickou kontrolou.
- Testování doplňku:
- Hlavním atributem při testování doplňků z vaší strany, by měla být uživatelská přívětivost. Než nám doplněk předáte k testování, prosím ověřte si, že dokážete váš doplněk obsluhovat jako běžný zákazník (správně se vytvoří uživatelský účet, funguje odhlášení a opětovné přihlášení do vašeho prostředí, atd.). Ulehčí se tím celkový proces schvalování doplňku.
- Hlavním cílem při kontrole z naší strany vašeho doplňku, bude zajistit co nejlepší používání API.
- Nepoužívejte tlačítko "Synchronizovat". Pokud jej pro fungování opravdu potřebujete, nastavte u něj ochranu opakovaného klikání, a také aby nebylo možné tlačítko stisknout znovu, pokud běží ještě původní proces synchronizace.
- Plánované úlohy provažte s webhooky. Není nutné každý den stahovat všechny objednávky, zvláště v případě, kdy nevznikla žádná nová objednávky / neproběhla žádná změna.
- Více o tomto tématu v naší nápovědě.
Aktivace doplňku
- Při návrhu doplňku byste měli počítat s tím, že z naší strany, i když ne přímo cíleně, může přijít více požadavku na aktivaci, již aktivovaného doplňku nebo také požadavek na deaktivaci, aktuálně neaktivního doplňku.
- Aktivaci (popřípadě následnou registraci) je možné brát jako již ověřenou (autorizovanou). Provádí jí totiž vždy uživatel v Upgates.
Založení účtu
- Pro založení nebo spárování účtu můžete využít
/owner. - Založení účtu plně automatizujte. Nevyžadujte po klientovi vyplnění speciálního formuláře na vašich stránkách. Klient je ověřen z naší strany, tedy registraci přímo u vás je možné realizovat, bez zbytečných průtahů.
- Pokud z /owner a dalších endpointů nezískáte všechny potřebné údaje pro registraci vyřešte pomocí iframe okna.
- Jakmile získáte informace z owner, založte zákazníkovi účet tak, aby se dostal rovnou do vašeho prostředí bez zbytečných průtahů. Nevyžadujte po zákazníkovi dodatečné kopírování ověřovacích kódů z e-mailů, kopírování propojovacích tokenů, atd..
- Pokud vaše prostředí vyžaduje uvést, že účet je propojen s danou platformou Upgates, musí se tak stát během zakládání účtu. Nevyžadujte po zákazníkovi dodatečnou aktivaci propojení na své straně.
- Uživatel nesmí mít přístup k API přístupovým údajům, které se vám přes doplněk zasílají. Tyto komunikační údaje slouží jenom pro vás a klient by je neměl mít možnost nijak zjistit a dále používat.
Otevření doplňku
- Řídí se pravidly používání iframe doplňku.
- Pokud vše v rámci spárování stávajícího zákazníka a registrace nevého probíhá automaticky, není nutné iframe používat.
- (Doporučujeme) Přes iframe můžete poskytnout nastavení vaší aplikace klientovi tak, aby vůbec nemusel opustit administraci Upgates a bylo tak pro něj vše komfortnější a rychlejší.
Fungování doplňku
- Tlačítko Synchronizovat / Aktualizovat
Pokud potřebujete mít ve svém doplňku tlačítko na stahování aktuálních dat (například objednávek), myslete nejdříve na povinnost mít webhooky. Pokud dané tlačítko musí být skutečně uvedeno, doporučujeme jej nastavit tak, aby nebylo možné používat opakovaně během pár sekund. Použití musí být podmíněno minimálně vždy tak, aby se dalo aktivovat až po dokončení předchozího stahování + například nějaký interval.
Pokud před X sekundami proběhlo stažení změn, nemělo by tlačítko pro aktualizaci provolávat znovu API. - Webhooky (dokumentace zde)
- Webhooky nesmí jít ve vašem prostředí uživatelsky obejít!
- Pokud zákazníkovi nabízíte možnost nastavení synchronizace opakovaně například v řádech jednotek minut. Musí se tyto časové spouštěče provádět na vaší straně a kontrolovat, zda-li během tohoto intervalu nedorazila notifikace z webhooku. Není možné provolávat jednotlivé sekce například co minutu a obcházet takto webhooky.
- Myslete i na neplatícího klienta
Pokud se klientský účet u vás dostane do stavu, kdy jeho data nezpracováváte, je nutné deaktivovat webhooky v propojení doplňku. V opačném případě, bude projekt zbytečně logovat chyby se špatnou odpovědí na notifikaci z webhooku.
Typy jednotlivých doplňků
V tomto odstavci se pokusíme popsat základní očekávané využití API a fungování jednotlivých typů doplňků. Pokud zde nenajdete popis svého doplňku, neváhejte nás informovat a společně můžeme ideální stav fungování doplňku probrat na online schůzce.
Doprava a logistika
Expediční systémy
- API přístupy
- Objednávky
- GET - Možné jednorázové stažení k určitému datu zpětně při aktivaci (stahování přes
?page=), následně reagovat vždy na webhooky (create, update).- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- PUT - Vrácení změny stavu objednávky, trasovacího kódu zásilky (vlastní počet opakování - podle změn v objednávkách na vaší straně)
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní
- Počet opakování: Vlastní
- Nastavení API přístupu v marketplace:
- Stavy objednávek
- GET - Možné jednorázové stažení při aktivaci doplňku, následně reagovat vždy na webhooky
- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- GET - Možné jednorázové stažení při aktivaci doplňku, následně reagovat vždy na webhooky
- GET - Možné jednorázové stažení k určitému datu zpětně při aktivaci (stahování přes
- Produkty
- GET - Pokud pracujete i s produkty možné jednorázové stažení při aktivaci (stahování přes
?page=), následně reagovat vždy na webhooky (create, update).- Nastavení API přístupu v marketplace:
- Frekvence: Jen pnstalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- PUT - Pozor na skladové hospodářství produktů. Objednávky v Upgates automaticky vyskladňují produkty na základě provedené objednávky. Produkty byste tedy neměli opětovně vyskladňovat na základě příchozí objednávky k vám do systému.
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní
- Počet opakování: Vlastní
- Nastavení API přístupu v marketplace:
- GET - Pokud pracujete i s produkty možné jednorázové stažení při aktivaci (stahování přes
- Doprava a platba
- GET - Při aktivaci doplňku by mělo proběhnout jednorázové stažení doprav, které použijete pro párování dopravců. Následně reagovat vždy na webhooky.
- Nastavení API přístupu v marketplace:
- Frekvence: Při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- GET - Při aktivaci doplňku by mělo proběhnout jednorázové stažení doprav, které použijete pro párování dopravců. Následně reagovat vždy na webhooky.
- Majitel (provozovatel e-shopu)
- GET - Při aktivaci doplňku pro spárování / založení účtu ve vašem prostředí
- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci
- Nastavení API přístupu v marketplace:
- GET - Při aktivaci doplňku pro spárování / založení účtu ve vašem prostředí
- Webhooky
- GET - Kontrola před POST (v rámci aktivace / přechodu na novou verzi)
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní / Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Při instalaci doplňku a přechodu na novou verzi
- Nastavení API přístupu v marketplace:
- POST - Založení webhooků na nejdůležitější sekce Objednávky, Produkty, Stavy objednávek, Doprava a Platba
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní / Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Při instalaci doplňku a přechodu na novou verzi
- Nastavení API přístupu v marketplace:
- GET - Kontrola před POST (v rámci aktivace / přechodu na novou verzi)
- Objednávky
- Informace o doplňku - Služby
- V detailu doplňku pro Marketplace musí být napárované pouze takové služby, které jste schopni zákazníkovi v rámci fungování dodat. Je potřeba brát ohled na takové dopravce, které zákazník ve své administraci nedokáže nastavit (například stahování poboček dopravce, kterého Upgates nepodporuje a nelze tedy pro něj stáhnout konkrétní pobočky (FAN Courier)).
Fulfillment
- API přístupy
- Objednávky
- GET - Možné jednorázové stažení k určitému datu zpětně při aktivaci (stahování přes
?page=), následně reagovat vždy na webhooky (create, update).- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- PUT - Vrácení změny stavu objednávky, trasovacího kódu zásilky (vlastní počet opakování - podle změn v objednávkách na vaší straně)
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní
- Počet opakování: Vlastní
- Nastavení API přístupu v marketplace:
- Stavy objednávek
- GET - Možné jednorázové stažení při aktivaci doplňku, následně reagovat vždy na webhooky
- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- GET - Možné jednorázové stažení při aktivaci doplňku, následně reagovat vždy na webhooky
- GET - Možné jednorázové stažení k určitému datu zpětně při aktivaci (stahování přes
- Produkty
- GET - Pokud pracujete i s produkty možné jednorázové stažení při aktivaci (stahování přes
?page=), následně reagovat vždy na webhooky (create, update).- Nastavení API přístupu v marketplace:
- Frekvence: Jen pnstalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- PUT - Pozor na skladové hospodářství produktů. Objednávky v Upgates automaticky vyskladňují produkty na základě provedené objednávky. Produkty byste tedy neměli opětovně vyskladňovat na základě příchozí objednávky k vám do systému.
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní
- Počet opakování: Vlastní
- Nastavení API přístupu v marketplace:
- Parametry a Suvisející
- GET - Stažení parametrů z produktu
- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku (Products.create, Products.update)
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- GET - Stažení parametrů z produktu
- GET - Pokud pracujete i s produkty možné jednorázové stažení při aktivaci (stahování přes
- Doprava a platba
- GET - Při aktivaci doplňku by mělo proběhnout jednorázové stažení doprav, které použijete pro párování dopravců. Následně reagovat vždy na webhooky.
- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- GET - Při aktivaci doplňku by mělo proběhnout jednorázové stažení doprav, které použijete pro párování dopravců. Následně reagovat vždy na webhooky.
- Majitel (provozovatel e-shopu)
- GET - Při aktivaci doplňku pro spárování / založení účtu ve vašem prostředí
- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci
- Nastavení API přístupu v marketplace:
- GET - Při aktivaci doplňku pro spárování / založení účtu ve vašem prostředí
- Webhooky
- GET - Kontrola před POST (v rámci aktivace / přechodu na novou verzi)
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní / Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Při instalaci doplňku a přechodu na novou verzi
- Nastavení API přístupu v marketplace:
- POST - Založení webhooků na nejdůležitější sekce Objednávky, Produkty, Stavy objednávek, Doprava a Platba
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní / Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Při instalaci doplňku a přechodu na novou verzi
- Nastavení API přístupu v marketplace:
- GET - Kontrola před POST (v rámci aktivace / přechodu na novou verzi)
- Objednávky
Komunikace
Emailing
- Obecné
- Mailingové doplňky, musí podporovat oboustrannou synchronizaci kontaktů.
- Nejdůležitějším bodem synchronizace je určitě zda-li zákazník akceptuje newsletter. Pokud o zákazníkovi ukládáte i jiné údaje (jméno, telefon, adresy), je nutné propojit zpětně i tyto údaje.
- Pokud odběratel existuje ve SmartEmailingu, ale není v Upgates, mělo by proběhnout jeho založení do Upgates, aby zbytečně nedocházelo ke zbytečným kolizím v budoucnu.
- Mailingové doplňky, musí podporovat oboustrannou synchronizaci kontaktů.
- API přístupy
- Objednávky
- GET - Možné jednorázové stažení k určitému datu zpětně při aktivaci (stahování přes
?page=), následně reagovat vždy na webhooky (create, update).- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Doporučujeme zahrnout také možnost propojení na hodnocení produktu.
- Nastavení API přístupu v marketplace:
- GET - Možné jednorázové stažení k určitému datu zpětně při aktivaci (stahování přes
- Produkty
- GET - Pokud pracujete i s produkty je vhodnéjednorázové stažení při aktivaci (stahování přes
?page=), následně reagovat vždy na webhooky (create, update).- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- PUT - Pozor na skladové hospodářství produktů. Objednávky v Upgates automaticky vyskladňují produkty na základě provedené objednávky. Produkty byste tedy neměli opětovně vyskladňovat na základě příchozí objednávky k vám do systému.
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní
- Počet opakování: Vlastní
- Nastavení API přístupu v marketplace:
- GET - Pokud pracujete i s produkty je vhodnéjednorázové stažení při aktivaci (stahování přes
- Kategorie
- GET - Pokud pracujete i s kategoriemi je vhodné jednorázové stažení při aktivaci (stahování přes
?page=), následně reagovat vždy na webhooky (create, update).- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- GET - Pokud pracujete i s kategoriemi je vhodné jednorázové stažení při aktivaci (stahování přes
- Zákazníci
- GET - Jednorázové stažení při aktivaci (stahování přes
?page=), následně reagovat vždy na webhooky (create, update).- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Na základě webhooku
- Webhooky: ANO
- Nastavení API přístupu v marketplace:
- PUT - Zpětná synchronizace zákazníka na základě změny ve vašem systému (odhlášení z newsletteru, změna jména, atd.)
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní
- Počet opakování: Vlastní
- Nastavení API přístupu v marketplace:
- GET - Jednorázové stažení při aktivaci (stahování přes
- Konverzní kódy
- GET - Kontrola před POST (v rámci aktivace / přechodu na novou verzi)
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní / Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Při instalaci doplňku a přechodu na novou verzi
- Nastavení API přístupu v marketplace:
- POST - Založení konverzního kódu
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní / Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Při instalaci doplňku a přechodu na novou verzi
- Nastavení API přístupu v marketplace:
- DELETE - Smazání konverzního kódu
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní / Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Při instalaci doplňku a přechodu na novou verzi
- Nastavení API přístupu v marketplace:
- GET - Kontrola před POST (v rámci aktivace / přechodu na novou verzi)
- Slevové kupóny
- GET - Pokud s kupóny pracujete například v email kampaních
- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní / 1x za den (
?active_yn/?date_from+?page)
- Nastavení API přístupu v marketplace:
- POST - Založení Slevového kupónu
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní
- Počet opakování: Vlastní -> Při nastavení blahopřání k svátku, atd. u vás v systému
- Nastavení API přístupu v marketplace:
- DELETE - Smazání Slevového kupónu
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní
- Počet opakování: Vlastní -> Kupóny můžete nechat expirovat, anebo je rovnou smazat
- Nastavení API přístupu v marketplace:
- GET - Pokud s kupóny pracujete například v email kampaních
- Jazyky
- GET - Při aktivaci doplňku pro správné nastavení profilu zákazníka u vás v systému
- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Při reakci na webhook
- Webhook: ANO
- Nastavení API přístupu v marketplace:
- GET - Při aktivaci doplňku pro správné nastavení profilu zákazníka u vás v systému
- Majitel (provozovatel e-shopu)
- GET - Při aktivaci doplňku pro spárování / založení účtu ve vašem prostředí
- Nastavení API přístupu v marketplace:
- Frekvence: Jen při instalaci
- Nastavení API přístupu v marketplace:
- GET - Při aktivaci doplňku pro spárování / založení účtu ve vašem prostředí
- Webhooky
- GET - Kontrola před POST (v rámci aktivace / přechodu na novou verzi)
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní / Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Při instalaci doplňku a přechodu na novou verzi
- Nastavení API přístupu v marketplace:
- POST - Založení webhooků na nejdůležitější sekce Objednávky, Produkty, Jazyky, Doprava a Platba
- Nastavení API přístupu v marketplace:
- Frekvence: Vlastní / Jen při instalaci a vlastní
- Počet opakování: Vlastní -> Při instalaci doplňku a přechodu na novou verzi
- Nastavení API přístupu v marketplace:
- GET - Kontrola před POST (v rámci aktivace / přechodu na novou verzi)
- Objednávky
AI - Umělá inteligence
AI doplňky
Doplňky, které jsou tvořeny přes AI, anebo pro své fungování využívají AI jsou určitě dnešním trendem.
Tyto doplňky však nefungují podle zavedených pravidel (Best Practices) a ikdyž se AI dají jasné příkazy a podmínky, je velmi pravděpodobné, že i přesto bude AI schopeno vymyslet vlastní postup, aby zadaného cíle dostáhlo.
Abychom ochránili uživatelská data sepsali jsme pro vás základní body, které je nutné z vaší strany vyřešit:
- Doplněk by měl výhradně fungovat přes API.
- Doplněk (typicky řešený přes extensions prohlížeče) může pracovat s obsahem stránky stylem udělat například focus, anebo jinak zvýraznit hledanou sekci zákazníkem, ale neměl by sahat "fyzicky" do stránky administrace a měnit data, nebo přepínat nastavení za zákazníka.
- Před úvodní konzultací a před posláním ke schválení je nutné důkladně sepsat jak pro nás tak pro klienty co doplněk je schopen udělat (K čemu všemu má přístup, a co je schopen zajistit: Překlady, vyhledávání, změny stavů objednávek, atd.)
- V budoucnu bude zapotřebí vždy když se přidává nová funkce, kontaktovat naši technickou podporu a informovat nás o tom. I v případě, kdy se neprovádí žádné přidání / změna API endpointů
- Tuto změna musíte zaznamenat v sekci Informace o doplňku a poslat k nám na schválení ještě předtím, než bude funkce nasazena a přístupná běžným klientům.
- Důkladně zajistit optimalizované provolávání API
- Volat seznamy stránkově a neumožnist stahovat všechny produktu jen tak.
- Neumožnit obcházet Best Practices pokynem ze strany zákazníka.
- Doplněk by si při aktivaci měl stáhnout seznam produktů, uložit si jej a následně pracovat s webhooky. Není možné aby doplněk provolával všechny produkty po každém dotazu zákazníka (například prostřednictvím chatu).
- Zajistit ochranu před obecnými poždavky ze strany klienta. (například: Ke každému produktu do názvu přidej jeho výrobce). Doplněk by neměl najednou spustit provolávání 100 000 produktů formou samostatných požadavků, ale udělat sumář a postupovat dle pravidel API.
- Doplněk by měl zajistit cache aktuálního a naposledy probíhajících chatů alespoň v rámci 1 hodiny. Nemělo by tedy docházet k tomu, že v jednom chatu si doplněk stáhne všechny produkty, kategorie, atd., vykonají se požadavky klienta, klient okno zavře a za minutu si vzpomene, že potřebuje ještě něco upravit a tak znovu otevře okno a znovu se stáhnou všechny produkty, kategorie, atd.
- Pokud stále probíhá API komunikace (stále se stahují data, anebo posílájí do Upgates), doplněk by neměl příjmat další příkazy a tvořit tak nekonečnou frontu úkonů.
- Ochrana dat zákazníka
- Doplněk by vždy před každým úkonem měl provést validaci zadaného požadavku ze strany zákazníka a následně uvést viditelně: Co bude přesně dělat, nad kolika produkty (články, kategoriemi, parametry, atd.)
- Doplněk by vždy po této validaci a upozornění se měl zeptat, zda-li to má skutečně provést. Nesmí dojít k tomu, že klient zadá obecný požadavek "změň dopravu DPD za PPL" a místo aby doplněk změnil název dopravy v seznamu doprav, začně měnit všechny objednávky i 10let zpětně protože mají dopravu DPD
- Doplněk by měl odpovídat za zálohu dat, které edituje a maže, a poskytnout možnost vrátit se zpět do stavu, než změny proběhly.
- Doplněk by měl brát v potaz všechny návazné funkce, které Upgates poskytuje. Tedy pokud byť i chybou začne měnit stavy všech objednávek, je potřeba počítat s tím, že se mohou odeslat emaily a SMS zákazníkům. Tedy provedení hromadných úkonů by se němělo dělat automaticky, ale vždy s plným informováním klienta a jeho potvrzením od klienta. Takové rozhodnutí se musí také u vás zalogovat.
- Doplněk by měl být kompatibilní s aktuálními verzemi a nejpoužívanějšími systémy a prohlížeči
- Doplněk musí zajistit informovanost zákazníka a uložení jeho souhlasu s tím, že poskytuje data (své a zákazníků) nejen vaší společnosti, ale také službám 3. stran (OpenAI, atd.), které s daty pracují a zpracovávájí je.
- Při spuštění doplňku musí první krok obsahovat iframe, ve kterém klient odsouhlasí upozornění, že doplněk není nijak spojen se společností Upgates, je plně ve vlastnictví vaší společnosti (vyjmenovat kdo má přístup k datům) a Upgates nenese odpovědnost za změny dat, které na eshopu doplněk udělá ani nevzniká nárok data ze strany Upgates bezplatně vrátit. (včetně zalogování tohoto souhlasu)