SaveTo Wishlist dla WooCommerce
Zacznij
Jak zabezpieczyć punkt końcowy webhook API SaveTo Wishlist Pro - SaveTo Wishlist
  1. Strona główna
  2. Baza wiedzy
  3. Lista życzeń
  4. Automatyzacje
  5. Jak zabezpieczyć punkt końcowy webhook SaveTo Wishlist Pro API
  1. Strona główna
  2. Baza wiedzy
  3. Lista życzeń
  4. Konfiguracja i ustawienia
  5. Jak zabezpieczyć punkt końcowy webhook SaveTo Wishlist Pro API

Jak zabezpieczyć punkt końcowy webhook SaveTo Wishlist Pro API

Wysyłasz zdarzenia listy życzeń do swojego sklepu z innego systemu? Przychodzący webhook SaveTo Wishlist Pro wymaga teraz klucza API przed zaakceptowaniem czegokolwiek, więc witryna, która go nie wygenerowała, odrzuca każde żądanie zamiast je akceptować bez sprawdzania. Dotyczy to miejsca, w którym generuje się ten klucz, jak integracja powinna go wysyłać i czego można się spodziewać, jeśli brakuje go lub jest nieprawidłowy. Wysyłanie zdarzeń w drugą stronę, z Twojego sklepu, jest opisane w Jak połączyć zewnętrzne narzędzia za pomocą webhooków listy życzeń.

Zanim zaczniesz

  • SaveTo Wishlist Pro jest zainstalowany i aktywny.
  • Masz dostęp do systemu zewnętrznego, który będzie wysyłał zdarzenia listy życzeń, dzięki czemu możesz przechowywać klucz, którego potrzebuje do wysyłania z każdym żądaniem.

Wygeneruj klucz API webhooka

Dopóki klucz nie istnieje, punkt końcowy webhook odrzuca każde żądanie, więc jest to pierwsza rzecz do zrobienia.

  1. Przejdź do SaveTo Wishlist > Ustawienia.
  2. Kliknij zakładkę Ogólne.
  3. W sekcji Webhook API kliknij Wygeneruj klucz API i potwierdź, gdy zostaniesz o to poproszony.
  4. Skopiuj wartość, która pojawi się w polu Klucz API Webhooka Listy Życzeń.
Sekcja API Webhook w zakładce ustawień ogólnych, pokazująca pole Klucz API Webhooka Listy Życzeń i przycisk Wygeneruj klucz API

Pole Klucz API Webhooka Listy Życzeń akceptuje również klucz, który wpiszesz samodzielnie, jeśli Twój system zewnętrzny musi dostarczyć własną wartość zamiast używać wygenerowanej. W obu przypadkach kliknij Zapisz zmiany, aby go zapisać.

Wyślij klucz ze swoimi żądaniami

Skonfiguruj swój system zewnętrzny, aby wysyłał klucz przy każdym wywołaniu POST /wp-json/saveto-wishlist-pro/v1/webhook/wishlist-created. Istnieją dwa sposoby jego wysłania:

  • Jako nagłówek żądania x-api-key. Jest to preferowana metoda.
  • Jako parametr zapytania api_key, jeśli Twój system nie może ustawić niestandardowych nagłówków.

Skopiuj klucz dokładnie tak, jak pojawia się w polu Klucz API Webhooka Listy Życzeń, bez dodawania dodatkowych spacji ani znaków nowej linii przed lub po nim. Porównanie jest wrażliwe na wielkość liter, więc klucz, który nie pasuje dokładnie, jest traktowany tak samo jak brakujący.

Co się dzieje, gdy klucz brakuje lub jest nieprawidłowy

Żądanie bez prawidłowego klucza otrzymuje odpowiedź 401 Unauthorized zamiast być przetwarzane, niezależnie od tego, czy klucz całkowicie brakuje, nie pasuje do tego, co jest zapisane w Ustawieniach, czy też nie został jeszcze wygenerowany w Twoim sklepie. Dotyczy to nawet witryny, która nigdy nie wygenerowała klucza: bez niczego zapisanego do porównania, każdy dzwoniący jest odrzucany zamiast przepuszczany.

Ponowne kliknięcie Wygeneruj klucz API natychmiast zastępuje zapisany klucz. Każdy system nadal wysyłający stary klucz zaczyna być od razu odrzucany, więc zaktualizuj swoją integrację z nową wartością, jak tylko ją ponownie wygenerujesz.

Rozwiązywanie problemów

Każde żądanie do webhooka zwraca odpowiedź 401

Sprawdź, czy klucz został faktycznie wygenerowany w SaveTo Wishlist > Ustawienia > Ogólne, w sekcji API Webhook. Jeśli pole jest puste, wygeneruj klucz i zapisz zmiany. Jeśli klucz już istnieje, upewnij się, że integracja wysyła go jako nagłówek x-api-key (lub parametr zapytania api_key) i że został skopiowany bez żadnych białych znaków.

Integracja działała wcześniej, ale teraz każde żądanie kończy się niepowodzeniem

Zwykle oznacza to, że klucz został ponownie wygenerowany w zakładce Ogólne od czasu ostatniej aktualizacji integracji. Generowanie nowego klucza natychmiast zastępuje stary, więc zaktualizuj system wywołujący bieżącą wartością z pola Klucz API Webhooka Listy Życzeń.

Często zadawane pytania

Co się stanie, jeśli nigdy nie wygeneruję klucza?

Punkt końcowy webhooka odrzuca każde żądanie. Pusty klucz nigdy nie będzie pasował do niczego, co wysyła dzwoniący, więc jest to równoznaczne z wyłączeniem punktu końcowego.

Czy mogę użyć ciągu zapytania zamiast nagłówka?

Tak. Wyślij api_key=twój-klucz jako parametr zapytania, jeśli Twój system nie może ustawić nagłówka x-api-key. Nagłówek jest sprawdzany jako pierwszy, więc ma pierwszeństwo, jeśli oba są obecne.

Czy ponowne generowanie klucza psuje moją istniejącą integrację?

Tak, natychmiast. Poprzedni klucz przestaje działać, gdy tylko ponownie klikniesz Wygeneruj klucz API, więc generuj go ponownie tylko wtedy, gdy jesteś gotów jednocześnie zaktualizować system wywołujący nową wartością.

Potrzebujesz pomocy?

Czy ten artykuł był pomocny?

Powiązane artykuły

Potrzebujesz wsparcia?

Nie możesz znaleźć odpowiedzi, której szukasz?
Skontaktuj się z pomocą techniczną
Dokończ zakup