Vytvoření doplňku

Po přihlášení do vašeho partnerského účtu (ten získáte po podepsání smlouvy o spolupráci), máte možnost vytvořit vlastní doplněk. Pokud vidíte pouze stránku s políčky pro vyplnění kontaktních údajů bez záložky „Doplňky“, je nutné údaje vyplnit a odeslat ke schválení, teprve poté uvidíte možnost vytvoření doplňku.

Po vytvoření doplňku vybíráte oblast, do které dolněk spadá (povinný údaj). Zároveň vyplníte vaši adresu pro získání Ouath kódů a můžete zadat URL adresu pro ověření uživatele a následně vše uložíte. Adresy pro Oauth a ověření lze doplnit/upravit i později při editaci doplňku.

Po uložení doplňku se v jeho detailu objeví další záložky včetně té s názvem Endpointy. V té si můžete navolit, jaká data budete chtít od e-shopu získávat, popř. měnit či nahrávat. Ve stejné záložce jsou pak k dispozici i webhooky.
Není cílem rovnou si naklikat všechny endpointy, ale nastavit opravdu jen ty, které budete potřebovat. Zároveň informace o tom, které endpointy doplněk partnera požaduje, vidí i přímo samotný zákazník.

V případě, že doplněk testujete pouze v rámci svého rozhraní, není nutné při změně endpointů žádat o jakákoliv schvalování. Ve chvíli, kdy se rozhodnete pro veřejný test svého doplňku, je nutné odeslat doplněk ke schválení. Jakmile jej Shoptet schválí, bude možné jej nainstalovat (doplněk nebude vidět v seznamu doplňku, bude přístupný pouze přes URL, kterou uvidíte v jeho detailu). Jakmile je doplněk schválený, bude nutné u každé změny endpointů/rozšiřování práv žádat o schválení těchto změn.

Rozšiřování práv

Ohledně práv a přidávání endpointů. Partner – vývojář dostane de facto neomezený přístup k datům eshopu. To je samozřejmě klíčový fakt a cítíme se povinni eshopaře o tomto faktu informovat před instalací na stránce doplňku (a i sami kontrolujeme, že doplněk žádá jen práva, která potřebuje). Vy máte v tomto směru velkou důvěru naší i eshopaře. Pokud např. s novou verzí doplňku zjistíte, že potřebujete další endpoint (přístup k dalším datům), musíme ho nejdříve schválit my a pak musí o tomto rozšíření práv být eshopař informován a schválit ho (protože tím rozšiřujeme „datový kontrakt“ oproti stavu v okamžiku instalace). Prakticky to vypadá tak, že v administraci eshopu je eshopař informován, že doplněk žádá rozšíření práv a je nabádán k tomu, aby je přijal.

Změna práv zahrnuje:
– přidání nového endpointu
– změna čtecího endpointu na zapisovací
– případně zrušení endpointu či změna ze zapisovacího na čtecí

Musíte však počítat i se stavem, kdy eshopař ještě nepotvrdil nová práva a API na volání endpointu vrací „nepovolený přístup“. Je důležité tuto změnu dobře komunikovat v popisu doplňku a „release notes“ doplňku, aby eshopař další práva nevnímal jako útok na své soukromí, ale rozuměl jejich potřebě pro rozšířenou funkcionalitu. Eshopař musí vždycky přijmout všechna práva (při instalaci nebo rozšíření práv), nedáváme mu možnost si mezi nimi vybírat.

Během vývoje je bohužel potřeba podstupovat stejnou proceduru pro váš eshop – to bychom chtěli do budoucna učinit přímočařejší, zatím to prosím vydržte.

Nově nainstalovaný doplněk získává rovnou všechna aktuálně vyžadovaná práva.

Facebook
Twitter