Dzięki udostępnieniu nowej wersji API oraz mechanizmu Webhooków, możliwa jest płynna, nielimitowana integracja systemu NFHotel z zewnętrznymi aplikacjami. Wykorzystanie Webhooków pozwala na otrzymywanie natychmiastowych alertów o zdarzeniach w systemie, co eliminuje konieczność ciągłego odpytywania serwera i znacznie optymalizuje wymianę danych.
Wymagania wstępne
Dostęp do samodzielnej konfiguracji publicznego API wymaga aktywacji usługi przez obsługę systemu. W tym celu należy skontaktować się z działem wsparcia NFHotel.
Łączenie z API
Endpointy NFHotel Public API są dostępne pod adresem https://api.nfnext.nfhotel.pl/
Tworzenie klucza API
Przejdź za pomocą panelu nawigacyjnego do Menu > Ustawiania > Inne ustawienia > API. Wybierz opcję dodania nowego klucza.
2. Wprowadź nazwę własną dla generowanego połączenia, która ułatwi jego późniejszą identyfikację.
3. Zaznacz na liście zasoby i uprawnienia, do których zewnętrzna aplikacja ma posiadać dostęp (osobno dla odczytu, osobno dla tworzenia). Zatwierdź konfigurację.
4 Skopiuj wygenerowany klucz i zapisz go w bezpiecznym miejscu.
UWAGA! Zgodnie z komunikatem systemowym klucz jest widoczny tylko raz, natychmiast po jego utworzeniu. Jeśli opuścisz ten widok bez zapisania ciągu znaków, konieczne będzie wygenerowanie nowego klucza.
Zarządzanie kluczami i bezpieczeństwo
Ze względów bezpieczeństwa system nie umożliwia edycji uprawnień oraz ponownego wyświetlenia klucza. W przypadku wycieku danych lub podejrzenia, że klucz trafił w niepowołane ręce, należy natychmiast go dezaktywować za pomocą opcji unieważnienia, znajdującej się przy konkretnym rekordzie na liście kluczy.
Konfiguracja Webhooków
Webhooki działają całkowicie niezależnie. Skonfigurowanie klucza API nie jest wymagane, aby móc odbierać powiadomienia o akcjach w systemie.
Przejdź do panelu konfiguracyjnego w Menu > Ustawiania > Inne ustawienia > Webhooki
Wybierz z listy typ zdarzenia, o którym system NFHotel ma informować Twoją aplikację (na przykład utworzenie nowej rezerwacji).
Wprowadź docelowy Adres URL endpoint, pod który system będzie wysyłał pakiety danych.
Zapisz ustawienia, aby aktywować wysyłanie alertów.
Dokumentacja techniczna
Pełny dokument OpenAPI opisujący strukturę żądań oraz dostępne punkty końcowe można pobrać bezpośrednio ze strony głównej dokumentacji pod adresem: NFHotel API
Struktura operacji opiera się na podstawowych metodach: pobieranie danych realizowane jest poprzez zapytania GET, tworzenie nowych zasobów wymaga metody POST, a zewnętrzna edycja danych obsługiwana jest przez PUT.
W razie potrzeby obsługi niestandardowych zdarzeń poprzez Webhooki, należy skontaktować się z działem technicznym.