Poniższy artykuł przybliży Ci koncepcję webhooków oraz przedstawi praktyczne wskazówki dotyczące ich wykorzystania do efektywnej integracji z systemem Lockme.
Co to jest Webhook?
Webhook jest to adres URL, na który wysyłane są informacje o zdarzeniach. W przypadku Lockme są to zdarzenia rezerwacji (dodawanie, edytowanie i usuwanie rezerwacji). Szczegółowe informacje na temat webhooków można znaleźć w następujących źródłach:
Jak stworzyć integrację z webhookiem?
Konfiguracja integracji została umieszczona w zakładce Rezerwacje, dostępnej w profilu firmowym.
- Zaloguj się na profil firmowy.
- Następnie przejdź do zakładki “Integracje” i dodaj nową integrację.
- Zaznacz oddział, do którego ma zostać przypisana integracja.
- Wybierz integrację typu Webhook z dostępnych opcji.
- Zdefiniuj własną nazwę dla tej integracji.
- Stwórz integrację i przejdź dalej.
- Zmień status integracji na aktywny (WAŻNE: Nie możesz usunąć integracji, ale możesz ją aktywować lub dezaktywować).
- Zdecyduj się na konkretną wersję API. W razie wątpliwości, wybierz najnowszy wariant.
- Wprowadź adres URL Webhook i zatwierdź zmiany.
W jakim formacie wysyłane są zdarzenia z Lockme?
Zdarzenia z Lockme wysyłane są jako zapytanie typu POST na adres zdefiniowany dla webhooka. Treść zapytania jest pusta, a w nagłówkach znajdują się:
- User-Agent z wartością LockMe/1.0
- X-MessageId zawierające identyfikator wiadomości.
Jak odczytać szczegóły wiadomości?
Szczegóły wiadomości należy pobrać za pomocą naszego API, wysyłając zapytanie GET /message/{messageid}, gdzie messageid to identyfikator wiadomości z nagłówków. Po obsłużeniu zdarzenia po swojej stronie należy oznaczyć wiadomość jako odczytaną przez wysłanie zapytania POST /message/{messageid}. W przeciwnym wypadku wiadomość o tym samym zdarzeniu będzie ponawiana przez 24 godziny w rosnących interwałach.
O czym warto pamiętać?
- Zawsze dokładnie zapoznaj się z dokumentacją API, aby uzyskać szczegółowe informacje o oczekiwanym formacie danych i innych wymaganiach.
- Przygotuj się na potencjalne błędy, takie jak problemy z połączeniem sieciowym, nieprawidłowy format danych czy błędy autoryzacji.
- Regularnie monitoruj działanie webhooków, aby wykryć ewentualne problemy i zapewnić niezawodność integracji.
Nie wszystko jasne?
Skontaktuj się z nami: [email protected].