Przejdź do treści
Task, Channels and Partner API

Partner API: zarządzanie kluczami i webhookami

Dzięki Partner API połączysz własne strony rezerwacji, aplikacje i integracje ze STRYK. Tworzysz klucze z dokładnie potrzebnymi uprawnieniami i konfigurujesz webhooki.

Last updated: Owner, Developers
Contents
  1. Zanim zaczniesz
  2. Otwórz API
  3. Utwórz klucz API
  4. Zarządzanie kluczami API
  5. Konfiguracja webhooków
  6. Zarządzanie webhookami
  7. Tak sprawdzisz wynik
  8. Gdy coś nie działa
  9. Z tym wiąże się

Zanim zaczniesz

  • Potrzebujesz uprawnienia Zarządzaj kanałami. Tylko dzięki niemu zobaczysz wiersz API na stronie Kanały.
  • Ustal, które obszary integracja ma czytać lub zapisywać. Klucz dostaje tylko te uprawnienia.
  • Integracja wywołuje Partner API z własnego serwera. Klucza nigdy nie umieszczaj w kodzie przeglądarki ani w aplikacji. Endpointy, parametry i przykłady znajdziesz w Dokumentacji dla deweloperów. Sekcja Uwierzytelnianie i zakresy wyjaśnia, co daje każde uprawnienie.
  • Webhooki potrzebują odbiorcy z adresem zaczynającym się od https://.

Otwórz API

In STRYKKanały

  1. Wybierz w sekcji Własne połączenia wiersz API z dopiskiem „Klucze API i webhooki“. Otworzy się okno API.
  2. Wybierz zakładkę Klucze API lub Webhooki. Przyciskiem Dokumentacja dla deweloperów w nagłówku okna otworzysz portal deweloperski.
  1. Zakładki Klucze API i Webhooki
  2. Klucz z uprawnieniami
  3. Działania dla klucza

Utwórz klucz API

In STRYKKanałyAPIKlucze API

  1. Wybierz Utwórz klucz API. Otworzy się okno Utwórz klucz API.
  2. Wpisz Nazwa, na przykład „Strona rezerwacji“.
  3. Przy Uprawnienia wybierz wzór: Tylko odczyt (czytanie wszystkich obszarów), Odczyt i zapis (zapis tam, gdzie to możliwe) albo Niestandardowe. Przy Niestandardowe wybierasz dla każdego obszaru Brak dostępu, Odczyt lub Zapis. Obszary to Hotel i pokoje, Dostępność, Ceny i taryfy, Rezerwacje, Goście, Płatności i Faktury. Zapis obejmuje Odczyt. Faktury są dokumentami fiskalnymi hotelu i przez API można je tylko odczytywać.
  4. Opcjonalnie: otwórz Zaawansowany. Wybierz Wygaśnięcie: Bez wygaśnięcia, 30 dni, 90 dni, 1 rok albo Data (od jutra, najwyżej za trzy lata). Przy Ograniczenie IP wpisz w każdym wierszu adres albo sieć CIDR, najwyżej 20. Puste pole dopuszcza wszystkie adresy. W polu Uwaga zapisujesz wewnętrzną wskazówkę.
  5. Wybierz Utwórz. STRYK pokaże Utworzono klucz API z kluczem i informacją Widoczny tylko teraz.
  6. Skopiuj klucz i zapisz go na przykład w menedżerze haseł. Wybierz Gotowe.

Zarządzanie kluczami API

In STRYKKanałyAPIKlucze API

Lista pokazuje dla każdego klucza Nazwa, początek klucza, Uprawnienia, Utworzono, Ostatnio używany, Wygaśnięcie oraz status: Aktywny, Wkrótce wygasa, Odwołane albo Wygasły. Wybierz klucz, aby zobaczyć Uprawnienia, Wygaśnięcie, Dozwolone adresy IP, Limit zapytań (zapytania na minutę), Wykorzystanie, Ostatnie żądania i Historię.

  1. Otwórz w wierszu menu Opcje.
  2. Wybierz Wygeneruj nowy, gdy integracja ma dostać nowy klucz z tymi samymi uprawnieniami. Przy Dotychczasowy klucz wybierz Stary klucz ważny jeszcze 24 h, aby przestawić integrację, albo Unieważnij od razu. Potwierdź przyciskiem Wygeneruj nowy. STRYK pokaże nowy klucz jeden raz.
  3. Wybierz Odwołaj i potwierdź Unieważnić klucz API?, aby natychmiast zablokować klucz. Żądania z tym kluczem STRYK wtedy odrzuca.

Konfiguracja webhooków

In STRYKKanałyAPIWebhooki

Webhook wysyła wybrane zdarzenia podpisane przez HTTPS do twoich systemów.

  1. Wybierz Utwórz webhook. Otworzy się okno Nowy webhook.
  2. Wpisz Adres URL odbiorcy, na przykład https://crm.nordlicht.invalid/hooks/stryk. Adres musi zaczynać się od https://.
  3. Opcjonalnie: wpisz Opis, na przykład „Rezerwacje do naszego CRM“.
  4. Wybierz przy Wydarzenia co najmniej jedno: Rezerwacja utworzona, Rezerwacja zmieniona, Rezerwacja anulowana, Gość zmieniony, Dostępność zmieniona, Cena zmieniona, Płatność zmieniona albo Zmieniono status pokoju. Przyciskami Zaznacz wszystko i Wyczyść zaznaczenie wybierasz wszystkie albo żadne.
  5. Wybierz Utwórz webhook. STRYK pokaże Twój sekret podpisu jeden raz.
  6. Zapisz sekret u odbiorcy. Jak odbiorca sprawdza podpis, opisuje dokumentacja deweloperska w sekcji Webhooki i weryfikacja podpisu.
  7. Wybierz webhook, a następnie Wyślij zdarzenie testowe. STRYK zgłasza „Zdarzenie testowe jest dostarczane.“

Zarządzanie webhookami

Ort: Kanały > API > Webhooki, wybierz webhook

  • Przełącznikiem Doręczanie aktywne wstrzymujesz lub aktywujesz webhook. Wstrzymane webhooki nie dostają zdarzeń. Po aktywacji doręczanie zaczyna się od nowych zdarzeń.
  • Ostatnie 7 dni, Ostatni sukces i Ostatni błąd pokazują stan. W sekcji Dostawy widzisz każde doręczenie ze Status HTTP i Próby. Przyciskiem Wyślij ponownie powtarzasz doręczenie.
  • Odnów sekret tworzy nowy sekret. Dotychczasowy pozostaje ważny jeszcze 24 godziny, abyś mógł przestawić odbiorcę.
  • Przyciskiem Edytuj zmienisz adres i wydarzenia, a przyciskiem Usuń i potwierdzeniem Usunąć webhook? go usuniesz. Protokół doręczeń zostaje zachowany przez 30 dni.

Tak sprawdzisz wynik

  • Przy kluczu pojawi się Ostatnio używany z datą, gdy integracja go użyje. Żądania 24 h liczy żądania.
  • Przy webhooku Ostatnie 7 dni pokazuje „{Zahl} dostarczonych, {Zahl} nieudanych“, a zdarzenie testowe jest widoczne w Dostawy.

Gdy coś nie działa

Co widziszPrzyczynaJak to naprawić
„Wybierz co najmniej jedno uprawnienie.“Żaden obszar nie ma uprawnienia.Wybierz wzór albo przypisz co najmniej jednemu obszarowi Odczyt lub Zapis.
„Wpisz nazwę.“Brakuje Nazwa.Wpisz nazwę.
„Sprawdź:“ z adresemAdres w Ograniczenie IP jest nieprawidłowy.Popraw adres albo sieć CIDR. Dozwolone są najwyżej 20 wpisów.
„Wybierz datę od jutra, najwyżej za trzy lata.“Data wygaśnięcia jest poza dozwolonym zakresem.Wybierz datę od jutra, która jest najwyżej trzy lata od dziś.
„Adres musi zaczynać się od https://.“Adres URL odbiorcy nie jest adresem HTTPS.Wpisz adres zaczynający się od https://.
„Wybierz co najmniej jedno wydarzenie.“Webhook nie ma żadnego wydarzenia.Wybierz co najmniej jedno przy Wydarzenia.
Wstrzymany z powodu powtarzających się błędówOdbiorca nie odpowiada statusem 2xx.Sprawdź, czy odbiorca jest dostępny, i wybierz Aktywuj ponownie.
„Aktywuj webhook, aby wysłać zdarzenie testowe.“Webhook jest wstrzymany.Aktywuj Doręczanie aktywne i wyślij zdarzenie testowe.
„Nie udało się wczytać wyboru. Zamknij okno i otwórz je ponownie.“Lista uprawnień i wydarzeń nie została wczytana.Zamknij okno i otwórz je ponownie.
Kontakt