Doplňky - Vývoj doplňku (technická dokumentace)

Rozcestník:

• Vytváření a správa doplňků
  • Vývoj doplňku (technická dokumentace)
    • Aktivace doplňku
    • Deaktivace doplňku
    • Otevření doplňku
  • API dokumentace (jak propojit produkty, kategorie, objednávky, atd.)
  • 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.
Dokumentace API, která vás nasměruje obecně na tuto dokumentaci a API nastavení.

Nejdůležitější sekce pro vás a váš doplněk je sekce API nastavení:
- V této podsekci najdete část s endpointy a API přístupy.

Enpointy

Tyto endpointy musíte vytvořit na své straně a z naší strany na ně budou chodit požadavky.

• Endpointy musí být veřejně dostupné.
• Vyžadujeme SSL certifikát na všech API endpointech.

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ělě 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ěď.

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 nalezenete 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íčů.

Testování

Během žádosti o implementaci doplňku v administraci jste vyplňovali testovací projekt/e-shop. V případě schválení techniky Upgates bude možné vidět váš doplněk pouze v administraci tohoto konkrétního projektu, v seznamu doplňků. Budete mít možnost si jej aktivovat, deaktivovat a případně zobrazit/přejít na jeho detail.

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 stiknout 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číky "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 hned získal přihlašovací údaje do svého účtu ve vašem prostředí a měl tak možnost se odhlásit a přihlásit kdykoli bude potřebovat.
• 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.

Sestavení 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.

FAQ

Často kladené otázky.

Chci pracovat s informacemi o aktuálně přihlášeném uživateli při otevření doplňku?

Bude možné využít nový endpoint pro stažení informací o uživatelích, na kterém aktuálně pracujeme. V endpointu pro otevření doplňku přibude informace s indentifikátorem uživatele. Je nutno vyžádat si a zdůvodnit si přístup pro tento nový endpoint při žádosti o založení doplňků.