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.
Contents
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
- V sekci Vlastní napojení zvol řádek API s doplňkem „API klíče a webhooky“. Otevře se dialog API.
- 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.
- Záložky API klíče a Webhooky
- Klíč s oprávněními
- Akce klíče
Vytvoření API klíče
In STRYKKanályAPIAPI klíče
- Zvol Vytvořit API klíč. Otevře se dialog Vytvořit API klíč.
- Do pole Jméno zadej například „Rezervační stránka“.
- 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.
- 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.
- Zvol Vytvořit. STRYK zobrazí API klíč vytvořen s klíčem a upozorněním Viditelné jen nyní.
- 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.
- V řádku otevři menu Možnosti.
- 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.
- 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.
- Zvol Vytvořit webhook. Otevře se dialog Nový webhook.
- Do pole URL příjemce zadej například https://crm.nordlicht.invalid/hooks/stryk. Adresa musí začínat na https://.
- Volitelně: Zadej Popis, například „Rezervace do našeho CRM“.
- 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.
- Zvol Vytvořit webhook. STRYK zobrazí Tvůj podpisový klíč jednou.
- 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.
- 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říčina | Jak 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 adresou | Adresa 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ám | Pří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. |