Jak połączyć Sanity zShopify Flow
Połącz Sanity z Shopify Flow przez webhooki z weryfikacją HMAC i reaguj na publikację treści: tagi, notatki do zamówień, e-maile i aktualizacje metapól.
Sanity wysyła webhook oparty na technologii GROQ za każdym razem, gdy tworzona, aktualizowana lub usuwana jest treść odpowiadająca Państwa zapytaniu. 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ć adnotację do zamówienia, wysłać wewnętrzną wiadomość e-mail, zaktualizować metapole - czyli wykonać dowolną czynność, do której umożliwia Shopify Flow.
Niniejszy przewodnik opisuje cały proces - Sanity 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 Sanity, dzięki czemu wyłącznie Sanity może uruchomić Państwa przepływ pracy.
Co można zbudować
- Proszę zaktualizować metapole w Shopify w momencie zmiany odpowiadającego mu wpisu w systemie CMS, tak aby strona sklepu była zawsze zsynchronizowana.
- Prosimy o wysłanie wiadomości e-mail do zespołu ds. merchandisingu po opublikowaniu strony docelowej.
- Po opublikowaniu treści należy uruchomić proces odświeżania pamięci podręcznej.
Typowe zdarzenia, które należy zgłaszać: opublikowanie dokumentu, aktualizacja dokumentu, usunięcie dokumentu.
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 Sanity z uprawnieniami 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
Sanity events. - W sekcji Uwierzytelnianie proszę wybrać opcję HMAC.
- W sekcji Dostawca podpisu proszę wybrać opcję Sanity. Aplikacja automatycznie wypełni pola dotyczące nagłówka, algorytmu, podpisanej treści oraz okna odtworzenia - nie ma potrzeby konfigurowania żadnych innych ustawień.
- 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 - Dodaj punkt końcowy w serwisie Sanity
W serwisie Sanity proszę przejść do sekcji API -> Webhooki, utworzyć webhook oparty na GROQ, podając skopiowany adres URL, a następnie ustawić klucz tajny.
Jak znaleźć swój sekret podpisowy w systemie Sanity
Ustawiono opcję „The Secret” w webhooku obsługiwanym przez GROQ.
Własna dokumentacja serwisu Sanity 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 webhooka w sekcji Workflow Webhooks i zapisz zmiany. Od tego momentu każda dostawa z serwisu Sanity będzie weryfikowana, zanim trafi do Shopify Flow.
Co to sprawdza
| Co | Wartość |
|---|---|
| Nagłówek podpisu | sanity-webhook-signature |
| Miejsce umieszczenia podpisu | W wartości v1 tego nagłówka, zawierającej pary key=value, oddzielone przecinkami |
| Co zostało podpisane | {timestamp}.{body} |
| Podpis | HMAC-SHA256, zakodowany w formacie base64url |
| Sygnatura czasowa | Wartość t w nagłówku podpisu, wyrażona w milisekundach systemu Unix |
| 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 {body} stanowi surową treść żądania, bajt po bajcie, a {timestamp} to powyższy znacznik czasu.
Żą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 aplikacji Sanity (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 proszę dodać pierwszy warunek oparty na identyfikatorze webhooka, aby ten przepływ pracy dotyczył wyłącznie serwisu Sanity. 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 systemie Sanity. W sekcji Workflow Webhooks → Historia powinno być widoczne 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 cokolwiek pomiędzy Sanity 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ą Sanity, czy wpisano klucz tajny oraz czy Sanity wysyła dane na adres URL dokładnie taki, jak pokazany 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 serwisie Sanity oraz przejrzeć własny dziennik dostarczania serwisu Sanity 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 - zobacz 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 Sanity.
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 Sanity ponawia próbę dostarczenia wiadomości.
- Historia i rozwiązywanie problemów - dziennik wszystkich żądań wraz z możliwością odtworzenia.