Sat Sep 26 2020
...

Webhooks w FastComments

! Ten artykuł zawiera techniczne terminy

Co nowego

Dzięki FastComments teraz można wywołać punkt końcowy API za każdym razem, gdy komentarz zostanie dodany, zaktualizowany lub usunięty z naszego systemu.

Osiągamy to za pomocą asynchronicznych webhooków przez HTTP/HTTPS.

Jak to użyć

Najpierw przejdź do panelu administracyjnego Webhooków. Jest to dostępne przez Zarządzaj danymi -> Webhooki.

Stamtąd możesz określić punkty końcowe dla każdego typu zdarzenia komentarza.

Dla każdego typu zdarzenia, upewnij się, że klikniesz Wyślij testowy ładunek, aby upewnić się, że prawidłowo skonfigurowałeś swoją integrację. Zobacz następny dział, "Testowanie", aby uzyskać szczegóły.

Testowanie

W panelu administracyjnym Webhooków znajdują się przyciski "Wyślij testowy ładunek" dla każdego typu zdarzenia (Utworzenie, Aktualizacja, Usunięcie). Zdarzenia Utworzenia i Aktualizacji wysyłają obiekt WebhookComment jako próbkę, podczas gdy testowanie Usunięcia wyśle próbne ciało żądania tylko z identyfikatorem.

Test wykona dwa wywołania, aby zweryfikować kod odpowiedzi dla scenariuszy "szczęśliwych" (prawidłowy klucz API) i "smutnych" (nieprawidłowy klucz API).

Gdy test wyśle nieprawidłowy klucz API, powinieneś zwrócić kod statusu 401, aby test zakończył się powodzeniem. Jeśli nie sprawdzisz prawidłowo wartości tokena, zobaczysz błąd taki jak:

Struktura obiektu komentarza

/** * @typedef {Object} WebhookComment * @property {string} id * @property {string} urlId * @property {string} url * @property {string} userId * @property {string} commenterEmail * @property {string} commenterName * @property {string} comment * @property {string} commentHTML * @property {string} parentId * @property {DateString} date * @property {number} votes * @property {boolean} verified * @property {number} verifiedDate * @property {boolean} reviewed * @property {string} avatarSrc * @property {boolean} isSpam * @property {boolean} aiDeterminedSpam * @property {boolean} hasImages * @property {number} pageNumber * @property {boolean} approved * @property {string} locale */

Struktura zdarzenia "Utwórz"

Ciało żądania zdarzenia "utwórz" to obiekt WebhookComment.

Struktura zdarzenia "Aktualizuj"

Ciało żądania zdarzenia "aktualizuj" to obiekt WebhookComment.

Struktura zdarzenia "Usuń"

Ciało żądania zdarzenia "usuń" to obiekt WebhookComment, ale zawierający tylko identyfikator.

Dlaczego zarówno Utworzenie, jak i Aktualizacja korzystają z HTTP PUT, a nie POST?

Ponieważ wszystkie nasze żądania zawierają identyfikator, powtarzanie tego samego żądania Utworzenia lub Aktualizacji nie powinno tworzyć nowych obiektów po Twojej stronie. Oznacza to, że te wezwania są idempotentne i powinny być zdarzeniami PUT zgodnie ze specyfikacją HTTP.

Jak to działa

Wszystkie zmiany w obiekcie Komentarz w systemie wywołują zdarzenie, które trafia do kolejki. Możesz monitorować tę kolejkę w panelu administracyjnym Webhooków w przypadku, gdy Twoje API przestanie działać. Jeśli żądanie do Twojego API nie powiedzie się, ponownie je umieścimy w kolejce na harmonogramie. Ten harmonogram to 1 minuta * liczba prób. Jeśli wywołanie się nie powiedzie, spróbuje ponownie za minutę. Jeśli zawiedzie dwukrotnie, poczeka dwie minuty, i tak dalej. Dzieje się tak, aby nie obciążać Twojego API, jeśli przestaje działać z powodów związanych z obciążeniem.

Bezpieczeństwo i token API

W nagłówku żądania przekażemy Twój Sekret API w parametrze o nazwie "token".

Jeśli nie sprawdzisz prawidłowo tego parametru, Twoja integracja nie zostanie oznaczona jako Zweryfikowana. Jest to zabezpieczenie, aby zapewnić, że wszelkie integracje z FastComments są bezpieczne.

Podsumowując

Mamy nadzieję, że integracja Webhooków FastComments będzie dla Ciebie łatwa do zrozumienia i szybka do skonfigurowania.

Jeśli masz dalsze pytania, nie wahaj się skontaktować z stroną wsparcia klienta.

Pozdrawiamy!

Sat Sep 26 2020...