Integrace Shopify API: Jak funguje, případy použití a jak začít
Integrace Shopify API propojuje obchod s jiným systémem, aby mezi nimi mohly bez opakovaného ručního zadávání proudit produkty, objednávky, zákazníci, údaje o plnění objednávek nebo události spojené se zásilkami. Obvyklá implementace začíná aplikací Shopify nebo soukromou provozní službou, používá odpovídající oprávnění API, tam, kde je to praktické, přijímá změny prostřednictvím webhooků a přidává ochranná opatření pro autentizaci, limity požadavků, opakování požadavků a duplicitní události. Pro přehled o zásilkách lze spolu s vlastními údaji Shopify o objednávkách a plnění objednávek zvážit sledovací API, například 17TRACK API.
Správný návrh integrace závisí na automatizovaném obchodním procesu. Obchod, který potřebuje pouze značkovou stránku pro sledování, má jiné požadavky než prodejce synchronizující Shopify se systémem ERP, systémem pro řízení skladu, platformou zákaznických služeb nebo službou pro sledování zásilek od více dopravců.
Co integrace Shopify API dělá
Integrace API umožňuje dvěma systémům vyměňovat si strukturované informace prostřednictvím autentizovaných požadavků a oznámení o událostech. V typickém pracovním postupu elektronického obchodu zůstává Shopify zdrojem pravdy pro některá obchodní data, zatímco jiná platforma spravuje specializovaný proces.
- Ze Shopify do jiného systému: objednávky, informace o produktech, údaje o zákaznících, záznamy o plnění objednávek a vybrané události objednávek lze odesílat do systému ERP, skladové platformy, analytického systému nebo nástroje zákaznických služeb.
- Z jiného systému do Shopify: aktualizace zásob, potvrzení plnění objednávek, čísla zásilek a změny stavu plnění lze zapsat zpět, pokud má integrace požadovaná oprávnění a cílový pracovní postup to podporuje.
- Události do aplikace: webhooky mohou integraci upozornit, když dojde k vybraným změnám, čímž se snižuje potřeba opakovaně dotazovat Shopify na každou možnou aktualizaci.
- Údaje o sledování pro zákaznickou zkušenost: události dopravců může sledovací služba normalizovat a následně zobrazit v pracovním postupu stavu objednávky, systému oznámení nebo rozhraní podpory obchodu.
API automaticky nerozhoduje, které záznamy se mají přenášet, jak se mají mapovat pole ani co se má stát, když se systémy neshodují. To jsou rozhodnutí při návrhu integrace. Spolehlivý projekt proto zahrnuje obchodní pravidla, vlastnictví dat, monitorování a proces obnovy, nikoli pouze propojení dvou koncových bodů.
Jak integrace funguje
1. Zvolte vzor integrace
Existují tři běžné vzory.
- Nativní aplikace Shopify: Aplikace nainstalovaná obchodníkem zajišťuje autorizaci a používá API Shopify pro přístup k povoleným údajům obchodu. To je často vhodné, pokud bude integrace sloužit více obchodům.
- Vlastní aplikace nebo interní služba: Firma vytvoří integraci pro vlastní obchod nebo organizaci. To může poskytnout lepší kontrolu nad mapováním polí a provozními pravidly, vlastník však stále musí spravovat přihlašovací údaje, oprávnění, změny verzí a spolehlivost.
- Konektor nebo automatizační platforma: Konektor třetí strany propojí Shopify s jinou službou prostřednictvím předem vytvořených pracovních postupů. To může zkrátit dobu implementace, avšak složitá pravidla plnění objednávek, vysoký počet událostí nebo neobvyklé datové modely mohou vyžadovat vlastní vývoj.
Před výběrem vzoru zdokumentujte zapojené systémy, záznamy, které je třeba přenášet, směr každého toku dat a přijatelnou prodlevu. Aktualizace sledování, která dorazí během několika minut, může být pro stránku určenou zákazníkům přijatelná, zatímco synchronizace zásob může vyžadovat přísnější provozní kontroly.
2. Vytvořte přístup s nejmenším praktickým rozsahem
Shopify používá rozsahy přístupu API ke kontrole toho, co může aplikace číst nebo zapisovat. Integrace by měla vyžadovat pouze oprávnění potřebná pro zdokumentované funkce. Například služba, která čte informace o plnění objednávek, by neměla automaticky požadovat oprávnění měnit nesouvisející údaje o produktech nebo zákaznících.
Podrobnosti autentizace závisí na typu aplikace a aktuálních požadavcích platformy Shopify. Dokumentace Shopify by měla být považována za zdroj pravdy pro podporovaný autorizační tok, práci s tokeny a aktuální verzi API. Přihlašovací údaje ukládejte do systému pro správu tajných údajů, nikoli do zdrojového kódu, tabulek, úložiště prohlížeče nebo běžných konfiguračních souborů.
3. Vyberte API a datový model
Shopify poskytuje API pro různé účely. Admin GraphQL API je hlavní možností pro administrativní data obchodu a umožňuje aplikaci požadovat pole prostřednictvím dotazovacího modelu založeného na grafu. Shopify dokumentuje také další API a rozhraní pro konkrétní případy použití, takže správnou volbu je třeba ověřit v aktuální dokumentaci, nikoli předpokládat podle staršího návodu.
Hlavním úkolem návrhu je mapování obchodních objektů mezi systémy. Objednávka Shopify může například odpovídat objednávce v systému ERP, požadavku na plnění ve skladovém systému a záznamu o zásilce ve sledovací platformě. Tyto objekty nemusí sdílet stejné identifikátory ani názvy stavů. Ukládejte původní ID z každého systému a definujte stabilní křížové propojení namísto párování záznamů pouze podle jména zákazníka nebo celkové částky objednávky.
4. Kombinujte webhooky s řízeným čtením prostřednictvím API
Webhooky jsou užitečné, když systém potřebuje reagovat na změny. Mohou spustit pracovní postup po relevantní události Shopify, takže není nutné neustále provádět dotazy. Příchozí webhook by však měl být obvykle považován za signál k ověření a zpracování změny, nikoli za důkaz, že všechny následné operace byly úspěšné.
Robustní obslužný mechanismus ověřuje požadavek podle zdokumentované metody Shopify, zaznamená událost, zkontroluje, zda již byla zpracována, a zařadí práci do fronty, pokud může zpracování trvat delší dobu. Pracovník poté načte požadovaný záznam, použije obchodní pravidla a zaznamená výsledek. Tento přístup pomáhá předcházet vypršení časového limitu a zvyšuje bezpečnost opakovaných pokusů.
5. Řešte limity, chyby a změny verzí
Volání API může selhat kvůli dočasným problémům se sítí, vypršeným přihlašovacím údajům, neplatným datům, změnám oprávnění, omezení rychlosti nebo přechodu na jinou verzi API. Integrace by měla rozlišovat dočasná selhání od trvalých validačních chyb. Dočasná selhání lze opakovat s postupně se prodlužující prodlevou; trvalé chyby vyžadují upozornění, opravný pracovní postup nebo ruční kontrolu.
Limity rychlosti jsou součástí technického návrhu, nikoli závěrečnou optimalizací. Používejte stránkování, požadujte pouze potřebná pole, vyhýbejte se zbytečnému dotazování, zařazujte nárazové požadavky do fronty a sledujte kódy odpovědí i prodlevu zpracování. Aktuální limity a chování Shopify je třeba před odhadem produkční kapacity ověřit v oficiální dokumentaci.
Běžné případy použití integrace Shopify API
Synchronizace objednávek a plnění
Integrace plnění může odesílat nové objednávky do skladu nebo 3PL a následně zapisovat potvrzení o plnění a čísla zásilek zpět do Shopify. Důležitá rozhodnutí se týkají toho, kdy je objednávka způsobilá k exportu, jak se zpracovávají zrušené nebo upravené objednávky a který systém po předání vlastní stav zásilky.
Nepředpokládejte, že vytvoření objednávky znamená, že je připravena k odeslání. Pravidlo uvolnění mohou ovlivnit stav platby, kontrola podvodu, přidělení zásob, ověření dodací adresy i místo plnění.
Synchronizace zásob
Integrace zásob synchronizují dostupná množství mezi Shopify, sklady, tržišti a interními systémy. Užitečný návrh definuje zdroj zásob, bezpečnostní zásobu, chování rezervací a řešení konfliktů. Bez těchto pravidel mohou dva systémy navzájem přepisovat své hodnoty nebo zobrazovat zásoby, které již byly přiděleny.
Zákaznické služby a vyhledávání objednávek
Platforma podpory může využívat data Shopify, aby agentům pomohla najít objednávku, zkontrolovat průběh plnění a určit další provozní krok. To může omezit přepínání mezi kartami, zákaznická data by však měla být omezena na účel podpory. Před kopírováním osobních údajů do jiné platformy je třeba posoudit požadavky na uchovávání, řízení přístupu a ochranu soukromí.
Sledování zásilek a aktualizace po nákupu
Shopify může ukládat informace o objednávkách a plnění, zatímco sledovací služba může poskytovat události zásilek specifické pro dopravce a normalizovaný přehled stavu. Toto oddělení je užitečné, pokud obchodník spolupracuje s více dopravci nebo odesílá zásilky mezinárodně. Integrace by měla konzistentně mapovat kód dopravce, číslo zásilky, referenci zásilky a stav události.
Pro obchodníky, kteří chtějí hotový pracovní postup sledování Shopify namísto vlastního projektu API, je samostatnou možností k vyhodnocení oficiální aplikace 17TRACK pro Shopify. U vlastní aplikace je třeba v dokumentaci 17TRACK API ověřit aktuální požadavky na autentizaci, koncové body, sledování a účet. Aplikace a API řeší související, ale odlišné implementační problémy; bez otestování požadovaného pracovního postupu by jedno nemělo být prezentováno jako náhrada druhého.
Praktický plán, jak začít
- Popište výsledek obchodními pojmy. Například: „Odesílat zaplacené objednávky do skladu v rámci definovaného servisního okna“ nebo „Zobrazit zákazníkům průběh zásilky po přiřazení čísla zásilky.“
- Seznamte systémy a vlastníky. Určete, kdo vlastní produkty, zásoby, objednávky, plnění, události sledování a oznámení zákazníkům.
- Vytvořte mapu polí. Zahrňte ID, časová razítka, hodnoty stavů, adresy, množství, kódy dopravců, čísla zásilek a chybová pole. Označte povinná, volitelná, pouze pro čtení a transformovaná pole.
- Ověřte aktuální dokumentaci. Zkontrolujte verzi API Shopify, metodu autentizace, rozsahy přístupu, požadavky webhooků, chování stránkování a limity rychlosti. Ověřte odpovídající dokumentaci každé externí platformy.
- Vytvořte úzký koncept důkazu. Začněte s malým testovacím obchodem nebo kontrolovanou datovou sadou. Před přidáním všech typů objektů ověřte autentizaci, jednu cestu čtení, jednu cestu zápisu, pokud je potřeba, a jeden událostmi řízený pracovní postup.
- Přidejte idempotenci a rekonciliaci. Opakovaný webhook nebo opakovaný pokus nesmí vytvořit duplicitní zásilky, duplicitní zprávy zákazníkům ani duplicitní úpravy zásob. Naplánujte kontroly rekonciliace, které vyhledají vynechané nebo odmítnuté záznamy.
- Testujte provozní výjimky. Zahrňte zrušené objednávky, upravené adresy, rozdělené zásilky, částečné plnění, chybějící čísla zásilek, neplatné kódy dopravců, duplicitní události, omezení API, vypršené přihlašovací údaje a opožděné aktualizace dopravců.
- Uveďte řešení do provozu s monitorováním. Sledujte úspěšné a neúspěšné události, stáří fronty, chyby odpovědí API, dobu zpracování a záznamy vyžadující ruční zásah. Určete, kdo dostává upozornění a jak se chyby znovu přehrávají.
Kdy použít konektor, vlastní aplikaci nebo sledovací API
| Možnost | Obvykle se hodí pro | Hlavní kontroly před výběrem |
|---|---|---|
| Konektor nebo automatizační nástroj | Standardní pracovní postupy s omezenými možnostmi přizpůsobení | Podporované objekty, prodlevy událostí, zpracování chyb, limity úloh a uchovávání dat |
| Vlastní aplikace nebo služba Shopify | Specifická obchodní pravidla, více systémů nebo řízené interní procesy | Vlastnictví vývoje, zabezpečení, monitorování, údržba API a celkové provozní náklady |
| Sledovací API | Vlastní zákaznická zkušenost po nákupu nebo přehled o zásilkách | Požadavky dopravců a regionů, životní cyklus sledování, chování aktualizací, limity a obchodní podmínky |
Konektor není automaticky jednodušší, pokud pracovní postup vyžaduje vlastní opakování požadavků nebo složitou rekonciliaci. Stejně tak vlastní integrace není automaticky lepší, pokud požadavek již splňuje standardní a dobře podporovaná aplikace. Nejlépe obhajitelnou volbou je nejmenší implementace, která splňuje požadavky na data, spolehlivost, bezpečnost a provoz.
Kontrolní seznam zabezpečení a spolehlivosti
- Používejte rozsahy přístupu s nejmenšími oprávněními a při změně integrace je znovu posuďte.
- Tokeny a tajné údaje uchovávejte mimo kód aplikace a obměňujte je řízeným procesem.
- Ověřujte pravost webhooků podle dokumentace platformy.
- Šifrujte data při přenosu a omezte administrativní přístup k protokolům a záznamům zákazníků.
- Používejte idempotentní zpracování, aby opakované pokusy neopakovaly vedlejší účinky.
- Ukládejte ID zdrojových systémů a časová razítka událostí pro audit a rekonciliaci.
- Oddělujte testovací a produkční přihlašovací údaje a nepoužívejte živá zákaznická data pro běžné testování.
- Před kopírováním osobních údajů do jiné služby posuďte povinnosti týkající se soukromí, uchovávání a mazání.
- Sledujte verze API a plánujte aktualizaci dříve, než se podporovaná verze změní.
Časté dotazy
Je integrace Shopify API totéž jako instalace aplikace Shopify?
Ne. Aplikace Shopify může používat API Shopify, instalace aplikace je však akce nasazení prováděná obchodníkem. Integrace API je širší propojení mezi Shopify a jiným systémem. Může být poskytována prostřednictvím veřejné aplikace, vlastní aplikace, interní služby nebo konektoru.
Které API Shopify bych měl použít?
Vyberte API podle dat a pracovního postupu a poté ověřte aktuální doporučení v dokumentaci Shopify. Pro administrativní data obchodu je běžnou možností Admin GraphQL API, u konkrétního případu použití však musí být ověřeny autentizace, oprávnění, dostupnost objektů a podpora verze.
Může Shopify samo poskytovat aktualizace sledování od dopravců?
Shopify může ukládat informace o plnění a sledování, úplná zkušenost se sledováním však závisí na tom, jak jsou události zásilek získávány, normalizovány, zobrazovány a komunikovány. Pracovní postup s více dopravci nebo mezinárodní pracovní postup může vyžadovat specializovanou sledovací službu nebo jinou integrační vrstvu.
Mám používat webhooky, nebo dotazování?
Webhooky jsou obecně užitečné pro reakce na změny, zatímco řízené čtení prostřednictvím API je užitečné pro ověřování, rekonciliaci a obnovu. Produkční integrace běžně používají obojí, místo aby se spoléhaly výhradně na jednu z těchto metod.
Jak dlouho trvá integrace Shopify API?
Neexistuje jediný spolehlivý časový odhad. Základní konektor lze nakonfigurovat rychle, zatímco vlastní integrace zahrnující zásoby, plnění, zákaznická data, více dopravců a rekonciliaci vyžaduje více návrhu a testování. Lepšími ukazateli než samotné propojení Shopify jsou počet systémů, pravidla výjimek, bezpečnostní kontrola a řízení nasazení.
