Jak połączyć Sendcloud zShopify Flow
Połącz Sendcloud z Shopify Flow przez webhooki z weryfikacją HMAC. Zmiany statusu przesyłek dodają tagi, notatki do zamówień lub wysyłają e-maile.
Sendcloud zajmuje się wysyłką i śledzeniem przesyłek. Wysyła webhook za każdym razem, gdy status przesyłki ulega zmianie. Workflow Webhooks przekształca to wywołanie w wyzwalacz Shopify Flow, dzięki czemu Państwa sklep może na nie zareagować: oznaczyć klienta, dodać notatkę do zamówienia, wysłać wewnętrzną wiadomość e-mail, zaktualizować metapole - czyli wykonać każdą czynność, do której umożliwia Shopify Flow.
W niniejszym przewodniku opisano cały proces - Sendcloud wysyła dane, Workflow Webhooks je odbiera i weryfikuje, a Shopify Flow podejmuje odpowiednie działania - przy czym przy każdym żądaniu sprawdzany jest podpis HMAC firmy Sendcloud, dzięki czemu wyłącznie Sendcloud może uruchomić Państwa przepływ pracy.
Co można zbudować
- Proszę dodać adnotację do zamówienia w momencie dostarczenia przesyłki, bez konieczności sprawdzania stanu za pomocą interfejsu API przewoźnika.
- W przypadku niepowodzenia dostawy prosimy o wysłanie wiadomości e-mail do przedstawiciela przydzielonego klientowi.
- Prosimy o oznaczanie zamówień, których realizacja trwa dłużej niż przewidywano, aby dział obsługi klienta mógł podjąć odpowiednie działania.
Typowe zdarzenia, które należy zgłaszać: zgłoszenie przesyłki, przesyłka w drodze, doręczenie przesyłki, nieudana próba doręczenia.
Zanim zaczną Państwo
- Webhooki Workflow Webhooks zainstalowane w Państwa sklepie Shopify.
- Zainstalowano aplikację Shopify Flow, którą można pobrać bezpłatnie ze sklepu Shopify App Store.
- Konto w serwisie Sendcloud z uprawnieniem do tworzenia webhooków.
Krok 1 - Utwórz webhook w sekcji Workflow Webhooks
- Proszę otworzyć sekcję Workflow Webhooks → Webhooks → Utwórz webhook i nadać mu nazwę, którą będą Państwo w stanie rozpoznać w Shopify Flow, na przykład
Sendcloud events. - W sekcji Uwierzytelnianie proszę wybrać opcję HMAC.
- W sekcji Dostawca podpisu proszę wybrać Sendcloud. Aplikacja automatycznie wypełni pola dotyczące nagłówka, algorytmu, podpisanej treści oraz okna powtórki - nie ma potrzeby konfigurowania niczego więcej.
- Na razie proszę pozostawić pole „secret” puste i kliknąć Zapisz. Proszę skopiować adres URL webhooka wyświetlony na stronie.
Informacje na temat pozostałych trybów uwierzytelniania można znaleźć w sekcji Uwierzytelnianie, a informacje dotyczące wyboru pól, które mają zostać przesłane do Shopify Flow - w sekcji Mapowanie danych użytkowych i zmienne w Shopify Flow.
Krok 2 - Proszę dodać punkt końcowy w Sendcloud
W serwisie Sendcloud proszę otworzyć ustawienia integracji i ustawić adres URL webhooka na skopiowany adres. Klucz tajny integracji służy do podpisywania żądania.
Jak znaleźć swój klucz tajny do logowania w serwisie Sendcloud
Klucz tajny integracji (lub klucz podpisu webhooka).
W dokumentacji Sendcloud dotyczącej podpisów webhooków znajdą Państwo dokładne sformułowania oraz zrzuty ekranu dotyczące Państwa konta.
Wklej ten klucz tajny w polu Secret webhooka w sekcji Workflow Webhooks i zapisz. Od tego momentu każda przesyłka Sendcloud będzie weryfikowana przed dotarciem do Shopify Flow.
Co to sprawdza
| Co | Wartość |
|---|---|
| Nagłówek podpisu | Sendcloud-Signature |
| Miejsce umieszczenia podpisu | Cała wartość nagłówka |
| Co zostało podpisane | {body} |
| Podpis | HMAC-SHA256, zakodowany w systemie szesnastkowym |
| Sygnatura czasowa | Nie jest używane przez tego nadawcę |
| Ochrona przed ponownym odtworzeniem | Brak - ten nadawca nie podpisuje znacznika czasu, więc każdy ważny podpis zachowuje swoją ważność |
| Sekret | Należy użyć jako zwykły tekst. Proszę wkleić go dokładnie tak, jak przedstawił go nadawca |
W podpisanej treści żądania {body} stanowi surową treść żądania, bajt po bajcie.
Żądanie, które nie spełnia któregokolwiek z tych warunków, jest odrzucane z kodem błędu 401, rejestrowane w sekcji Historia i rozwiązywanie problemów i nigdy nie uruchamia przepływu pracy.
Krok 3 - Utwórz proces w Shopify Flow
- W Shopify Flow proszę utworzyć przepływ pracy i wybrać wyzwalacz Workflow Webhooks.
- Proszę kliknąć opcję Rejestruj zdarzenia, a następnie wysłać zdarzenie testowe z Sendcloud (lub skorzystać z opcji Wyślij test w sekcji Workflow Webhooks), aby Shopify Flow rozpoznał strukturę Państwa danych.
- Każdy posiadany przez Państwa webhook uruchamia ten sam wyzwalacz w Shopify Flow, dlatego prosimy o dodanie pierwszego warunku opartego na identyfikatorze webhooka, aby ten przepływ pracy dotyczył wyłącznie Sendcloud. Identyfikator ten jest widoczny na stronie webhooka.
- Proszę dodać swoje działania - oznaczyć klienta, dodać notatkę, wysłać wewnętrzną wiadomość e-mail, zaktualizować metapole.
Krok 4 - Przeprowadź test od początku do końca
Wywołaj rzeczywiste zdarzenie w Sendcloud. W sekcji Workflow Webhooks → Historia powinno pojawić się wywołanie o statusie Success. Jeśli podpis był nieprawidłowy, pojawi się zamiast tego wpis o niepowodzeniu wraz z przyczyną, a Weryfikacja podpisanych webhooków zawiera wyjaśnienie narzędzia do weryfikacji podpisu, które wskazuje dokładnie, który etap zakończył się niepowodzeniem.
Podpis nie jest zgodny
W następującej kolejności: klucz tajny (najczęstsza przyczyna - dodatkowa spacja lub klucz z niewłaściwego środowiska), czy nadawca korzysta z klucza tajnego innego punktu końcowego oraz czy coś pomiędzy Sendcloud a aplikacją zmienia treść wiadomości. Podpisy obejmują surowe bajty, więc serwer proxy, który zmienia format JSON, powoduje ich uszkodzenie. Narzędzie do sprawdzania podpisów na stronie webhooka wyświetla dokładny tekst, który został podpisany.
Przy każdym żądaniu otrzymuję kod błędu 401
Proszę sprawdzić, czy w ustawieniach uwierzytelniania webhooka wybrano opcję HMAC z wybranym dostawcą Sendcloud, czy wprowadzono klucz tajny oraz czy Sendcloud wysyła dane na adres URL dokładnie taki, jak wyświetla go aplikacja, łącznie z kodem na końcu.
W historii nie ma żadnych wpisów
Żądanie nigdy nie dotarło. Proszę ponownie sprawdzić adres URL w Sendcloud oraz zapoznać się z dziennikiem dostaw Sendcloud, aby sprawdzić otrzymaną odpowiedź. Kod 404 oznacza nieprawidłowy lub usunięty webhook, a kod 429 oznacza przekroczenie limitu wywołań przewidzianego w Państwa planie - proszę zapoznać się z sekcją Plany i sposób użytkowania.
Proces jest uruchamiany dla niewłaściwych zdarzeń
Każdy webhook w Państwa sklepie uruchamia ten sam wyzwalacz w Shopify Flow. Proszę dodać warunek oparty na identyfikatorze webhooka jako pierwszy krok przepływu pracy lub zawęzić zakres zdarzeń wysyłanych z Sendcloud.
Powiązane
- Weryfikacja podpisanych webhooków - każdy dostawca, którego weryfikujemy, oraz sposób opisania dostawcy, którego nie weryfikujemy.
- Mapowanie danych użytkowych i zmienne w Shopify Flow - pobieranie odpowiednich pól z danych przesyłanych i wprowadzanie ich do Shopify Flow.
- Ochrona przed podwójną dostawą - co się dzieje, gdy Sendcloud ponawia próbę doręczenia.
- Historia i rozwiązywanie problemów - dziennik wszystkich żądań wraz z możliwością odtworzenia.