Jak połączyć Svix zShopify Flow

Jak połączyć Svix zShopify Flow

Skopiuj stronę

Połącz Svix z Shopify Flow: weryfikuj podpisy HMAC i uruchamiaj przepływy pracy po zdarzeniach webhook z Clerk, Resend czy Superwall.

Svix to infrastruktura webhooków stanowiąca podstawę działania serwisów Clerk, Resend, Superwall oraz wielu innych produktów. Jeśli Państwa nadawca korzysta z usług Svix, to ustawienie to pozwala to zweryfikować. Funkcja 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 - Svix wysyła dane, usługa Workflow Webhooks je odbiera i weryfikuje, a Shopify Flow podejmuje odpowiednie działania - przy czym w każdym żądaniu sprawdzany jest podpis HMAC serwisu Svix, dzięki czemu wyłącznie Svix może uruchomić Państwa przepływ pracy.

Co można zbudować

  • Proszę oznaczyć klienta Shopify, gdy aplikacja Clerk zgłosi, że zarejestrował się on lub zweryfikował swój adres e-mail w Państwa aplikacji.
  • Proszę zareagować na zdarzenie związane z ponownym wysłaniem przesyłki lub zwrotem przesyłki oraz oznaczyć klienta, którego adres jest nieprawidłowy.
  • Odbieraj dane z dowolnego produktu opartego na technologii Svix bez konieczności konfigurowania niestandardowego podpisu.

Typowe zdarzenia do wysłania: dowolne zdarzenie zdefiniowane przez usługę wysyłającą.

Ten sam profil weryfikuje również webhooki z serwisów Clerk, Resend i Superwall.

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 Svix z uprawnieniami do tworzenia webhooków.

Krok 1 - Utwórz webhook w sekcji Workflow Webhooks

  1. 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 Svix events.
  2. W sekcji Uwierzytelnianie proszę wybrać opcję HMAC.
  3. W sekcji Dostawca podpisu proszę wybrać Svix. Aplikacja automatycznie wypełni pola dotyczące nagłówka, algorytmu, podpisanej treści oraz okna odtwarzania - nie ma potrzeby konfigurowania niczego więcej.
  4. 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 - Dodanie punktu końcowego w Svix

Proszę dodać ten adres URL jako punkt końcowy w ustawieniach webhooka usługi wysyłającej, a następnie wyświetlić i skopiować jej klucz podpisujący (zaczyna się on od whsec_).

Jak znaleźć swój klucz tajny do podpisywania w systemie Svix

Klucz tajny do podpisywania punktów końcowych, którego nazwa zaczyna się od „whsec_”, pochodzący z ustawień webhooka tej usługi.

Własna dokumentacja serwisu Svix dotycząca podpisów webhooków zawiera dokładne sformułowania oraz zrzuty ekranu dotyczące Państwa konta.

Wklej ten klucz tajny w polu Secret (Klucz tajny) webhooka w sekcji Workflow Webhooks i zapisz zmiany. Od tego momentu każda dostawa z serwisu Svix będzie weryfikowana przed dotarciem do Shopify Flow.

Co to sprawdza

Co Wartość
Nagłówek podpisu svix-signature
Miejsce umieszczenia podpisu Wartość nagłówka, po przedrostku v1,
Co zostało podpisane {header:svix-id}.{timestamp}.{body}
Podpis HMAC-SHA256, zakodowany w formacie base64
Sygnatura czasowa Nagłówek svix-timestamp, wyrażony w sekundach systemu Unix
Ochrona przed ponownym odtworzeniem Żądania, których podpisany znacznik czasu odbiega od chwili obecnej o ponad 5 minut, są odrzucane
Sekret Przed użyciem należy zdekodować kod Base64. Przed dekodowaniem usuwa się przedrostek whsec_. Proszę wkleić tekst dokładnie tak, jak przedstawił go nadawca.

W podpisanej treści żądania {body} stanowi surową treść żądania, bajt po bajcie, {timestamp} to powyższy znacznik czasu, a {header:svix-id} to nagłówek żądania svix-id.

Żą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

  1. W Shopify Flow proszę utworzyć przepływ pracy i wybrać wyzwalacz Workflow Webhooks.
  2. Proszę kliknąć opcję Rejestruj zdarzenia, a następnie wysłać zdarzenie testowe z serwisu Svix (lub skorzystać z opcji Wyślij test w sekcji Workflow Webhooks), aby Shopify Flow rozpoznał strukturę Państwa danych.
  3. 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 Svix. Identyfikator ten jest widoczny na stronie webhooka.
  4. Proszę dodać swoje działania - oznaczyć klienta, dodać notatkę, wysłać wewnętrzną wiadomość e-mail, zaktualizować metapole.
Shopify Flow
W Shopify Flow wybierz opcję „Wybierz wyzwalacz”, otwórz sekcję Workflow Webhooks i wybierz opcję „Wyzwalacz webhook”.
Warunek w Shopify Flow: identyfikator webhooka jest równy identyfikatorowi jednego z webhooków
Pierwszy krok każdego przepływu pracy: warunek dotyczący identyfikatora webhooka, dzięki czemu przepływ pracy uruchamia się wyłącznie dla tego webhooka.
Gotowy przebieg procesu: wyzwalacz webhooka, warunek oparty na identyfikatorze webhooka, a następnie wysłanie wewnętrznej wiadomości e-mail w gałęzi „True”
Gotowy przepływ pracy: wyzwalacz, warunek oparty na identyfikatorze webhooka, a następnie Państwa akcja w gałęzi „True”.

Krok 4 - Przeprowadź test od początku do końca

Wywołaj rzeczywiste zdarzenie w systemie Svix. 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 podaną przyczyną, a Weryfikacja podpisanych webhooków zawiera wyjaśnienie dotyczące narzędzia do weryfikacji podpisu, które wskazuje dokładnie, który etap zakończył się niepowodzeniem.

Jedno wywołanie otwarte w sekcji „Historia” wraz z nagłówkami żądania, treścią, statusem, czasem trwania i identyfikatorami
Zrealizowane zdarzenie w module „Historia”: status „Powodzenie” oznacza, że Shopify Flow je zaakceptowało.
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 Svix 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 dostawcą Svix, czy wpisano klucz tajny oraz czy Svix wysyła dane na adres URL dokładnie taki, jak pokazano w aplikacji, łącznie z kodem na końcu.

W historii nie ma żadnych wpisów

Żądanie nigdy nie dotarło. Proszę ponownie sprawdzić adres URL w Svix oraz przejrzeć własny dziennik dostarczania Svix w celu uzyskania informacji o otrzymanej odpowiedzi. 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 serwisu Svix.

Żądania kończą się niepowodzeniem z komunikatem „znacznik czasu wykracza poza dopuszczalny zakres”

Svix podpisuje zdarzenie sygnaturą czasową, a aplikacja odrzuca wszystkie zdarzenia starsze niż 5 minut. Zazwyczaj wynika to z problemu z zegarem po stronie nadawcy lub z faktu, że Svix ponowił próbę dostarczenia znacznie później, zachowując pierwotną sygnaturę czasową. Ponowne próby wysłania tego samego pierwotnego żądania nie mogą zostać zaakceptowane; proszę poprosić Svix o wysłanie nowego zdarzenia.

Powiązane