Ugrás a tartalomhoz
Task, Channels and Partner API

Partner API: kulcsok és webhookok kezelése

A Partner API-val összeköted a saját foglalási oldalaidat, alkalmazásaidat és integrációidat a STRYK-kel. Olyan kulcsokat hozol létre, amelyeknek pontosan a szükséges jogai vannak, és webhookokat állítasz be.

Last updated: Owner, Developers
Contents
  1. Mielőtt elkezded
  2. API megnyitása
  3. API-kulcs létrehozása
  4. Kulcsok kezelése
  5. Webhookok beállítása
  6. Webhookok kezelése
  7. Az eredmény ellenőrzése
  8. Ha valami nem működik
  9. Ez kapcsolódik ehhez

Mielőtt elkezded

  • Szükséged van a Csatornák kezelése jogosultságra. Csak így látod a API sort a Csatornák oldalon.
  • Tisztázd, mely területeket kell az integrációnak olvasnia vagy írnia. Egy kulcs csak ezeket a jogokat kapja.
  • Az integráció a saját szerveredről hívja a Partner API-t. A kulcsot soha ne tedd böngészőkódba vagy alkalmazásba. A végpontokat, paramétereket és példákat a Fejlesztői dokumentáció oldalon találod. Ott az Hitelesítés és hatókörök szakasz leírja, hogy az egyes jogok mit engednek meg.
  • A webhookokhoz olyan címzett kell, amelynek címe https:// kezdetű.

API megnyitása

In STRYKCsatornák

  1. Válaszd a Saját kapcsolatok alatt az API sort az „API-kulcsok és webhookok” megjegyzéssel. Megnyílik az API párbeszédablak.
  2. Válaszd az API-kulcsok vagy a Webhookok fület. A fejlécben a Fejlesztői dokumentáció gombbal megnyitod a fejlesztői portált.
  1. Az API-kulcsok és Webhookok fülek
  2. Kulcsok jogosultságokkal
  3. A kulcs műveletei

API-kulcs létrehozása

In STRYKCsatornákAPIAPI-kulcsok

  1. Válaszd az API-kulcs létrehozása lehetőséget. Megnyílik az API-kulcs létrehozása párbeszédablak.
  2. Add meg a Név mezőt, például „Foglalási oldal”.
  3. Válassz a Jogosultságok alatt egy mintát: Csak olvasás (minden terület olvasása), Olvasás és írás (írás, ahol lehetséges) vagy Egyéni. Az Egyéni esetén területenként válaszd a Nincs hozzáférés, Olvasás vagy Írás lehetőséget. A területek: Szálloda és szobák, Elérhetőség, Árak és díjcsomagok, Foglalások, Vendégek, Fizetések és Számlák. Az Írás magában foglalja az Olvasás jogosultságot. A számlák a szálloda fiskális bizonylatai, ezért API-n keresztül csak olvashatók.
  4. Opcionális: nyisd meg a Speciális részt. Válaszd a Lejárat értékét: Nincs lejárat, 30 nap, 90 nap, 1 év vagy Dátum (holnaptól kezdve, legfeljebb három évig). Az IP-korlátozás mezőbe soronként írj be egy címet vagy egy CIDR-hálózatot, legfeljebb 20-at. Ha üresen hagyod, minden cím engedélyezett. A Megjegyzés mezőbe belső megjegyzést írhatsz.
  5. Válaszd a Létrehozás lehetőséget. A STRYK megjeleníti az API-kulcs létrehozva üzenetet a kulccsal és a Csak most látható jelzéssel.
  6. Másold ki a kulcsot, és mentsd el például a jelszókezelőben. Válaszd a Kész lehetőséget.

Kulcsok kezelése

In STRYKCsatornákAPIAPI-kulcsok

A lista kulcsonként megmutatja a Név mezőt, a kulcs elejét, a Jogosultságok, a Létrehozva, az Utoljára használva, a Lejárat értékeket és az állapotot: Aktív, Hamarosan lejár, Visszavonva vagy Lejárt. Válassz egy kulcsot, hogy lásd a Jogosultságok, a Lejárat, az Engedélyezett IP-címek, a Kéréskorlát (kérés percenként), a Használat, a Legutóbbi kérések és az Előzmények részt.

  1. Nyisd meg a sor Lehetőségek menüjét.
  2. Válaszd az Újragenerálás lehetőséget, ha az integrációnak ugyanazokkal a jogokkal új kulcs kell. A Jelenlegi kulcs résznél válaszd az A régi kulcs még 24 óráig érvényes lehetőséget, hogy át tudd állítani az integrációt, vagy az Azonnali visszavonás lehetőséget. Erősítsd meg az Újragenerálás gombbal. A STRYK az új kulcsot egyszer mutatja meg.
  3. Válaszd a Visszavonás lehetőséget, és erősítsd meg a Visszavonod az API-kulcsot? kérdést, hogy azonnal zárold a kulcsot. A STRYK ezzel a kulccsal érkező kéréseket elutasítja.

Webhookok beállítása

In STRYKCsatornákAPIWebhookok

Egy webhook a kiválasztott eseményeket aláírva, HTTPS-en küldi el a rendszereidnek.

  1. Válaszd a Webhook létrehozása lehetőséget. Megnyílik az Új webhook párbeszédablak.
  2. Add meg a Fogadó URL mezőt, például https://crm.nordlicht.invalid/hooks/stryk. A címnek https:// kezdetűnek kell lennie.
  3. Opcionális: adj meg egy Leírás mezőt, például „Foglalások a CRM-rendszerünkbe”.
  4. Az Események alatt válassz legalább egyet: Foglalás létrehozva, Foglalás módosítva, Foglalás törölve, Vendég módosítva, Elérhetőség módosult, Ár módosult, Fizetés módosult vagy Szobaállapot módosult. Az Összes kijelölése és a Kijelölés megszüntetése gombokkal mindent vagy semmit jelölhetsz ki.
  5. Válaszd a Webhook létrehozása lehetőséget. A STRYK egyszer megjeleníti az Az aláírási titok mezőt.
  6. Tárold a titkot a fogadódban. Hogyan kell a fogadónak ellenőriznie az aláírást, azt a fejlesztői dokumentáció írja le a Webhookok és aláírás-ellenőrzés részben.
  7. Válaszd ki a webhookot, majd a Tesztesemény küldése lehetőséget. A STRYK ezt jelzi: „A tesztesemény kézbesítése folyamatban.“

Webhookok kezelése

Ort: Csatornák > API > Webhookok, válassz egy webhookot

  • A Kézbesítés aktív kapcsolóval szüneteltetheted vagy aktiválhatod a webhookot. A szüneteltetett webhookok nem kapnak eseményeket. Aktiválás után a kézbesítés az új eseményekkel indul.
  • Az Utolsó 7 nap, az Utolsó siker és az Utolsó hiba mutatja az állapotot. A Kézbesítések alatt minden kézbesítést látsz a HTTP-állapot és a Próbálkozások értékével. Az Újraküldés lehetőséggel megismételhetsz egy kézbesítést.
  • A Titok megújítása új titkot hoz létre. A korábbi titok továbbra is 24 óráig érvényes, hogy át tudd állítani a fogadót.
  • A Szerkesztés gombbal módosíthatod a címet és az eseményeket. A Törlés gombbal és a Törli a webhookot? megerősítéssel eltávolíthatod. A kézbesítési napló 30 napig megmarad.

Az eredmény ellenőrzése

  • A kulcsnál az Utoljára használva dátum jelenik meg, amint az integráció használja. A Kérések 24 ó számolja a kéréseket.
  • A webhooknál az Utolsó 7 nap mező megmutatja: „{Zahl} kézbesítve, {Zahl} sikertelen”, a tesztesemény pedig a Kézbesítések alatt jelenik meg.

Ha valami nem működik

Amit látszOkÍgy oldod meg
„Válassz legalább egy jogot.“Egyik területnek sincs jogosultsága.Válassz egy mintát, vagy adj legalább egy területnek Olvasás vagy Írás jogosultságot.
„Kérjük, adj meg egy nevet.“A Név hiányzik.Adj meg egy nevet.
„Kérjük, ellenőrizd:“ egy címmelAz IP-korlátozás egyik címe érvénytelen.Javítsd ki a címet vagy a CIDR-hálózatot. Legfeljebb 20 bejegyzés engedélyezett.
„Kérjük, válassz holnaptól kezdődő dátumot, legfeljebb három évre.“A lejárati dátum kívül esik a megengedett időszakon.Válassz holnaptól kezdődő dátumot, amely legfeljebb három évre van.
„A címnek https:// kezdetűnek kell lennie.“A Fogadó URL nem HTTPS-cím.Adj meg https:// kezdetű címet.
„Válassz legalább egy eseményt.“A webhooknak nincs eseménye.Válassz legalább egyet az Események közül.
Ismételt hibák miatt szüneteltetveA fogadó nem válaszol 2xx állapottal.Ellenőrizd, hogy a fogadó elérhető-e, majd válaszd az Újraaktiválás lehetőséget.
„Aktiváld a webhookot a tesztesemény küldéséhez.“A webhook szüneteltetve van.Aktiváld a Kézbesítés aktív kapcsolót, és küldd el a teszteseményt.
„A választék nem tölthető be. Zárd be, majd nyisd meg újra.“A jogosultságok és események listája nincs betöltve.Zárd be a párbeszédablakot, és nyisd meg újra.
Kapcsolat