Prejsť na obsah
Task, Channels and Partner API

Partner API: správa kľúčov a webhookov

Partner API prepojí tvoje vlastné rezervačné stránky, aplikácie a integrácie so STRYK. Vytváraš kľúče presne s potrebnými oprávneniami a nastavuješ webhooky.

Last updated: Owner, Developers
Contents
  1. Skôr než začneš
  2. Otvorenie API
  3. Vytvorenie API kľúča
  4. Správa kľúčov
  5. Nastavenie webhookov
  6. Správa webhookov
  7. Ako skontrolovať výsledok
  8. Ak niečo nefunguje
  9. Súvisí s tým

Skôr než začneš

  • Potrebuješ oprávnenie Spravovať kanály. Len s ním uvidíš riadok API na stránke Kanály.
  • Ujasni si, ktoré oblasti musí integrácia čítať alebo zapisovať. Kľúč dostane len tieto oprávnenia.
  • Integrácia volá Partner API zo svojho servera. Kľúč nikdy nevkladaj do kódu prehliadača ani do aplikácie. Endpointy, parametre a príklady nájdeš v Dokumentácii pre vývojárov. Tam časť Autentifikácia a rozsahy vysvetľuje, čo každé oprávnenie povoľuje.
  • Webhooky potrebujú príjemcu s adresou, ktorá začína na https://.

Otvorenie API

In STRYKKanály

  1. Vyber v časti Vlastné prepojenia riadok API s dodatkom „API kľúče a webhooky“. Otvorí sa dialóg API.
  2. Vyber kartu API kľúče alebo Webhooky. Tlačidlom Dokumentácia pre vývojárov v hlavičke dialógu otvoríš vývojársky portál.
  1. Karty API kľúče a Webhooky
  2. Kľúč s oprávneniami
  3. Akcie kľúča

Vytvorenie API kľúča

In STRYKKanályAPIAPI kľúče

  1. Vyber Vytvoriť API kľúč. Otvorí sa dialóg Vytvoriť API kľúč.
  2. Zadaj Meno, napríklad „Rezervačná stránka“.
  3. Pri Oprávnenia vyber vzor: Iba čítanie (čítať všetky oblasti), Čítanie a zápis (zapisovať, kde je to možné) alebo Vlastné. Pri Vlastné vyberieš pre každú oblasť Bez prístupu, Čítanie alebo Zápis. Oblasti sú Hotel a izby, Dostupnosť, Ceny a tarify, Rezervácie, Hostia, Platby a Faktúry. Zápis zahŕňa Čítanie. Faktúry sú daňové doklady hotela a cez API ich možno len čítať.
  4. Voliteľné: Otvor Pokročilé. Vyber Platnosť: Bez obmedzenia, 30 dní, 90 dní, 1 rok alebo Dátum (od zajtra, najviac na tri roky). Pri Obmedzenie IP zadaj do každého riadku adresu alebo sieť CIDR, najviac 20. Prázdne pole povoľuje všetky adresy. Do Poznámka si zapíš interný odkaz.
  5. Vyber Vytvoriť. STRYK zobrazí API kľúč vytvorený s kľúčom a upozornením Viditeľné len teraz.
  6. Skopíruj kľúč a ulož ho napríklad do správcu hesiel. Vyber Hotovo.

Správa kľúčov

In STRYKKanályAPIAPI kľúče

Zoznam zobrazuje pri každom kľúči Meno, začiatok kľúča, Oprávnenia, Vytvorené, Naposledy použité, Platnosť a stav: Aktívne, Čoskoro vyprší, Odvolané alebo Platnosť vypršala. Vyber kľúč, aby si videl Oprávnenia, Platnosť, Povolené IP adresy, Limit požiadaviek (požiadavky za minútu), Využitie, Posledné požiadavky a História.

  1. V riadku otvor ponuku Možnosti.
  2. Vyber Pregenerovať, ak má integrácia dostať nový kľúč s rovnakými oprávneniami. Pri Doterajší kľúč vyber Starý kľúč platí ešte 24 h, aby sa integrácia dala prepnúť, alebo Zneplatniť ihneď. Potvrď tlačidlom Pregenerovať. STRYK zobrazí nový kľúč len raz.
  3. Vyber Odvolať a potvrď Odvolať API kľúč?, ak chceš kľúč okamžite zablokovať. STRYK potom odmietne požiadavky s týmto kľúčom.

Nastavenie webhookov

In STRYKKanályAPIWebhooky

Webhook posiela vybrané udalosti podpísané cez HTTPS do tvojich systémov.

  1. Vyber Vytvoriť webhook. Otvorí sa dialóg Nový webhook.
  2. Zadaj URL príjemcu, napríklad https://crm.nordlicht.invalid/hooks/stryk. Adresa musí začínať na https://.
  3. Voliteľné: Zadaj Popis, napríklad „Rezervácie do nášho CRM“.
  4. Vyber pri Udalosti aspoň jednu: Rezervácia vytvorená, Rezervácia zmenená, Rezervácia zrušená, Hosť zmenený, Dostupnosť zmenená, Cena zmenená, Platba zmenená alebo Stav izby zmenený. Pomocou Vybrať všetko a Zrušiť výber vyberieš všetky alebo žiadnu.
  5. Vyber Vytvoriť webhook. STRYK zobrazí Tvoj podpisový kľúč raz.
  6. Ulož kľúč do svojho príjemcu. Ako príjemca overí podpis, opisuje vývojárska dokumentácia v časti Webhooky a overenie podpisu.
  7. Vyber webhook a potom Odoslať testovaciu udalosť. STRYK hlási „Testovacia udalosť sa doručuje.“

Správa webhookov

Ort: Kanály > API > Webhooky, vyber webhook

  • Vypínačom Doručovanie aktívne webhook pozastavíš alebo aktivuješ. Pozastavené webhooky neprijímajú udalosti. Po aktivácii sa doručovanie začne novými udalosťami.
  • Posledných 7 dní, Posledný úspech a Posledná chyba zobrazujú stav. Pod Dodávky vidíš každé doručenie s Stav HTTP a Pokusy. Pomocou Odoslať znova doručenie zopakuješ.
  • Obnoviť kľúč vytvorí nový podpisový kľúč. Predchádzajúci zostane platný ešte 24 hodín, aby sa dal príjemca prepnúť.
  • Pomocou Upraviť zmeníš adresu a udalosti, pomocou Odstrániť a potvrdenia Odstrániť webhook? webhook odstrániš. Protokol doručení zostane zachovaný 30 dní.

Ako skontrolovať výsledok

  • Pri kľúči sa zobrazí Naposledy použité s dátumom, akonáhle ho integrácia použije. Požiadavky 24 h počíta požiadavky.
  • Pri webhooku ukazuje Posledných 7 dní „{Zahl} doručených, {Zahl} neúspešných“ a testovacia udalosť je pod Dodávky.

Ak niečo nefunguje

Čo vidíšPríčinaAko to vyriešiť
„Vyber aspoň jedno oprávnenie.“Žiadna oblasť nemá oprávnenie.Vyber vzor alebo daj aspoň jednej oblasti Čítanie alebo Zápis.
„Zadaj prosím meno.“Chýba Meno.Zadaj meno.
„Skontroluj prosím:“ s adresouJedna adresa v Obmedzenie IP je neplatná.Oprav adresu alebo sieť CIDR. Povolené sú najviac 20 záznamov.
„Vyber dátum od zajtra, najviac na tri roky.“Dátum platnosti je mimo povoleného obdobia.Vyber dátum od zajtra, ktorý je najviac tri roky vzdialený.
„Adresa musí začínať na https://.“URL príjemcu nie je adresa HTTPS.Zadaj adresu začínajúcu na https://.
„Vyber aspoň jednu udalosť.“Webhook nemá žiadnu udalosť.Vyber aspoň jednu pri Udalosti.
Pozastavený pre opakované chybyPríjemca neodpovedá stavom 2xx.Over, či je príjemca dostupný, a vyber Znova aktivovať.
„Aktivuj webhook, aby bolo možné odoslať testovaciu udalosť.“Webhook je pozastavený.Zapni Doručovanie aktívne a odošli testovaciu udalosť.
„Výber sa nepodarilo načítať. Zatvor ho a znova ho otvor.“Zoznam oprávnení a udalostí sa nenačítal.Zatvor dialóg a otvor ho znova.
Kontakt