Potřebujete propojit svůj e-shop se svým účetním systémem, ERP, dropshippingovou či fulfillmentovou službou nebo jiným nástrojem? Chybí vám nějaký nástroj od partnerů v naší knihovně doplňků a chcete si tak sami a nezávisle na našich partnerech nechat vytvořit vlastní automatizaci nebo napojení na míru? Nově můžete získat API přístup jako placený doplněk přímo ke svému e-shopu.
Za 990 Kč měsíčně / e-shop získáte možnost pracovat programově s daty svého e-shopu, vytvářet vlastní napojení a využívat API klíče a webhooky. A protože už není potřeba řešit individuální smlouvu, celé nastavení zvládnete samoobslužně.
Co je API a k čemu vám může být?
API je rozhraní, které umožňuje různým systémům mezi sebou automaticky komunikovat. Zjednodušeně řečeno: místo toho, abyste data z e-shopu ručně přepisovali do jiného systému, mohou si je propojené systémy předávat automaticky.
API je určeno pro práci s daty vašeho vlastního e-shopu. Konkrétní možnosti, dostupné funkce a technické limity najdete v API dokumentaci.
Co všechno API umí a co přes něj můžete napojit?
API vám umožňuje pracovat s daty a nastavením konkrétního e-shopu programově, tedy prostřednictvím vlastního vývoje nebo externího nástroje. V praxi můžete například:
- číst a zapisovat data produktů včetně jednotlivých údajů, jako je dostupnost,
- číst kompletní data objednávek včetně adres, produktů nebo cen,
- měnit stav objednávek,
- zapisovat k objednávkám sledovací čísla a odkazy na zásilky,
- přidávat vlastní poznámky nebo další data k objednávkám,
- číst a zapisovat data registrovaných uživatelů,
- pracovat se slevovými kupóny,
- číst a zapisovat kontakty v newsletteru,
- pracovat s měřicími kódy a vkládat prostřednictvím nich vlastní skripty,
- ovládat datové feedy, například zadat pokyn k jejich vygenerování nebo aktualizaci.
Díky tomu můžete například propojit e-shop s účetním nebo skladovým systémem, vytvořit vlastní aplikaci pracující s daty e-shopu, napojit dropshippingový nebo fulfillmentový systém nebo synchronizovat data mezi více e-shopy a externím systémem.
API tak může posloužit všude tam, kde potřebujete automaticky přenášet nebo aktualizovat data mezi Eshop-rychle a dalším systémem a máte k dispozici vlastní vývoj nebo externího programátora.
Co od API naopak nečekat
API není univerzální způsob, jak libovolně upravovat e-shop nebo jeho administraci. Jeho možnosti jsou dané funkcemi, které API poskytuje.
Pomocí API například nelze:
- upravovat HTML kód nebo libovolně měnit grafickou podobu e-shopu,
- přidávat vlastní ovládací prvky, například tlačítka, do administrace,
- vytvářet nové dopravní nebo platební metody přímo v košíku,
- zapisovat prostřednictvím API do e-shopu objednávky, které vznikly v jiném systému,
- vytvářet vlastní platební bránu nebo napojení splátkového prodeje jako novou volbu v košíku,
- přidat vlastního dopravce jako novou volbu v košíku,
- napojit marketplace tak, aby se objednávky z marketplace automaticky zapisovaly do administrace e-shopu,
- napojit pokladní systém tak, aby se v něm vytvořené objednávky automaticky zapisovaly do e-shopu.
Některé z těchto scénářů lze řešit jiným způsobem – například exportem dat z e-shopu do externího systému. API ale samo o sobě neslouží k tomu, aby do administrace Eshop-rychle zapisovalo libovolná data nebo rozšiřovalo funkce e-shopu o nové prvky.
Před plánováním vlastního napojení proto doporučujeme nejprve projít dokumentaci API, kde najdete přehled dostupných funkcí, jednotlivých API endpointů, podporovaných webhooků a způsobu autentizace.
API přístup si objednáte jako běžný doplněk
Dosud bylo API dostupné jen pro partnerské aplikace nebo individuálního řešení pro konkrétní e-shop, což vyžadovalo individuální smlouvy a další administrativu.
Nově chceme API zpřístupnit jednodušeji. API přístup si objednáte jako placený doplněk ke svému e-shopu za částku 990 Kč měsíčně, bez ohledu na počet napojení.
V případě, že chcete mít API přístup u vícero e-shopů (například v pro jejich vzájemné propojení), je zapotřebí službu zakoupit na každém e-shopu zvlášť.
Po aktivaci se vám v administraci zpřístupní sekce Správa API, kde budete mít vše potřebné pro nastavení vlastního API přístupu.
Jak API přístup funguje?
Celý princip je jednoduchý:
1. Objednáte API přístup přímo z administrace e-shopu.
API přístup není možné aktivovat během zkušebního období e-shopu. Nejprve je potřeba mít některý z placených tarifů a následně si objednat doplněk API přístup.
2. Po aktivaci získáte v administraci Správu API.
V této sekci budete moci spravovat své API klíče a webhooky.
3. Vytvoříte API klíč.
API klíč slouží jako přístup pro vaše napojení. Můžete jich mít více a využívat je například pro různá napojení nebo jednotlivé externí dodavatele.
4. Klíč použijete pro vlastní napojení nebo ho předáte vývojáři.
Nemusíte být programátor. Pokud vám integraci vytváří externí vývojář, můžete mu potřebný API klíč předat a využít běžná uživatelská oprávnění v administraci.
Více API klíčů pro různá napojení
Jeden e-shop může mít více API klíčů současně. To se hodí například v situaci, kdy máte několik různých napojení a nechcete pro všechna používat stejný přístup.
Samostatné klíče můžete využít třeba pro:
- ERP systém,
- vlastní vývoj,
- různé externí dodavatele.
API klíče mohou mít podle dostupných oprávnění nastavený rozsah přístupu k jednotlivým oblastem API, například k objednávkám nebo produktům.
S API klíči zacházejte stejně opatrně jako s přístupovými údaji. Pokud klíč předáte vývojáři nebo jinému dodavateli, odpovídáte za jeho používání a za to, že nebude zneužit.
Webhooky: nechte systémy reagovat na změny automaticky
Součástí Správy API jsou také webhooky.
Webhook umožňuje napojenému nástroji reagovat na určitou událost v e-shopu bez toho, aby se musel neustále dotazovat, jestli se něco změnilo.
V praxi tak můžete vytvářet napojení, která budou na změny v e-shopu reagovat automaticky.
Webhooky můžete ve Správě API vytvářet, upravovat, deaktivovat nebo mazat. Jejich nastavení zůstává uložené i v případě, že API přístup dočasně deaktivujete.
API není bez omezení
API je určeno pro běžné používání a má proto své technické limity. Ty se týkají například počtu a frekvence požadavků, objemu přenášených dat nebo souběžného zatížení.
Aktuální limity a technické podmínky najdete vždy v API dokumentaci.
Pokud by využívání API výrazně překračovalo stanovené limity nebo ohrožovalo stabilitu, výkon či bezpečnost služby, můžeme požadavky omezit, zpomalit nebo API přístup dočasně pozastavit.
Stejně tak je potřeba zajistit, aby vaše vlastní integrace byla funkční a zabezpečená a nenarušovala provoz Eshop-rychle.
Co se stane, když API přístup zrušíte?
Pokud službu ukončíte nebo nebude uhrazena, API přístup se deaktivuje. API klíče přestanou fungovat a webhooky se přestanou zpracovávat.
Vaše nastavení ale nezmizí.
Pokud API přístup později znovu aktivujete, původní API klíče a webhooky se obnoví. Nemusíte proto celé napojení nastavovat od začátku.
Aktualizujeme také Všeobecné obchodní podmínky
S novým způsobem poskytování API souvisí také aktualizace našich Všeobecných obchodních podmínek.
Dosud se podmínky pro využívání API řešily individuálně například prostřednictvím smlouvy s API partnerem nebo u individuálních API řešení pro konkrétní e-shop. Nově je API přístup standardním placeným doplňkem, který si objednáte přímo ke svému e-shopu.
Proto jsme kromě učesání pár dřívějších odstavců do VOP doplnili nový článek 10 – Samoobslužný přístup k API, který upravuje základní pravidla používání API.
Nová část VOP se týká například:
- používání API pouze pro vlastní e-shop,
- odpovědnosti za API klíče a jejich používání,
- technických limitů API,
- bezpečnosti vlastních integrací,
- možnosti omezení API při nadměrném nebo problematickém využívání,
- změn a vývoje API.
API pro vlastní napojení bez zbytečné administrativy
Nový API přístup je určen všem e-shopařům, kteří potřebují svůj e-shop propojit s vlastním systémem, externím nástrojem nebo vlastním vývojem.
Nemusíte řešit partnerský režim ani individuální smlouvu. Stačí si objednat API přístup za 990 Kč měsíčně, vytvořit potřebné API klíče a pustit se do vlastního napojení.
Podrobné informace o možnostech API, dostupných funkcích a technických podmínkách najdete v API dokumentaci.
FAQs
Co je API přístup?
API přístup umožňuje programově pracovat s daty vašeho e-shopu a propojit Eshop-rychle s vlastními systémy, nástroji nebo aplikacemi. Můžete tak například vytvářet vlastní integrace a automatizace nebo využít služeb externího vývojáře.
Kolik API přístup stojí?
API přístup je placený doplněk za 990 Kč měsíčně pro jeden e-shop, bez ohledu na počet napojení.
Je API přístup dostupný v rámci zkušebního období?
Ne. Během zkušebního období není možné API přístup aktivovat. Nejprve je potřeba mít některý z placených tarifů a následně si objednat doplněk API přístup.
Kde API přístup nastavím?
Objednat jej můžete přímo z administrace e-shopu, objednávky dalších služeb. Po jeho aktivaci se v administraci zpřístupní sekce Správa API. Zde můžete spravovat API klíče a webhooky.
Mohu mít více API klíčů?
Ano. Jeden e-shop může mít více API klíčů současně. Můžete je využít například pro různá napojení, vlastní vývoj nebo různé externí dodavatele.
Mohu API klíč předat svému vývojáři?
Ano. API klíč můžete předat například externímu vývojáři, který pro vás vytváří nebo provozuje vlastní napojení. Za používání API prostřednictvím svého klíče ale odpovídáte vy, proto je důležité klíč chránit před zneužitím.
Mohu nastavit, k čemu bude mít jednotlivý API klíč přístup?
API klíče mohou mít podle dostupných oprávnění nastavený rozsah přístupu k jednotlivým oblastem API. Konkrétní možnosti najdete v API dokumentaci.
Co jsou webhooky?
Webhook umožňuje napojenému systému reagovat na určité události v e-shopu automaticky. Nemusí tak neustále kontrolovat, zda se v e-shopu něco změnilo.
Mohu webhooky upravovat nebo mazat?
Ano. Ve Správě API můžete webhooky vytvářet, upravovat, deaktivovat nebo mazat.
Co se stane s API klíči a webhooky, když API přístup zruším?
API přístup se deaktivuje, API klíče přestanou fungovat a webhooky se přestanou zpracovávat. Vaše nastavení ale zůstane uložené.
Co když si API přístup později znovu aktivuji?
Původní API klíče a webhooky se obnoví. Není proto potřeba celé napojení nastavovat od začátku.
Má API nějaké technické limity?
Ano. API má technické limity týkající se například počtu a frekvence požadavků, objemu přenášených dat nebo souběžného zatížení. Aktuální limity najdete v API dokumentaci.
Co se stane, pokud budu API používat nad stanovené limity?
Při překračování stanovených limitů nebo při využívání API způsobem, který ohrožuje stabilitu, výkon či bezpečnost služby, může dojít k omezení nebo zpomalení požadavků či k dočasnému pozastavení API přístupu.
Mohu přes API pracovat s daty jiného e-shopu?
Ne. API přístup je určen pro práci s daty e-shopu, pro který byl objednán.
Potřebuji být programátor, abych mohl API přístup používat?
Ne. Samotné využití API sice obvykle vyžaduje technické znalosti, ale nemusíte je mít vy sami. API klíč můžete předat svému vývojáři nebo jinému odborníkovi, který pro vás napojení vytvoří.
Kde najdu technickou dokumentaci k API?
Podrobné informace o dostupných funkcích, možnostech a technických limitech API najdete v API dokumentaci.
Mění se kvůli API také Všeobecné obchodní podmínky?
Ano. Spolu se zavedením samoobslužného API přístupu jsme aktualizovali Všeobecné obchodní podmínky a doplnili do nich nový článek 10 – Samoobslužný přístup k API. Ten upravuje například pravidla používání API, odpovědnost za API klíče, technické limity a podmínky pro omezení API přístupu.
