Doplnky - Vývoj doplnku (technická dokumentácia)

Rozcestník:

• Vytváření a správa doplňku
  • Vývoj doplňku (technická dokumentace)
    • Aktivace doplňku
    • Deaktivace doplňku
    • Otevření doplňku
    • Testování doplňku
    • Verzování doplňku (změna fungování)
  • API dokumentace (jak propojit produkty, kategorie, objednávky, atd.)
  • Best Practices
    • Obecné pravidla
    • Aktivace doplňku
    • Otevření doplňku
    • Fungování doplňku
    • Typy jednotlivých doplňků
  • 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.

Dokumentace API

V sekci Dokementace najdete prokliky na nejduležitější části vývoje doplňku. Odkaz na kompletní sekci Pro vývojáře, Grafický náhled všech používaných prvků a Discord developer forum.

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é.
• 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

Součásti sekce API nastavení je i sekce 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.

Podepisování

Data podepisujeme privátním klíčem a vy si je můžete zkontrolovat veřejným klíčem metodou OPENSSL_ALGO_SHA256. Podpis můžete nalézt v každém těle požadavku pod klíčem signature. Dle požadavků se podepisují příslušná data.

• Z podepisovaných dat je vyjmut current_admin_language.
• Jednotlivá podepisovaná data naleznete u každého endpointu.
• Doporučujeme vždy načítat aktuální veřejný klíč při ověřování podpisu a neukládat jej u sebe pro pozdější použití. Důvodem je možnost změny klíčů.

Příklad ověření podpisu v PHP

$data = implode(";",[...]);
$signature = 'a0e0a3e7689bd4c80e4d6ffcccb05235b864e1d0';
$signaturePublicKey = file_get_contents("https://files.upgates.com/addons/signature/api.signature.pub.key");
$verify = openssl_verify($data, base64_decode($signature), $signaturePublicKey, OPENSSL_ALGO_SHA256);
        

Best practices

• Best practices pro základní využívání API.

Best practices pro fungování doplňků:

Obecné

• 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.
• 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.
• Dbát při implementaci na nepřetěžování serveru(využívat webhooky) - porušení může způsobit blokaci API přístupů doplňku na všechny eshopy.
• 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.

Aktivace doplňku

Založení účtu

• Pro založení nebo spárování účtu můžete využít /owner
• Založení účtu doporučujeme finalizovat v iframe okně v administraci například tlačítky "Stávající zákazník", "Nový zákazník s emailem /owner", "Nový zákazník".
  (Je to tak z důvodu, že uživatel může mít více ownerů dle jazyků, a vy můžete spravovat mutace / domény v 1 účtu a nevíte na jaký finálně založit účet).
• Jakmile získáte informace z owner, založte zákazníkovi účet tak, aby se dostal rovnou do vašeho prostředí. Nevyžadujte po zákazníkovi dodatečné kopírování ověřovacích kódů z e-mailů 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

• Zpracování dat / Dodatečná finalizace aktivace propojení
• Pokud aktivace doplňku u vás podléhá nějakému zpracování, je nutné uvést do iframe doplňku přesný odkrokovaný proces zpracování žádosti a postupně měnit aktuální stav tak, aby zákazník vždy věděl, v jakém stavu je jeho zpracování aktivace. Zároveň také musí být uveden telefon a email na vaší společnost, aby se zákazník na vás mohl obrátit.

Fungování doplňku

• Orders
  • Orders GET
    • Pokud potřebujete mít ve svém doplňku tlačítko na stahování aktuálních objednávek, myslete nejdříve na 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.
• Webhooks
  • 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.

Typy jednotlivých doplňků

V tomto odstravci 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.