Mine sisu juurde
Task, Channels and Partner API

Partner API: võtmete ja webhook'ide haldamine

Partner API abil ühendad oma broneerimislehed, rakendused ja integratsioonid STRYK-iga. Loo võtmed täpselt vajalike õigustega ja seadista webhook'id.

Last updated: Owner, Developers
Contents
  1. Enne alustamist
  2. Ava API
  3. API-võtme loomine
  4. Võtmete haldamine
  5. Webhook'ide seadistamine
  6. Webhook'ide haldamine
  7. Tulemuse kontrollimine
  8. Kui midagi ei toimi
  9. Sellega seotud

Enne alustamist

  • Vajad õigust Halda kanaleid. Ainult sel juhul näed lehel Kanalid rida API.
  • Selgita, millistes valdkondades integratsioon peab lugema või kirjutama. Võti saab ainult need õigused.
  • Integratsioon kutsub Partner API välja oma serverist. Võtit ei pane sa kunagi brauseri koodi ega rakendusse. Lõpp-punktid, parameetrid ja näited leiad arendajadokumentatsioonist. Seal selgitab jaotis Autentimine ja õigusalad, mida iga õigus lubab.
  • Webhook'id vajavad vastuvõtjat aadressiga, mis algab https://.

Ava API

In STRYKKanalid

  1. Vali jaotises Oma ühendused rida API lisatekstiga „API-võtmed ja webhook'id“. Avaneb dialoog API.
  2. Vali vahekaart API-võtmed või Webhook'id. Dialoogi päises avab nupp Arendajadokumentatsioon arendajaportaali.
  1. Vahekaardid API-võtmed ja Webhook'id
  2. Võtmed koos õigustega
  3. Võtme toimingud

API-võtme loomine

In STRYKKanalidAPIAPI-võtmed

  1. Vali API-võtme loomine. Avaneb dialoog API-võtme loomine.
  2. Sisesta Nimi, näiteks „Broneerimisleht“.
  3. Vali jaotises Õigused muster: Ainult lugemine (kõigi valdkondade lugemine), Lugemine & kirjutamine (kirjutamine seal, kus see on võimalik) või Kohandatud. Valiku Kohandatud korral vali igal alal Ligipääs puudub, Lugemine või Kirjutamine. Valdkonnad on Hotell ja toad, Saadavus, Hinnad & tariifid, Broneeringud, Külalised, Maksed ja Arved. Kirjutamine hõlmab ka Lugemist. Arved on hotelli fiskaaldokumendid ning neid saab API kaudu ainult lugeda.
  4. Valikuline: ava Täpsem. Vali Aegumine: Aegumist pole, 30 päeva, 90 päeva, 1 aasta või Kuupäev (alates homsest, kuni kolm aastat ette). Rubriigis IP-piirang sisesta igale reale üks aadress või CIDR-võrk, kuni 20. Tühi väli lubab kõik aadressid. Rubriigis Märkus jätad sisemise märkuse.
  5. Vali Loo. STRYK näitab teadet API-võti loodud koos võtmega ja märkusega Ainult praegu nähtav.
  6. Kopeeri võti ja salvesta see näiteks paroolihaldurisse. Vali Valmis.

Võtmete haldamine

In STRYKKanalidAPIAPI-võtmed

Nimekirjas näed igal võtmel Nimi, võtme algust, Õigused, Loodud, Viimati kasutatud, Aegumine ja staatust: Aktiivne, Aegub varsti, Tühistatud või Aegunud. Vali võti, et näha Õigused, Aegumine, Lubatud IP-aadressid, Päringupiirang (päringud minutis), Kasutus, Viimased päringud ja Ajalugu.

  1. Ava rea menüü Valikud.
  2. Vali Loo uus, kui integratsioon peab saama uue võtme samade õigustega. Vali jaotises Praegune võti Vana võti kehtib veel 24 h, et saaksid integratsiooni ümber seadistada, või Tühista kohe. Kinnita nupuga Loo uus. STRYK näitab uut võtit ühe korra.
  3. Vali Tühista ja kinnita API-võtme tühistamine?, et võti kohe blokeerida. STRYK lükkab selle võtmega tehtud päringud siis tagasi.

Webhook'ide seadistamine

In STRYKKanalidAPIWebhook'id

Webhook saadab valitud sündmused allkirjastatult HTTPS kaudu sinu süsteemidesse.

  1. Vali Lisa webhook. Avaneb dialoog Uus webhook.
  2. Sisesta Saaja URL, näiteks https://crm.nordlicht.invalid/hooks/stryk. Aadress peab algama https://.
  3. Valikuline: sisesta Kirjeldus, näiteks „Broneeringud meie CRM-i“.
  4. Vali jaotises Sündmused vähemalt üks: Broneering loodud, Broneering muudetud, Broneering tühistatud, Külaline muudetud, Saadavus muutunud, Hind muudetud, Makse muudetud või Toa olek muudetud. Nuppudega Vali kõik ja Tühista valik valid kõik või ei vali ühtegi.
  5. Vali Lisa webhook. STRYK näitab Sinu allkirjastussaladus ühe korra.
  6. Lisa saladus oma vastuvõtjasse. Kuidas vastuvõtja allkirja kontrollib, kirjeldab arendajadokumentatsioon jaotises Webhook'id ja allkirja kontroll.
  7. Vali webhook ja seejärel Saada testsündmus. STRYK teatab „Testsündmus edastatakse.“

Webhook'ide haldamine

Ort: Kanalid > API > Webhook'id, vali webhook

  • Lülitiga Edastus aktiivne peatad või aktiveerid webhook'i. Peatatud webhook'id ei saa sündmusi. Pärast aktiveerimist algab edastamine uutest sündmustest.
  • Viimased 7 päeva, Viimane õnnestumine ja Viimane viga näitavad seisu. Jaotises Saatmised näed iga edastust koos HTTP-staatus ja Katsed. Nupuga Saada uuesti kordad edastust.
  • Uuenda saladus loob uue saladuse. Senine jääb veel 24 tunniks kehtima, et saaksid vastuvõtja ümber seadistada.
  • Nupuga Muuda muudad aadressi ja sündmusi, nupuga Kustuta ja kinnitusega Kustuta webhook? eemaldad webhook'i. Edastuslogi jääb alles 30 päevaks.

Tulemuse kontrollimine

  • Võtme juures on Viimati kasutatud koos kuupäevaga, kui integratsioon seda kasutab. Päringud 24 h loeb päringuid.
  • Webhook'i juures näitab Viimased 7 päeva „{Zahl} edastatud, {Zahl} ebaõnnestunud“ ja testsündmus on jaotises Saatmised.

Kui midagi ei toimi

Mida näedPõhjusKuidas lahendada
„Vali vähemalt üks õigus.“Ükski valdkond ei oma õigust.Vali muster või anna vähemalt ühele valdkonnale Lugemine või Kirjutamine.
„Palun sisesta nimi.“Väli Nimi on tühi.Sisesta nimi.
„Palun kontrolli:“ koos aadressigaRubriigi IP-piirang aadress on vale.Paranda aadress või CIDR-võrk. Lubatud on kuni 20 kirjet.
„Palun vali kuupäev alates homsest, kuni kolm aastat ette.“Aegumise kuupäev on vahemikust väljas.Vali kuupäev alates homsest, mis on kõige kaugemal kolm aastat ette.
„Aadress peab algama https://.“Väli Saaja URL ei ole HTTPS-aadress.Sisesta aadress, mis algab https://.
„Vali vähemalt üks sündmus.“Webhook'il ei ole ühtegi sündmust.Vali jaotises Sündmused vähemalt üks.
Korduvate vigade tõttu peatatudSaaja ei vasta 2xx-staatusega.Kontrolli, kas vastuvõtja on kättesaadav, ja vali Aktiveeri uuesti.
„Aktiveeri webhook, et saata testsündmus.“Webhook on peatatud.Aktiveeri Edastus aktiivne ja saada testsündmus.
„Valikut ei õnnestunud laadida. Palun sulge ja ava uuesti.“Õiguste ja sündmuste loend pole laaditud.Sulge dialoog ja ava see uuesti.
Kontakt