Integracja z API Shopify: jak działa, przypadki użycia i jak zacząć
Integracja API Shopify łączy sklep z innym systemem, dzięki czemu produkty, zamówienia, klienci, dane dotyczące realizacji lub zdarzenia związane z przesyłkami mogą być między nimi przekazywane bez konieczności wielokrotnego ręcznego wprowadzania danych. Typowa implementacja rozpoczyna się od aplikacji Shopify lub prywatnej usługi operacyjnej, wykorzystuje odpowiednie uprawnienia API, odbiera zmiany za pomocą webhooków, gdy jest to praktyczne, oraz dodaje zabezpieczenia dotyczące uwierzytelniania, limitów zapytań, ponowień i zduplikowanych zdarzeń. W celu zapewnienia widoczności przesyłek można rozważyć API śledzenia, takie jak 17TRACK API, wraz z własnymi danymi Shopify dotyczącymi zamówień i realizacji.
Właściwy projekt integracji zależy od automatyzowanego procesu biznesowego. Sklep, który potrzebuje jedynie markowej strony śledzenia, ma inne wymagania niż sprzedawca synchronizujący Shopify z systemem ERP, systemem zarządzania magazynem, platformą obsługi klienta lub usługą śledzenia wielu przewoźników.
Co robi integracja API Shopify
Integracja API umożliwia dwóm systemom wymianę ustrukturyzowanych informacji za pośrednictwem uwierzytelnionych żądań i powiadomień o zdarzeniach. W typowym procesie e-commerce Shopify pozostaje źródłem prawdy dla niektórych danych handlowych, podczas gdy inna platforma zarządza wyspecjalizowanym procesem.
- Shopify do innego systemu: zamówienia, informacje o produktach, dane klientów, rejestry realizacji i wybrane zdarzenia dotyczące zamówień mogą być wysyłane do systemu ERP, platformy magazynowej, systemu analitycznego lub narzędzia obsługi klienta.
- Inny system do Shopify: aktualizacje stanów magazynowych, potwierdzenia realizacji, numery śledzenia i zmiany statusu realizacji mogą być zapisywane z powrotem w Shopify, jeśli integracja ma wymagane uprawnienia, a docelowy proces je obsługuje.
- Zdarzenia do aplikacji: webhooki mogą powiadamiać integrację o wystąpieniu wybranych zmian, ograniczając potrzebę wielokrotnego odpytywania Shopify o każdą możliwą aktualizację.
- Dane śledzenia w doświadczeniu klienta: zdarzenia przewoźników mogą być normalizowane przez usługę śledzenia, a następnie wyświetlane w procesie sprawdzania statusu zamówienia, systemie powiadomień lub interfejsie obsługi sklepu.
API nie decyduje automatycznie, które rekordy powinny być przesyłane, jak mapować pola ani co zrobić, gdy systemy przedstawiają różne dane. Są to decyzje projektowe dotyczące integracji. Dlatego niezawodny projekt obejmuje reguły biznesowe, własność danych, monitorowanie i proces odzyskiwania, a nie tylko połączenie dwóch punktów końcowych.
Jak działa integracja
1. Wybierz wzorzec integracji
Istnieją trzy typowe wzorce.
- Natywna aplikacja Shopify: Aplikacja zainstalowana przez sprzedawcę obsługuje autoryzację i korzysta z API Shopify w celu uzyskania dostępu do dozwolonych danych sklepu. Jest to często odpowiednie rozwiązanie, gdy integracja ma obsługiwać wiele sklepów.
- Aplikacja niestandardowa lub usługa wewnętrzna: Firma tworzy integrację dla własnego sklepu lub organizacji. Może to zapewnić większą kontrolę nad mapowaniem pól i regułami operacyjnymi, ale właściciel nadal musi zarządzać danymi uwierzytelniającymi, uprawnieniami, zmianami wersji i niezawodnością.
- Łącznik lub platforma automatyzacji: Łącznik zewnętrzny łączy Shopify z inną usługą za pomocą gotowych przepływów pracy. Może to skrócić czas wdrożenia, jednak złożone reguły realizacji, duża liczba zdarzeń lub nietypowe modele danych mogą wymagać niestandardowego rozwoju.
Przed wyborem wzorca należy udokumentować zaangażowane systemy, rekordy, które mają być przesyłane, kierunek każdego przepływu danych oraz dopuszczalne opóźnienie. Aktualizacja śledzenia, która może dotrzeć w ciągu kilku minut, może być akceptowalna na stronie widocznej dla klienta, podczas gdy synchronizacja zapasów może wymagać bardziej rygorystycznej kontroli operacyjnej.
2. Utwórz dostęp o możliwie najmniejszym zakresie
Shopify używa zakresów dostępu API do kontrolowania tego, co aplikacja może odczytywać lub zapisywać. Integracja powinna żądać wyłącznie uprawnień wymaganych do udokumentowanych funkcji. Na przykład usługa odczytująca informacje o realizacji nie powinna automatycznie żądać uprawnień do modyfikowania niezwiązanych z nią danych produktów lub klientów.
Szczegóły uwierzytelniania zależą od typu aplikacji i aktualnych wymagań platformy Shopify. Dokumentację Shopify należy traktować jako źródło prawdy w zakresie obsługiwanego procesu autoryzacji, zarządzania tokenami i bieżącej wersji API. Dane uwierzytelniające sklepu należy przechowywać w systemie zarządzania sekretami, a nie w kodzie źródłowym, arkuszach kalkulacyjnych, pamięci przeglądarki ani zwykłych plikach konfiguracyjnych.
3. Wybierz API i model danych
Shopify udostępnia API do różnych celów. Admin GraphQL API jest podstawową opcją dla administracyjnych danych sklepu i pozwala aplikacji żądać pól za pomocą modelu zapytań opartego na grafie. Shopify opisuje również inne API i interfejsy dla konkretnych przypadków użycia, dlatego właściwy wybór należy potwierdzić w aktualnej dokumentacji, a nie zakładać go na podstawie starszego poradnika.
Głównym zadaniem projektowym jest mapowanie obiektów biznesowych między systemami. Na przykład zamówienie Shopify może odpowiadać zamówieniu w systemie ERP, żądaniu realizacji w systemie magazynowym i rekordowi przesyłki na platformie śledzenia. Obiekty te mogą nie mieć tych samych identyfikatorów ani słownictwa statusów. Należy przechowywać oryginalne identyfikatory z każdego systemu i definiować stabilne powiązanie między systemami zamiast dopasowywać rekordy wyłącznie na podstawie nazwy klienta lub wartości zamówienia.
4. Połącz webhooki z kontrolowanymi odczytami API
Webhooki są przydatne, gdy system musi reagować na zmiany. Mogą uruchamiać przepływ pracy po odpowiednim zdarzeniu Shopify, zamiast wymagać ciągłego odpytywania. Jednak przychodzący webhook powinien zwykle być traktowany jako sygnał do zweryfikowania i przetworzenia zmiany, a nie jako dowód, że każda operacja w systemach podrzędnych zakończyła się powodzeniem.
Solidny moduł obsługi weryfikuje żądanie zgodnie z udokumentowaną metodą Shopify, rejestruje zdarzenie, sprawdza, czy zostało już przetworzone, i umieszcza zadanie w kolejce, jeśli jego przetwarzanie może zająć więcej czasu. Następnie proces roboczy może pobrać wymagany rekord, zastosować reguły biznesowe i zapisać wynik. Takie podejście pomaga zapobiegać przekroczeniom limitu czasu i zwiększa bezpieczeństwo ponowień.
5. Obsługuj limity, błędy i zmiany wersji
Wywołania API mogą kończyć się niepowodzeniem z powodu tymczasowych problemów z siecią, wygasłych danych uwierzytelniających, nieprawidłowych danych, zmian uprawnień, ograniczania liczby żądań lub przejścia na inną wersję API. Integracja powinna rozróżniać błędy tymczasowe od trwałych błędów walidacji. Błędy tymczasowe można ponawiać z opóźnieniem narastającym, natomiast błędy trwałe wymagają alertu, procesu korekty lub ręcznego przeglądu.
Limity zapytań są częścią projektu technicznego, a nie końcową optymalizacją. Należy używać paginacji, żądać tylko potrzebnych pól, unikać niepotrzebnego odpytywania, kolejkować skoki obciążenia oraz monitorować kody odpowiedzi i opóźnienia przetwarzania. Przed oszacowaniem wydajności produkcyjnej należy sprawdzić aktualne limity i zachowanie Shopify w oficjalnej dokumentacji.
Typowe zastosowania integracji API Shopify
Synchronizacja zamówień i realizacji
Integracja realizacji może wysyłać nowe zamówienia do magazynu lub operatora 3PL, a następnie zapisywać potwierdzenia realizacji i numery śledzenia z powrotem w Shopify. Ważne decyzje dotyczą tego, kiedy zamówienie kwalifikuje się do eksportu, jak obsługiwane są zamówienia anulowane lub edytowane oraz który system jest właścicielem statusu przesyłki po przekazaniu.
Nie należy zakładać, że utworzenie zamówienia oznacza jego gotowość do wysyłki. Na zasadę zwolnienia mogą wpływać status płatności, kontrola pod kątem oszustw, alokacja zapasów, weryfikacja adresu wysyłki i lokalizacja realizacji.
Synchronizacja zapasów
Integracje zapasów synchronizują dostępne ilości między Shopify, magazynami, platformami handlowymi i systemami wewnętrznymi. Dobry projekt definiuje źródło zapasów, zapas bezpieczeństwa, sposób rezerwacji i rozwiązywanie konfliktów. Bez tych reguł dwa systemy mogą nadpisywać swoje dane lub prezentować zapasy, które zostały już przydzielone.
Obsługa klienta i wyszukiwanie zamówień
Platforma wsparcia może korzystać z danych Shopify, aby pomagać agentom znajdować zamówienia, sprawdzać postęp realizacji i identyfikować kolejne działania operacyjne. Może to ograniczyć przełączanie się między kartami, ale dane klientów powinny być ograniczone do zastosowania związanego z obsługą. Przed kopiowaniem danych osobowych do innej platformy należy przeanalizować wymagania dotyczące przechowywania, kontroli dostępu i prywatności.
Śledzenie przesyłek i aktualizacje po zakupie
Shopify może przechowywać informacje o zamówieniach i realizacji, podczas gdy usługa śledzenia może dostarczać specyficzne dla przewoźnika zdarzenia przesyłki oraz znormalizowany widok statusu. Taki podział jest przydatny, gdy sprzedawca współpracuje z wieloma przewoźnikami lub wysyła przesyłki międzynarodowe. Integracja powinna spójnie mapować kod przewoźnika, numer śledzenia, oznaczenie przesyłki i status zdarzenia.
Sprzedawcy, którzy chcą gotowego procesu śledzenia Shopify zamiast niestandardowego projektu API, mogą rozważyć oficjalną aplikację 17TRACK Shopify. W przypadku aplikacji niestandardowej należy sprawdzić dokumentację 17TRACK API pod kątem aktualnych wymagań dotyczących uwierzytelniania, punktów końcowych, śledzenia i konta. Aplikacja i API rozwiązują powiązane, ale różne problemy implementacyjne; bez przetestowania wymaganego procesu nie należy przedstawiać jednego z nich jako zamiennika drugiego.
Praktyczny plan rozpoczęcia
- Opisz wynik w kategoriach biznesowych. Na przykład: „Wysyłaj opłacone zamówienia do magazynu w określonym czasie obsługi” albo „Pokazuj klientom postęp przesyłki po przypisaniu numeru śledzenia”.
- Wymień systemy i właścicieli. Określ, kto jest właścicielem produktów, zapasów, zamówień, realizacji, zdarzeń śledzenia i powiadomień klientów.
- Utwórz mapę pól. Uwzględnij identyfikatory, znaczniki czasu, wartości statusów, adresy, ilości, kody przewoźników, numery śledzenia i pola błędów. Oznacz pola wymagane, opcjonalne, tylko do odczytu i przekształcane.
- Potwierdź aktualną dokumentację. Sprawdź wersję API Shopify, metodę uwierzytelniania, zakresy dostępu, wymagania webhooków, sposób paginacji i limity zapytań. Sprawdź odpowiednią dokumentację każdej zewnętrznej platformy.
- Zbuduj ograniczony dowód koncepcji. Rozpocznij od małego sklepu testowego lub kontrolowanego zbioru danych. Sprawdź uwierzytelnianie, jedną ścieżkę odczytu, jedną ścieżkę zapisu, jeśli jest potrzebna, oraz jeden przepływ sterowany zdarzeniami, zanim dodasz każdy typ obiektu.
- Dodaj idempotencję i uzgadnianie. Powtórzony webhook lub ponowienie nie może tworzyć zduplikowanych przesyłek, wiadomości do klientów ani korekt zapasów. Zaplanuj kontrole uzgadniające w celu wykrywania pominiętych lub odrzuconych rekordów.
- Przetestuj wyjątki operacyjne. Uwzględnij anulowane zamówienia, edytowane adresy, przesyłki podzielone, częściową realizację, brakujące numery śledzenia, nieprawidłowe kody przewoźników, zduplikowane zdarzenia, ograniczanie liczby żądań API, wygasłe dane uwierzytelniające i opóźnione aktualizacje przewoźników.
- Wdróż z monitorowaniem. Śledź pomyślne i nieudane zdarzenia, wiek kolejki, błędy odpowiedzi API, czas przetwarzania i rekordy wymagające ręcznego działania. Określ, kto otrzymuje alerty i jak ponownie odtwarzane są błędy.
Kiedy użyć łącznika, aplikacji niestandardowej lub API śledzenia
| Opcja | Zwykle pasuje do | Najważniejsze kontrole przed wyborem |
|---|---|---|
| Łącznik lub narzędzie automatyzacji | Standardowych przepływów pracy z ograniczonym dostosowaniem | Obsługiwane obiekty, opóźnienia zdarzeń, obsługa błędów, limity zadań i przechowywanie danych |
| Niestandardowa aplikacja lub usługa Shopify | Specyficznych reguł biznesowych, wielu systemów lub kontrolowanych procesów wewnętrznych | Odpowiedzialność za rozwój, bezpieczeństwo, monitorowanie, utrzymanie API i całkowity koszt operacyjny |
| API śledzenia | Niestandardowego doświadczenia po zakupie lub widoczności przesyłek | Wymagania przewoźników i regionów, cykl życia śledzenia, sposób aktualizacji, limity i warunki handlowe |
Łącznik nie jest automatycznie prostszy, jeśli przepływ pracy wymaga niestandardowych ponowień lub złożonego uzgadniania. Z drugiej strony integracja niestandardowa nie jest automatycznie lepsza, jeśli standardowa, dobrze obsługiwana aplikacja już spełnia wymagania. Najbardziej uzasadnionym wyborem jest najmniejsza implementacja spełniająca wymagania dotyczące danych, niezawodności, bezpieczeństwa i operacji.
Lista kontrolna bezpieczeństwa i niezawodności
- Stosuj zakresy dostępu zgodne z zasadą najmniejszych uprawnień i przeglądaj je przy zmianach integracji.
- Przechowuj tokeny i sekrety poza kodem aplikacji oraz zmieniaj je w ramach kontrolowanego procesu.
- Weryfikuj autentyczność webhooków zgodnie z dokumentacją platformy.
- Szyfruj dane podczas przesyłania i ograniczaj dostęp administracyjny do logów oraz rekordów klientów.
- Stosuj przetwarzanie idempotentne, aby ponowienia nie powtarzały skutków ubocznych.
- Przechowuj identyfikatory systemów źródłowych i znaczniki czasu zdarzeń na potrzeby audytu i uzgadniania.
- Oddziel dane uwierzytelniające testowe od produkcyjnych i unikaj używania rzeczywistych danych klientów do przypadkowych testów.
- Przed kopiowaniem danych osobowych do innej usługi przeanalizuj obowiązki dotyczące prywatności, przechowywania i usuwania danych.
- Monitoruj wersje API i planuj prace aktualizacyjne przed zmianą obsługiwanej wersji.
FAQ
Czy integracja API Shopify jest tym samym co instalacja aplikacji Shopify?
Nie. Aplikacja Shopify może korzystać z API Shopify, ale instalacja aplikacji jest działaniem wdrożeniowym wykonywanym przez sprzedawcę. Integracja API to szersze połączenie między Shopify a innym systemem. Może być realizowana za pośrednictwem aplikacji publicznej, aplikacji niestandardowej, usługi wewnętrznej lub łącznika.
Którego API Shopify powinienem użyć?
Wybierz API na podstawie danych i procesu, a następnie potwierdź aktualne zalecenie w dokumentacji Shopify. W przypadku administracyjnych danych sklepu często stosowaną opcją jest Admin GraphQL API, ale dla konkretnego zastosowania należy sprawdzić uwierzytelnianie, uprawnienia, dostępność obiektów i obsługę wersji.
Czy Shopify może samodzielnie dostarczać aktualizacje śledzenia przewoźników?
Shopify może przechowywać informacje o realizacji i śledzeniu, ale pełne doświadczenie śledzenia zależy od sposobu pozyskiwania, normalizowania, wyświetlania i przekazywania zdarzeń przesyłki. Proces obejmujący wielu przewoźników lub wysyłkę międzynarodową może wymagać dedykowanej usługi śledzenia albo innej warstwy integracji.
Czy powinienem używać webhooków czy odpytywania?
Webhooki są zazwyczaj przydatne do reagowania na zmiany, natomiast kontrolowane odczyty API służą do walidacji, uzgadniania i odzyskiwania danych. Integracje produkcyjne zwykle korzystają z obu metod, zamiast polegać wyłącznie na jednej z nich.
Ile trwa integracja API Shopify?
Nie ma jednej wiarygodnej osi czasu. Podstawowy łącznik można skonfigurować szybko, natomiast niestandardowa integracja obejmująca zapasy, realizację, dane klientów, wielu przewoźników i uzgadnianie wymaga więcej projektowania i testów. Lepszymi czynnikami prognostycznymi niż samo połączenie z Shopify są liczba systemów, reguły wyjątków, przegląd bezpieczeństwa i mechanizmy kontroli wdrożenia.
