Odinstalování doplňku

Uživatel se může rozhodnout, že doplněk již nebude používat, a v administraci eshopu ho odinstaluje. Případně může ukončit provoz eshopu a k odinstalaci dojde spolu s ukončením eshopu.

Jako vývojář to poznáte 3 způsoby:
1. OAuth access token bude označen za neplatný a nebude možné vyžádat nové API access tokeny. Volání API budou odmítnuty.
2. Majiteli eshopu posíláme email o odinstalaci.
3. Prostřednictvým odinstalačního webhooku (detailně viz níže)

Na odinstalaci pravděpodobně musíte ve svém systému reagovat deaktivací daného uživatele (eshopu), abyste API nevolali s neplatným tokenem.

Dále je potřeba mít na zřeteli, že eshopař může změnit názor a doplněk nainstalovat znovu – bez ošetření by mohlo dojít při druhé instalaci k problémům s duplicitou účtu.

Odinstalační webhook

S webhooky jste se již možná setkali na samostatné stránce, která se věnuje webhookům eshopů. Koncept systémového odinstalačního webhooku je stejný. Cílem je volat vámi zaregistrovanou URL pomocí HTTPS protokolu v okamžiku odinstalace doplňku na konkrétním eshopu.

Pokud se rozhodnete používat odinstalační webhook, nejdříve je nutné zaregistrovat URL na kterou budou doručována oznámení o provedených odinstalacích doplňku. V nastavení doplňku (Administrace partnerského eshopu → Propojení → API partner → Záložka doplňky) vyplňte URL adresu webhooku pro získání notifikace o odinstalaci, např.: https://myapplication.tld/uninstall.php

Od této chvíle, kdykoliv jakýkoliv eshop odinstaluje váš doplněk nebo eshop zanikne, Shoptet vyvolá URL https://myapplication.tld/uninstall.php jako POST s následujícím obsahem:

{
    "eshopId": 222651,
    "event": "addon:uninstall",
    "eventCreated": "2019-01-08T15:13:39+0100",
    "eventInstance": "222651"
}

Oznámení o vzniklé události obsahuje identifikaci obchodu (eshopId), typ události (addon:uninstall = odinstalce doplňku), čas vzniku a dotčenou instanci (eventInstance) – kterou představuje opět identifikace eshopu (např. 222651).

Zaslané oznámení na URL webhooku musí být webhookem potvrzeno HTTP kódem 200. V opačném případě budeme oznámení opakovaně zasílat po 15 minutách ještě 2x (celkem max. 3 pokusy). Po nepotvrzeném posledním oznámení označíme oznámení jako neaktivní a Shoptet již nebude provádět další pokusy o doručení.

Realizovaná oznámení jsou Shoptetem interně logovaná, ale autor doplňku momentálně nemá možnost do logu nahlížet.

Systémový odinstalační webhook podporuje stejný mechanismus podepisování webhooků pomocí podpisového klíče. Měl-li eshop vygenerovaný podpisový klíč, bude webhook opatřen hlavičkou Shoptet-Webhook-Signature.

Facebook
Twitter