Dokumenty

Przewodnik po API

Przykłady API opisują jedynie wzorce integracji i muszą być zgodne z zaimplementowanymi punktami końcowymi Shield-API.

RDZEŃ TARCZYNiebieski protokół bezpieczeństwa

Szczegóły

Jasne stwierdzenia i wyraźne granice

Konfiguracja

Używaj podstawowych adresów URL i kluczy API specyficznych dla środowiska. Obróć klucze z nakładającymi się oknami, aby usługi mogły być bezpiecznie wdrażane.

Weryfikacja webhooka

Przed zaakceptowaniem zdarzenia sprawdź nagłówek podpisu, znacznik czasu i bajty treści. Traktuj zduplikowane dostarczanie jak zwykle i przetwarzaj idempotentnie.

Zachowanie incydentalne

Zdefiniuj z góry, czy każdy przepływ nie zostanie otwarty, czy zamknięty, kto będzie stronicowany i w jaki sposób obsługiwane będą ręczne zatwierdzenia w przypadku pogorszonej pracy.