Dokumentace

Základní informace o API

Základní informace o našem API – je RESTové, komunikujeme ve formátu JSON a pro autorizaci je potřeba v hlavičce uvádět přístupový API Access token. Není volně dostupné, jeho použití je možné pouze prostřednictvím doplňků.

Přejít na článek

Vytvoření doplňku

První krok k vytvoření doplňku je jeho zadání přes GUI ve vaší sekci API Partner. Zde zadáte popisky a obrázky, stejně jako různá nastavení včetně přístupových práv. Při schvalování doplňku budete spolupracovat s naším Partner Managerem, který vám poradí a doplněk bude schvalovat.

Přejít na článek

Instalace doplňku

Jediná cesta pro uživatele, jak nainstalovat doplněk, je v marketplace doplnky.shoptet.cz. Instalace probíhá online a uživatel okamžitě vidí výsledek. Vývojář doplňku musí napsat instalační rutinu, která instalaci realizuje a získá Access Token pro přístup k API.

Přejít na článek

Získání API access tokenu

Z důvodů bezpečnosti se pro volání API používají dočasné tokeny, jejichž platnost je 30 minut. Před prvním voláním a po vypršení platnosti je potřeba vyžádat si nový.

Přejít na článek

Kódy do šablon

Shoptet i jeho API umožňuje vložit vlastní HTML do kódu šablon na předem definovaná místa. Mezi typická využití této možnosti patří vlastní grafické úpravy, marketingové a měřící kódy.

Přejít na článek

Webhooky

Webhooky jsou volání vývojářem zadaného URL pomocí HTTPS protokolu v okamžiku, kdy v eshopu nastane určitá událost, například vznik nové objednávky.

Přejít na článek

Zobrazení nastavení doplňku v administraci Shoptetu

Návod, jak převést stránku s uživatelským nastavením doplňku, přehledy či statistiky k doplňku přímo do administrace Shoptetu formou iframe. E-shopař se k nim dostane přímo z menu svého e-shopu.

Přejít na článek

Vložení objednávky

Endpoint vytvoření objednávky umožní vložit novou objednávku do Shoptetu, zde se dozvíte podrobnosti ohledně této užitečné funkce.

Přejít na článek

Odinstalování doplňku

Uživatel se může rozhodnout, že doplněk již nebude používat, a v administraci eshopu ho odinstaluje, popř. ukončí celý eshop. Pravděpodobně na to musíte zareagovat a deaktivovat účet a procesy tohoto uživatele i na své straně.

Přejít na článek

Ověření eshopu pomocí OAuth

Pokud potřebujete ukládat nastavení pro jednotlivé instalace doplňku, lze pro identifikaci administrátorů eshopu použít Shoptet OAuth server. Nemusíte pak řešit hesla uživatele a eshopaři umožníte používat stejné přihlašovací údaje.

Přejít na článek

Platební brány

Implementace platební brány je specifický proces, který využívá více funkcí API a propojení s Shoptetem v oblastní platebních metod a procesu objednávky. Tento článek provede všemy kroky, které jsou k implementaci platební brány zapotřebí.

Přejít na článek

Správné využívání API

Tipy jak šetrně přistupovat a využívat zdroje Shoptet API.

Přejít na článek

Shoptet API Starter’s guide

Připravit doplněk po technické stránce je jedna věc. Odprezentovat ho správně našim klientům druhá. A i s tou vám pomůžeme.

Přejít na článek
Facebook
Twitter