API
Také známé jako: aplikační rozhraní, API rozhraní
API je rozhraní, přes které spolu programy komunikují přímo, bez člověka a bez souborů. U e-shopu umožňuje číst a měnit data v reálném čase — vytvořit objednávku, upravit sklad, načíst produkty — na rozdíl od feedu, který je jednosměrný snímek.
Kdy sáhnout po API
Když potřebuješ obousměrnou výměnu nebo aktuální stav — synchronizaci skladu s ERP, zakládání objednávek z marketplace, napojení PIM. Na jednosměrný export katalogu ven je feed jednodušší a levnější.
Jak se s API pracuje
Aplikace posílá požadavky na adresy rozhraní a dostává odpovědi, obvykle ve formátu JSON. Metody odpovídají tomu, co se má stát: načíst, vytvořit, upravit, smazat.
Tři věci, které rozhodují o tom, jestli integrace vydrží:
Za prvé dávkování. Platformy omezují počet položek na jeden požadavek. Načítání po jednom vyčerpá limit dřív, než dojedeš na konec katalogu.
Za druhé filtrování podle času poslední změny. Načítat celý katalog kvůli deseti změněným produktům je nejčastější příčina vyčerpaných limitů.
Za třetí čtení chybových odpovědí. Když rozhraní vrátí, že jsi překročil limit, opakování téhož požadavku situaci jen zhorší.
Nejčastější chyby
- Načítání celého katalogu při každém běhu. Vyčerpá limity a zpomalí všechno ostatní.
- Dotazování v krátkém intervalu místo webhooků. Většina dotazů vrátí „nic se nezměnilo".
- Jeden přístup pro všechna napojení. Nejde vypnout jedno, aniž bys shodil ostatní.
- Ignorování chybových hlášek a slepé opakování. Vede k dočasnému zablokování přístupu.
Shoptet a Upgates
Upgates. API v2, autentizace HTTP Basic, kódování UTF-8, JSON. Metody POST, GET, PUT, DELETE. Stránkování přes page a current_page_items (max 100). Limit 100 položek na PUT/POST (jinak chyba 413) a max 3 souběžné požadavky na skupinu přístupu (jinak 429). Doporučené postupy platformy: filtrovat podle času poslední změny, používat stránkování místo dotazů po jednom, dávat přednost webhookům před pravidelným dotazováním a cachovat číselníky. (Ověř aktuální stav.)
Časté otázky
Kdy použít API a kdy feed?
Feed na jednosměrný export katalogu ven. API tam, kde potřebuješ obousměrnou výměnu nebo aktuální stav.
Proč mi integrace přestala fungovat, i když se nic nezměnilo?
Nejčastěji kvůli vyčerpanému limitu požadavků nebo změně práv API přístupu. Obojí se pozná z chybové odpovědi.
Můžu použít jeden API přístup pro víc integrací?
Můžeš, ale nedělej to. Samostatný přístup na každé napojení znamená, že jde jedno vypnout bez dopadu na ostatní.
Související pojmy
- REST API – REST API je nejrozšířenější způsob, jak stavět webová rozhraní: každý typ dat má vlastní adresu a operace se vyjadřuje metodou HTTP požadavku. Naprostá většina e-shopových platforem nabízí právě tuhle podobu API.
- Webhook – Webhook je notifikace, kterou systém sám odešle ve chvíli, kdy nastane určitá událost — vznikne objednávka, změní se produkt, aktualizuje se sklad. Nahrazuje pravidelné dotazování: místo aby se integrace ptala „změnilo se něco?", dozví se to, až když se skutečně něco stane.
- Rate limit – Rate limit je omezení počtu požadavků, které smí jedna integrace na rozhraní poslat za daný čas. Chrání server před přetížením a u e-shopových platforem bývá navázaný na tarif — takže víc integrací znamená dělit se o stejný rozpočet požadavků.
- API klíč – API klíč je přístupový údaj, kterým se integrace prokazuje při komunikaci s rozhraním. Určuje nejen to, kdo se připojuje, ale i co smí — a proto by měl mít každé napojení vlastní klíč s minimem oprávnění.
- Napojení ERP – Napojení ERP je propojení e-shopu s podnikovým systémem tak, aby si vyměňovaly data automaticky — typicky objednávky z e-shopu do ERP a sklad s cenami z ERP na e-shop. Realizuje se buď hotovým doplňkem, nebo vlastní integrací přes API.
- Produktový feed – Produktový feed je strukturovaný soubor s daty o produktech e-shopu, kterým se katalog předává externím systémům — srovnávačům, reklamním platformám a marketplace. Externí systém si ho v pravidelných intervalech stahuje a podle něj aktualizuje, co o produktech ví a jak je zobrazuje.
Další pojmy ze skupiny Feedy & integrace
- API klíčAPI klíč je přístupový údaj, kterým se integrace prokazuje při komunikaci s rozhraním. Určuje nejen to, kdo se připojuje, ale i co smí — a proto by měl mít každé napojení vlastní klíč s minimem oprávnění.
- Datová migraceDatová migrace je převod obsahu e-shopu z jednoho systému do druhého — produktů, kategorií, zákazníků, objednávek a jejich vzájemných vazeb. Nejtěžší na ní nejsou samotná data, ale vazby mezi nimi a pole, která v cílovém systému nemají protějšek.
- Diagnostika feeduDiagnostika feedu je pravidelná kontrola toho, kolik produktů kanál z feedu skutečně přijal, kolik jich zamítl a proč. Je to jediný způsob, jak zjistit, že část sortimentu tiše vypadla — počet položek ve feedu totiž neříká nic o tom, kolik se jich reálně zobrazuje.
- ERPERP je podnikový systém, ve kterém firma vede sklad, objednávky, fakturaci a účetnictví na jednom místě. U e-shopu bývá zdrojem pravdy o skladu a cenách, zatímco e-shop je prodejní kanál — a rozhodnutí, který systém co určuje, je základ jakéhokoli napojení.
- Export produktůExport produktů je vytažení dat z katalogu do souboru nebo rozhraní pro použití jinde — pro srovnávače, pro účetnictví, pro dodavatele nebo jako záloha před hromadnou úpravou. Na rozdíl od feedu nemusí mít pevnou strukturu danou cizím systémem.
- Feed managerFeed manager je nástroj, který vezme výstupní feed z e-shopu a upraví ho pro jednotlivé kanály — přejmenuje pole, doplní chybějící hodnoty, přemapuje kategorie a odfiltruje produkty, které do daného kanálu nepatří. Řeší tím, že platforma umí generovat jen jeden obecný export.