Přejít na obsah
Task, Channels and Partner API

Partner API: správa klíčů a webhooků

Pomocí Partner API propojíš vlastní rezervační stránky, aplikace a integrace se STRYKem. Vytvoříš klíče jen s potřebnými oprávněními a nastavíš webhooky.

Last updated: Owner, Developers
Contents
  1. Než začneš
  2. Otevření API
  3. Vytvoření API klíče
  4. Správa klíčů
  5. Nastavení webhooků
  6. Správa webhooků
  7. Jak výsledek zkontrolovat
  8. Když něco nefunguje
  9. Související témata

Než začneš

  • Potřebuješ oprávnění Správa kanálů. Jen s ním uvidíš řádek API na stránce Kanály.
  • Ujasni si, které oblasti integrace musí číst nebo do nich zapisovat. Klíč dostane jen tato oprávnění.
  • Integrace volá Partner API ze svého serveru. Klíč nikdy neukládej do kódu prohlížeče ani do aplikace. Endpointy, parametry a příklady najdeš v dokumentaci pro vývojáře. Tam v části Autentizace a scopes vysvětluje, co každé oprávnění povoluje.
  • Webhooky potřebují příjemce s adresou začínající na https://.

Otevření API

In STRYKKanály

  1. V sekci Vlastní napojení zvol řádek API s doplňkem „API klíče a webhooky“. Otevře se dialog API.
  2. Zvol záložku API klíče nebo Webhooky. Tlačítkem Dokumentace pro vývojáře v záhlaví dialogu otevřeš vývojářský portál.
  1. Záložky API klíče a Webhooky
  2. Klíč s oprávněními
  3. Akce klíče

Vytvoření API klíče

In STRYKKanályAPIAPI klíče

  1. Zvol Vytvořit API klíč. Otevře se dialog Vytvořit API klíč.
  2. Do pole Jméno zadej například „Rezervační stránka“.
  3. U Oprávnění zvol vzor: Jen čtení (čtení všech oblastí), Čtení a zápis (zápis tam, kde je to možné) nebo Vlastní. U Vlastní zvol u každé oblasti Bez přístupu, Čtení nebo Zápis. Oblasti jsou Hotel a pokoje, Dostupnost, Ceny a tarify, Rezervace, Hosté, Platby a Faktury. Zápis zahrnuje Čtení. Faktury jsou daňové doklady hotelu a přes API je lze jen číst.
  4. Volitelně: Otevři Pokročilé. Zvol Platnost: Bez omezení, 30 dní, 90 dní, 1 rok nebo Datum (od zítřka, nejvýše na tři roky). Do pole Omezení IP zadej u každého řádku adresu nebo síť CIDR, nejvýše 20. Prázdné pole povoluje všechny adresy. Do Poznámka si zapiš interní poznámku.
  5. Zvol Vytvořit. STRYK zobrazí API klíč vytvořen s klíčem a upozorněním Viditelné jen nyní.
  6. Zkopíruj klíč a ulož ho například do správce hesel. Zvol Hotovo.

Správa klíčů

In STRYKKanályAPIAPI klíče

Seznam ukazuje u každého klíče Jméno, začátek klíče, Oprávnění, Vytvořeno, Naposledy použité, Platnost a stav: Aktivní, Brzy vyprší, Odvoláno nebo Vypršel. Vyber klíč, abys viděl Oprávnění, Platnost, Povolené IP adresy, Limit požadavků (požadavky za minutu), Využití, Poslední požadavky a Historii.

  1. V řádku otevři menu Možnosti.
  2. Zvol Přegenerovat, pokud má integrace dostat nový klíč se stejnými oprávněními. U Dosavadní klíč zvol Starý klíč platí ještě 24 h, abys mohl integraci přepnout, nebo Zneplatnit ihned. Potvrď tlačítkem Přegenerovat. STRYK nový klíč zobrazí jednou.
  3. Zvol Odvolat a potvrď Odvolat API klíč?, abys klíč okamžitě zablokoval. Požadavky s tímto klíčem STRYK pak odmítne.

Nastavení webhooků

In STRYKKanályAPIWebhooky

Webhook posílá zvolené události podepsané přes HTTPS na tvé systémy.

  1. Zvol Vytvořit webhook. Otevře se dialog Nový webhook.
  2. Do pole URL příjemce zadej například https://crm.nordlicht.invalid/hooks/stryk. Adresa musí začínat na https://.
  3. Volitelně: Zadej Popis, například „Rezervace do našeho CRM“.
  4. U Události zvol alespoň jednu: Rezervace vytvořena, Rezervace změněna, Rezervace zrušena, Host změněn, Dostupnost změněna, Cena se změnila, Platba změněna nebo Stav pokoje změněn. Tlačítky Vybrat vše a Zrušit výběr zvolíš všechny nebo žádnou.
  5. Zvol Vytvořit webhook. STRYK zobrazí Tvůj podpisový klíč jednou.
  6. Ulož klíč ve svém příjemci. Jak příjemce podpis ověřuje, popisuje dokumentace pro vývojáře v části Webhooky a ověření podpisu.
  7. Vyber webhook a potom Odeslat testovací událost. STRYK hlásí „Testovací událost se doručuje.“

Správa webhooků

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

  • Přepínačem Doručování aktivní webhook pozastavíš nebo aktivuješ. Pozastavené webhooky události nedostávají. Po aktivaci začne doručování novými událostmi.
  • Posledních 7 dní, Poslední úspěch a Poslední chyba ukazují stav. Pod Doručení vidíš každé doručení se Stav HTTP a Pokusy. Tlačítkem Odeslat znovu doručení zopakuješ.
  • Obnovit klíč vytvoří nový podpisový klíč. Dosavadní klíč zůstane 24 hodin platný, abys mohl příjemce přepnout.
  • Tlačítkem Upravit změníš adresu a události, tlačítkem Smazat a potvrzením Smazat webhook? ho odstraníš. Protokol doručení zůstává 30 dní.

Jak výsledek zkontrolovat

  • U klíče je uvedeno Naposledy použité s datem, jakmile ho integrace použije. Požadavky 24 h počítá požadavky.
  • U webhooku ukazuje Posledních 7 dní „{Zahl} doručeno, {Zahl} neúspěšných“ a testovací událost je pod Doručení.

Když něco nefunguje

Co vidíšPříčinaJak to vyřešit
„Vyber alespoň jedno oprávnění.“Žádná oblast nemá oprávnění.Zvol vzor nebo dej alespoň jedné oblasti Čtení nebo Zápis.
„Zadej prosím jméno.“Chybí Jméno.Zadej jméno.
„Zkontroluj prosím:“ s adresouAdresa v Omezení IP je neplatná.Oprav adresu nebo síť CIDR. Povoleno je nejvýše 20 položek.
„Zvol datum od zítřka, nejvýše na tři roky.“Datum platnosti je mimo povolený rozsah.Zvol datum od zítřka, které je nejvýše tři roky v budoucnosti.
„Adresa musí začínat na https://.“URL příjemce není adresa HTTPS.Zadej adresu začínající na https://.
„Vyber alespoň jednu událost.“Webhook nemá žádnou událost.Zvol alespoň jednu v Události.
Pozastaveno kvůli opakovaným chybámPříjemce neodpovídá stavem 2xx.Zkontroluj, zda je příjemce dostupný, a zvol Znovu aktivovat.
„Aktivuj webhook, aby bylo možné odeslat testovací událost.“Webhook je pozastavený.Aktivuj Doručování aktivní a odešli testovací událost.
„Výběr se nepodařilo načíst. Zavři ho a otevři znovu.“Seznam oprávnění a událostí se nenačetl.Zavři dialog a otevři ho znovu.
Kontakt