Webhook

Webhook jest sygnałem dla Systemu Klienta, że na danym Koncie zaszły pewne zmiany. W wywołaniu webhooka nie są zawarte, żadne dane dotyczące Konta, a jedynie jego identyfikator. Po otrzymaniu webhooka System Klienta może pobrać aktualne szczegóły Konta oraz listę opłat metodą GET. W celu odbierania webhooków, System Klienta musi obsługiwać żądania POST na ścieżce wskazanej w konfiguracji (szerzej opisane w dokumentacji API REST). Zasada działania Webhooka zostałą przedstawiona poniżej:

  1. Przy każdej zmianie statusu Konta, wywoływany jest Webhook zawierający identyfikator tego Konta (accountId).
  2. System Klienta sprawdza, czy dane Konto istnieje w jego systemie.
  3. Jeśli Konto istnieje, System Klienta pobiera szczegóły danego Konta, zawierające między innymi status danych uwierzytelniających, status synchronizacji, datę ostatniej synchronizacji.
  4. System Klienta zapisuje szczegóły Konta.
  5. Jeśli data ostatniej synchronizacji jest inna od tej zapisanej po stronie Systemu Klienta, System Klienta dodatkowo pobiera najnowsze dane dotyczące opłat. Zwracana jest zawsze pełna lista wszystkich opłat. System Klienta powinien zaktualizować dane korzystając z identyfikatorów opłaty:
    • Pojawiła się nowa opłata - należy ją dodać,
    • Brakuje opłaty, która była w poprzedniej synchronizacji - należy ją usunąć,
    • Dane pozostałych opłat (kwoty, terminy, numer konta itp.) - należy zaktualizować.

alt text