Preskoči na vsebino
Task, Channels and Partner API

Partner API: upravljanje ključev in webhookov

Partner API poveže tvoje spletne strani za rezervacije, aplikacije in integracije s STRYK. Ustvariš ključe z natanko potrebnimi pravicami in nastaviš webhooke.

Last updated: Owner, Developers
Contents
  1. Preden začneš
  2. Odpri API
  3. Ustvari ključ API
  4. Upravljanje ključev
  5. Nastavitev webhookov
  6. Upravljanje webhookov
  7. Tako preveriš rezultat
  8. Če kaj ne deluje
  9. To je povezano

Preden začneš

  • Potrebuješ pravico Upravljanje kanalov. Samo s to pravico vidiš vrstico API na strani Kanali.
  • Ugotovi, katera področja mora integracija brati ali pisati. Ključ dobi samo te pravice.
  • Integracija kliče Partner API s svojega strežnika. Ključa nikoli ne vstavljaj v kodo brskalnika ali v aplikacijo. Krajišča, parametre in primere najdeš v Dokumentacija za razvijalce. Tam razlaga oddelek Avtentikacija in obsegi, kaj dovoli vsaka pravica.
  • Webhooki potrebujejo prejemnika z naslovom, ki se začne z https://.

Odpri API

In STRYKKanali

  1. Pod Lastne povezave izberi vrstico API z dodatkom „Ključi API in webhooki“. Pogovorno okno API se odpre.
  2. Izberi zavihek Ključi API ali Webhooks. Z Dokumentacija za razvijalce v glavi pogovornega okna odpreš razvijalski portal.
  1. Zavihka Ključi API in Webhooks
  2. Ključi s pravicami
  3. Dejanja ključa

Ustvari ključ API

In STRYKKanaliAPIKljuči API

  1. Izberi Ustvari ključ API. Pogovorno okno Ustvari ključ API se odpre.
  2. Vpiši Ime, na primer „Stran za rezervacije“.
  3. Pod Pravice izberi predlogo: Samo branje (branje vseh področij), Branje in pisanje (pisanje, kjer je mogoče) ali Po meri. Pri Po meri za vsako področje izbereš Brez dostopa, Branje ali Pisanje. Področja so Hotel in sobe, Razpoložljivost, Cene in tarife, Rezervacije, Gostje, Plačila in Računi. Pisanje vključuje Branje. Računi so davčni dokumenti hotela in jih je prek API mogoče samo brati.
  4. Neobvezno: odpri Napredno. Izberi Potek: Brez poteka, 30 dni, 90 dni, 1 leto ali Datum (od jutri, največ tri leta). Pod Omejitev IP vpiši v vsako vrstico naslov ali omrežje CIDR, največ 20. Prazno pomeni, da so dovoljeni vsi naslovi. Pod Opomba hraniš interno opombo.
  5. Izberi Ustvari. STRYK prikaže Ključ API ustvarjen s ključem in opozorilo Vidno samo zdaj.
  6. Kopiraj ključ in ga shrani na primer v upravitelj gesel. Izberi Končano.

Upravljanje ključev

In STRYKKanaliAPIKljuči API

Seznam pri vsakem ključu prikazuje Ime, začetek ključa, Pravice, Ustvarjeno, Nazadnje uporabljeno, Potek in stanje: Aktivno, Kmalu poteče, Preklicano ali Potekel. Izberi ključ, da vidiš Pravice, Potek, Dovoljeni naslovi IP, Omejitev zahtev (zahteve na minuto), Uporaba, Nedavne zahteve in Zgodovino.

  1. Odpri v vrstici meni Možnosti.
  2. Izberi Znova ustvari, če mora integracija dobiti nov ključ z istimi pravicami. Pod Dosedanji ključ izberi Stari ključ velja še 24 h, da lahko integracijo preklopiš, ali Takoj prekliči. Potrdi z Znova ustvari. STRYK novi ključ prikaže enkrat.
  3. Izberi Prekliči in potrdi Prekličem ključ API?, da ključ takoj blokiraš. STRYK zahtevke s tem ključem zavrne.

Nastavitev webhookov

In STRYKKanaliAPIWebhooks

Webhook po HTTPS podpisano pošlje izbrane dogodke tvojim sistemom.

  1. Izberi Ustvari webhook. Pogovorno okno Nov webhook se odpre.
  2. Vpiši URL prejemnika, na primer https://crm.nordlicht.invalid/hooks/stryk. Naslov se mora začeti z https://.
  3. Neobvezno: vpiši Opis, na primer „Rezervacije v naš CRM“.
  4. Pod Dogodki izberi vsaj enega: Rezervacija ustvarjena, Rezervacija spremenjena, Rezervacija preklicana, Gost spremenjen, Razpoložljivost spremenjena, Cena spremenjena, Plačilo spremenjeno ali Stanje sobe spremenjeno. S Izberi vse in Počisti izbiro izbereš vse ali nobenega.
  5. Izberi Ustvari webhook. STRYK prikaže Tvoja skrivnost za podpisovanje enkrat.
  6. Skrivnost shrani v svojem prejemniku. Kako prejemnik preveri podpis, opisuje razvijalska dokumentacija v razdelku Webhooki in preverjanje podpisa.
  7. Izberi webhook in nato Pošlji testni dogodek. STRYK sporoči „Testni dogodek se dostavlja.“

Upravljanje webhookov

Ort: Kanali > API > Webhooki, izberi webhook

  • S stikalom Dostava aktivna webhook začasno ustaviš ali aktiviraš. Ustavljeni webhooki ne prejmejo dogodkov. Po aktiviranju se dostava začne z novimi dogodki.
  • Zadnjih 7 dni, Zadnji uspeh in Zadnja napaka prikazujejo stanje. Pod Dostave vidiš vsako dostavo s Stanje HTTP in Poskusi. S Pošlji znova ponovno pošlješ dostavo.
  • Obnovi skrivnost ustvari novo skrivnost. Prejšnja ostane veljavna še 24 ur, da lahko prejemnik preklopiš.
  • S Uredi spremeniš naslov in dogodke, z Izbriši in potrditvijo Izbrišem webhook? ga odstraniš. Zapis o dostavah ostane shranjen 30 dni.

Tako preveriš rezultat

  • Pri ključu je navedeno Nazadnje uporabljeno z datumom, takoj ko ga integracija uporablja. Zahteve 24 h prešteje zahteve.
  • Pri webhooku Zadnjih 7 dni prikazuje „{Zahl} dostavljeno, {Zahl} neuspešno“, testni dogodek pa je pod Dostave.

Če kaj ne deluje

Kaj vidišVzrokKako to rešiš
„Izberi vsaj eno pravico.“Nobeno področje nima pravice.Izberi predlogo ali daj vsaj enemu področju Branje ali Pisanje.
„Prosim, vpiši ime.“Manjka Ime.Vpiši ime.
„Prosim, preveri:“ z naslovomNaslov v Omejitev IP ni veljaven.Popravi naslov ali omrežje CIDR. Dovoljenih je največ 20 vnosov.
„Izberi datum od jutri, največ tri leta v prihodnosti.“Datum poteka je zunaj obdobja.Izberi datum od jutri, ki je največ tri leta oddaljen.
„Naslov se mora začeti z https://.“URL prejemnika ni naslov HTTPS.Vpiši naslov, ki se začne z https://.
„Izberi vsaj en dogodek.“Webhook nima nobenega dogodka.Pod Dogodki izberi vsaj enega.
Zaustavljen zaradi ponavljajočih se napakPrejemnik ne odgovori s statusom 2xx.Preveri, ali je prejemnik dosegljiv, in izberi Znova aktiviraj.
„Aktiviraj webhook, da pošlješ testni dogodek.“Webhook je ustavljen.Aktiviraj Dostava aktivna in pošlji testni dogodek.
„Izbire ni bilo mogoče naložiti. Zapri in ga znova odpri.“Seznam pravic in dogodkov ni naložen.Zapri pogovorno okno in ga znova odpri.
Stik