Pereiti prie turinio
Task, Channels and Partner API

Partner API: raktų ir webhook'ų tvarkymas

Su Partner API prijungi savo rezervacijų puslapius, programas ir integracijas prie STRYK. Sukuri raktus su tiksliai reikiamomis teisėmis ir nustatai webhook'us.

Last updated: Owner, Developers
Contents
  1. Prieš pradedant
  2. API atidarymas
  3. API rakto kūrimas
  4. Raktų valdymas
  5. Webhook'ų nustatymas
  6. Webhook'ų valdymas
  7. Kaip patikrinti rezultatą
  8. Jei kažkas neveikia
  9. Susiję

Prieš pradedant

  • Tau reikia teisės Tvarkyti kanalus. Tik su ja matai eilutę API puslapyje Kanalai.
  • Išsiaiškink, kurias sritis integracija turi skaityti arba rašyti. Raktas gauna tik šias teises.
  • Integracija kreipiasi į Partner API iš savo serverio. Rakto niekada nedėk į naršyklės kodą ar programą. Galutinius taškus, parametrus ir pavyzdžius rasi Kūrėjo dokumentacija. Skyriuje Autentifikacija ir apimtys paaiškinama, ką leidžia kiekviena teisė.
  • Webhook'ams reikia gavėjo su adresu, prasidedančiu https://.

API atidarymas

In STRYKKanalai

  1. Pasirink skiltyje Savos jungtys eilutę API su priedu „API raktai ir webhook'ai“. Atsidaro dialogas API.
  2. Pasirink skirtuką API raktai arba Webhook'ai. Dialogo antraštėje su Kūrėjo dokumentacija atidarai kūrėjų portalą.
  1. Skirtukai API raktai ir Webhook'ai
  2. Raktas su teisėmis
  3. Rakto veiksmai

API rakto kūrimas

In STRYKKanalaiAPIAPI raktai

  1. Pasirink Sukurti API raktą. Atsidaro dialogas Sukurti API raktą.
  2. Įrašyk Pavadinimas, pavyzdžiui „Buchungsseite“.
  3. Pasirink Teisės vieną šabloną: Tik skaitymas (skaityti visas sritis), Skaitymas ir rašymas (rašyti, kur įmanoma) arba Pasirinktinis. Pasirinkus Pasirinktinis, kiekvienai sričiai pasirink Prieigos nėra, Skaityti arba Rašymas. Sritys yra Viešbutis ir kambariai, Prieinamumas, Kainos ir tarifai, Rezervacijos, Svečiai, Mokėjimai ir Sąskaitos faktūros. Rašymas apima Skaityti. Sąskaitos faktūros yra viešbučio fiskaliniai dokumentai ir per API jas galima tik skaityti.
  4. Pasirinktinai: atidark Išplėstinis. Pasirink Galiojimo laikas: Be galiojimo laiko, 30 dienų, 90 dienų, 1 metai arba Data (nuo rytojaus, ne ilgiau nei po trejų metų). Laukelyje IP apribojimas kiekvienoje eilutėje įrašyk adresą arba CIDR tinklą, daugiausia 20. Tuščias laukas leidžia visus adresus. Lauke Pastaba pasilik vidinį priminimą.
  5. Pasirink Sukurti. STRYK rodo API raktas sukurtas su raktu ir pastaba Matoma tik dabar.
  6. Nukopijuok raktą ir išsaugok jį, pavyzdžiui, slaptažodžių tvarkyklėje. Pasirink Baigti.

Raktų valdymas

In STRYKKanalaiAPIAPI raktai

Sąraše kiekvienam raktui rodoma Pavadinimas, rakto pradžia, Teisės, Sukurta, Paskutinį kartą naudotas, Galiojimo laikas ir būsena: Aktyvus, Greitai pasibaigs, Atšauktas arba Pasibaigęs. Pasirink raktą, kad pamatytum Teisės, Galiojimo laikas, Leidžiami IP adresai, Užklausų limitas (užklausos per minutę), Naudojimas, Paskutinės užklausos ir Istorija.

  1. Eilutėje atidark meniu Parinktys.
  2. Pasirink Generuoti iš naujo, jei integracija turi gauti naują raktą su tomis pačiomis teisėmis. Po Dabartinis raktas pasirink Senas raktas dar 24 val. galioja, kad galėtum perjungti integraciją, arba Atšaukti nedelsiant. Patvirtink su Generuoti iš naujo. STRYK naują raktą rodo vieną kartą.
  3. Pasirink Atšaukti ir patvirtink Atšaukti API raktą?, kad raktas būtų iškart užblokuotas. STRYK atmes užklausas su šiuo raktu.

Webhook'ų nustatymas

In STRYKKanalaiAPIWebhook'ai

Webhook'as siunčia pasirinktus įvykius pasirašytus per HTTPS į tavo sistemas.

  1. Pasirink Sukurti webhook'ą. Atsidaro dialogas Naujas webhook'as.
  2. Įrašyk Gavėjo URL, pavyzdžiui https://crm.nordlicht.invalid/hooks/stryk. Adresas turi prasidėti nuo https://.
  3. Pasirinktinai: įrašyk Aprašymas, pavyzdžiui „Rezervacijos mūsų CRM“.
  4. Po Įvykiai pasirink bent vieną: Rezervacija sukurta, Rezervacija atnaujinta, Rezervacija atšaukta, Svečias pakeistas, Prieinamumas pakeistas, Kaina pakeista, Mokėjimas pakeistas arba Kambario būsena pakeista. Su Pasirinkti visus ir Panaikinti pasirinkimą pasirenki visus arba nė vieno.
  5. Pasirink Sukurti webhook'ą. STRYK rodo Tavo parašo paslaptis vieną kartą.
  6. Įrašyk paslaptį savo gavėjo sistemoje. Kaip gavėjas tikrina parašą, aprašyta kūrėjo dokumentacijoje skyriuje Webhook'ai ir parašo tikrinimas.
  7. Pasirink webhook'ą, o po to Siųsti bandomąjį įvykį. STRYK praneša „Bandomasis įvykis pristatomas.“

Webhook'ų valdymas

Ort: Kanalai > API > Webhook'ai, pasirink webhook

  • Jungikliu Pristatymas aktyvus sustabdai arba aktyvuoji webhook'ą. Sustabdyti webhook'ai įvykių negauna. Po aktyvavimo pristatymas prasideda nuo naujų įvykių.
  • Paskutinės 7 dienos, Paskutinis sėkmingas pristatymas ir Paskutinė klaida rodo būseną. Skiltyje Pristatymai matai kiekvieną pristatymą su HTTP būsena ir Bandymai. Su Siųsti dar kartą pakartoji pristatymą.
  • Atnaujinti slaptą raktą sukuria naują paslaptį. Ankstesnė paslaptis dar 24 valandas galioja, kad galėtum perjungti gavėją.
  • Su Redaguoti keiti adresą ir įvykius, su Ištrinti ir patvirtinimu Ištrinti webhook? pašalini webhook'ą. Pristatymo žurnalas išlieka 30 dienų.

Kaip patikrinti rezultatą

  • Ties raktu rodoma Paskutinį kartą naudotas su data, kai integracija jį naudoja. Užklausos per 24 val. skaičiuoja užklausas.
  • Ties webhook'u Paskutinės 7 dienos rodo „{Zahl} pristatyta, {Zahl} nepavyko“, o bandomasis įvykis rodomas skiltyje Pristatymai.

Jei kažkas neveikia

Ką mataiPriežastisKaip tai išspręsti
„Pasirink bent vieną teisę.“Nė vienai sričiai nėra suteikta teisė.Pasirink šabloną arba bent vienai sričiai pasirink Skaityti arba Rašymas.
„Įrašyk pavadinimą.“Trūksta Pavadinimas.Įrašyk pavadinimą.
„Patikrink:“ su adresuAdresas lauke IP apribojimas netinkamas.Ištaisyk adresą arba CIDR tinklą. Leidžiama daugiausia 20 įrašų.
„Pasirink datą nuo rytojaus, ne ilgiau nei po trejų metų.“Galiojimo data nepatenka į leistiną laikotarpį.Pasirink datą nuo rytojaus, ne toliau kaip trejus metus į priekį.
„Adresas turi prasidėti nuo https://.“Gavėjo URL nėra HTTPS adresas.Įrašyk adresą su https://.
„Pasirink bent vieną įvykį.“Webhook'as neturi nė vieno įvykio.Po Įvykiai pasirink bent vieną.
Sustabdytas dėl pasikartojančių klaidųGavėjas neatsako su 2xx būsena.Patikrink, ar gavėjas pasiekiamas, ir pasirink Aktyvuoti iš naujo.
„Aktyvuok webhook'ą, kad galėtum siųsti bandomąjį įvykį.“Webhook'as sustabdytas.Aktyvuok Pristatymas aktyvus ir siųsk bandomąjį įvykį.
„Pasirinkimo nepavyko įkelti. Uždark ir atidaryk iš naujo.“Teisių ir įvykių sąrašas neįkeltas.Uždark dialogą ir atidaryk jį iš naujo.
Kontaktas