Partner API: avainten ja webhookien hallinta
Partner API:n avulla yhdistät omat varaussivusi, sovelluksesi ja integraatiosi STRYK-järjestelmään. Luot avaimet täsmälleen tarvittavilla oikeuksilla ja määrität webhookit.
Contents
Ennen aloittamista
- Tarvitset oikeuden Hallitse kanavia. Vain sen avulla näet rivin API sivulla Kanavat.
- Selvitä, mitä alueita integraation pitää lukea tai kirjoittaa. Avaimella on vain nämä oikeudet.
- Integraatio kutsuu Partner API:a omalta palvelimeltaan. Avainta et koskaan laita selaimen koodiin tai sovellukseen. Päätepisteet, parametrit ja esimerkit löydät kehittäjädokumentaatiosta. Siellä kohta Todennus ja oikeusalueet kertoo, mitä kukin oikeus sallii.
- Webhookit tarvitsevat vastaanottajan osoitteen, joka alkaa https://.
Avaa API
In STRYKKanavat
- Valitse kohdasta Omat yhteydet rivi API tekstillä „API-avaimet ja webhookit“. Dialogi API avautuu.
- Valitse välilehti API-avaimet tai Webhookit. Dialogin yläreunan painikkeella Kehittäjädokumentaatio avaat kehittäjäportaalin.
- Välilehdet API-avaimet ja Webhookit
- Avaimet oikeuksineen
- Avaimen toiminnot
Luo API-avain
In STRYKKanavatAPIAPI-avaimet
- Valitse Luo API-avain. Dialogi Luo API-avain avautuu.
- Kirjoita Nimi, esimerkiksi „Varaussivu“.
- Valitse kohdasta Oikeudet malli: Vain lukeminen (lukee kaikki alueet), Lukeminen ja kirjoittaminen (kirjoittaa, missä se on mahdollista) tai Mukautettu. Kohdassa Mukautettu valitset jokaiselle alueelle Ei käyttöoikeutta, Lukuoikeus tai Kirjoitusoikeus. Alueet ovat Hotelli ja huoneet, Saatavuus, Hinnat ja hinnoittelu, Varaukset, Vieraat, Maksut ja Laskut. Kirjoitusoikeus sisältää Lukuoikeuden. Laskut ovat hotellin verotuksellisia tositteita, ja niitä voi API:n kautta vain lukea.
- Valinnainen: avaa Lisäasetukset. Valitse Vanhenemisaika: Ei vanhenemista, 30 päivää, 90 päivää, 1 vuosi tai Päivämäärä (alkaen huomisesta, enintään kolme vuotta eteenpäin). Kohtaan IP-rajoitus kirjoita jokaiselle riville yksi osoite tai CIDR-verkko, enintään 20. Tyhjä kenttä sallii kaikki osoitteet. Kohtaan Muistiinpano voit kirjata sisäisen huomautuksen.
- Valitse Luo. STRYK näyttää API-avain luotu -ilmoituksen avaimen kanssa sekä huomautuksen Näkyy vain nyt.
- Kopioi avain ja tallenna se esimerkiksi salasanahallintaan. Valitse Valmis.
Hallitse avaimia
In STRYKKanavatAPIAPI-avaimet
Luettelo näyttää jokaisesta avaimesta Nimi, avaimen alun, Oikeudet, Luotu, Viimeksi käytetty, Vanhenemisaika ja tilan: Aktiivinen, Vanhenee pian, Mitätöity tai Vanhentunut. Valitse avain, niin näet Oikeudet, Vanhenemisaika, Sallitut IP-osoitteet, Pyyntöraja (pyyntöjä minuutissa), Käyttö, Viimeisimmät pyynnöt ja Historia.
- Avaa rivin valikko Vaihtoehdot.
- Valitse Luo uudelleen, jos integraatioon tarvitaan uusi avain samoilla oikeuksilla. Valitse kohtaan Nykyinen avain joko Vanha avain voimassa vielä 24 h, jotta ehdit vaihtaa integraation, tai Mitätöi heti. Vahvista valinnalla Luo uudelleen. STRYK näyttää uuden avaimen kerran.
- Valitse Mitätöi ja vahvista kysymys Mitätöidäänkö API-avain?, jos haluat estää avaimen heti. STRYK hylkää tällä avaimella tehdyt pyynnöt.
Määritä webhookit
In STRYKKanavatAPIWebhookit
Webhook lähettää valitut tapahtumat allekirjoitettuina HTTPS-yhteyden kautta järjestelmiisi.
- Valitse Luo webhook. Dialogi Uusi webhook avautuu.
- Kirjoita Vastaanottajan URL-osoite, esimerkiksi https://crm.nordlicht.invalid/hooks/stryk. Osoitteen on alettava https://.
- Valinnainen: kirjoita Kuvaus, esimerkiksi „Varaukset CRM-järjestelmäämme“.
- Valitse kohdasta Tapahtumat vähintään yksi: Varaus luotu, Varaus muutettu, Varaus peruttu, Vieras muutettu, Saatavuus muuttui, Hinta muutettu, Maksu muutettu tai Huoneen tila muutettu. Valinnoilla Valitse kaikki ja Poista valinta valitset kaikki tai et yhtään.
- Valitse Luo webhook. STRYK näyttää Allekirjoitussalaisuutesi kerran.
- Tallenna salaisuus vastaanottajaan. Miten vastaanottaja tarkistaa allekirjoituksen, kuvaa kehittäjädokumentaatio kohdassa Webhookit ja allekirjoituksen tarkistus.
- Valitse webhook ja sen jälkeen Lähetä testitapahtuma. STRYK ilmoittaa „Testitapahtuma toimitetaan.“
Hallitse webhookeja
Ort: Kanavat > API > Webhookit, valitse webhook
- Kytkimellä Toimitus käytössä keskeytät tai aktivoit webhookin. Keskeytetyt webhookit eivät saa tapahtumia. Aktivoinnin jälkeen toimitus alkaa uusista tapahtumista.
- Viimeiset 7 päivää, Viimeisin onnistunut ja Viimeisin virhe näyttävät tilanteen. Kohdassa Toimitukset näet jokaisen toimituksen HTTP-tila- ja Yritykset-tiedot. Valinnalla Lähetä uudelleen toistat toimituksen.
- Vaihda allekirjoitussalaisuus luo uuden salaisuuden. Vanha pysyy voimassa vielä 24 tuntia, jotta ehdit vaihtaa vastaanottajan.
- Muuta osoitetta ja tapahtumia valinnalla Muokkaa. Poista webhook valinnalla Poista ja vahvistuksella Poistetaanko webhook?. Toimitusloki säilyy 30 päivää.
Tuloksen tarkistaminen
- Avaimella näkyy Viimeksi käytetty päivämäärän kanssa heti, kun integraatio käyttää sitä. Pyynnöt 24 h laskee pyynnöt.
- Webhookilla Viimeiset 7 päivää näyttää „{Zahl} toimitettu, {Zahl} epäonnistunut“, ja testitapahtuma näkyy kohdassa Toimitukset.
Jos jokin ei toimi
| Mitä näet | Syy | Näin korjaat sen |
|---|---|---|
| „Valitse vähintään yksi oikeus.“ | Yhdelläkään alueella ei ole oikeutta. | Valitse malli tai anna vähintään yhdelle alueelle Lukuoikeus tai Kirjoitusoikeus. |
| „Anna nimi.“ | Nimi puuttuu. | Kirjoita nimi. |
| „Tarkista:“ ja osoite | Yksi osoite kohdassa IP-rajoitus on virheellinen. | Korjaa osoite tai CIDR-verkko. Sallittuja merkintöjä on enintään 20. |
| „Valitse päivämäärä huomisesta alkaen, enintään kolme vuotta eteenpäin.“ | Vanhenemispäivä on aikavälin ulkopuolella. | Valitse päivämäärä huomisesta alkaen, enintään kolme vuotta tulevaisuuteen. |
| „Osoitteen on alettava https://.“ | Vastaanottajan URL-osoite ei ole HTTPS-osoite. | Kirjoita osoite, joka alkaa https://. |
| „Valitse vähintään yksi tapahtuma.“ | Webhookilla ei ole yhtään tapahtumaa. | Valitse kohdasta Tapahtumat vähintään yksi. |
| Keskeytetty toistuvien virheiden vuoksi | Vastaanottaja ei vastaa 2xx-tilalla. | Tarkista, että vastaanottaja on tavoitettavissa, ja valitse Ota uudelleen käyttöön. |
| „Aktivoi webhook lähettääksesi testitapahtuman.“ | Webhook on keskeytetty. | Aktivoi Toimitus käytössä ja lähetä testitapahtuma. |
| „Valinnan lataaminen ei onnistunut. Sulje ja avaa uudelleen.“ | Oikeuksien ja tapahtumien luettelo ei ole latautunut. | Sulje dialogi ja avaa se uudelleen. |