Partner API: Stjórna lyklum og webhook
Með Partner API tengir þú eigin bókunarsíður, forrit og samþættingar við STRYK. Þú býrð til lykla með nákvæmlega þeim réttindum sem þarf og setur upp webhook.
Contents
Áður en þú byrjar
- Þú þarft réttindið Stjórna rásum. Aðeins þá sérðu línuna API á síðunni Rásir.
- Athugaðu hvaða svið samþættingin þarf að lesa eða skrifa í. Lykill fær aðeins þessi réttindi.
- Samþættingin kallar á Partner API frá netþjóninum sínum. Lykilinn setur þú aldrei í vafrakóða eða forrit. Endapunkta, færibreytur og dæmi finnur þú í Forritaraskjölunum. Þar útskýrir kaflinn Auðkenning og heimildir hvað hvert réttindi leyfir.
- Vefkrókar þurfa móttakara með vistfangi sem byrjar á https://.
Opna API
In STRYKRásir
- Veldu línuna API undir Eigin tengingar með viðbótinni „API-lyklar og webhook“. Glugginn API opnast.
- Veldu flipann API-lyklar eða Webhook. Með Forritaraskjöl í haus gluggans opnar þú þróunargáttina.
- Flipar API-lyklar og Webhook
- Lyklar með réttindum
- Aðgerðir lykils
Búa til API-lykil
In STRYKRásirAPIAPI-lyklar
- Veldu Búa til API-lykil. Glugginn Búa til API-lykil opnast.
- Settu inn Nafn, til dæmis „Bókunarsíða“.
- Veldu undir Réttindi mynstur: Aðeins lesa (lesa öll svið), Lesa og skrifa (skrifa þar sem hægt er) eða Sérsniðið. Við Sérsniðið velur þú fyrir hvert svið Enginn aðgangur, Lesa eða Skrifa. Sviðin eru Hótel og herbergi, Framboð, Verð og verðskrár, Bókanir, Gestir, Greiðslur og Reikningar. Skrifa felur í sér Lesa. Reikningar eru skattgögn hótelsins og aðeins hægt að lesa þá í gegnum API.
- Valfrjálst: Opnaðu Ítarlegt. Veldu Gildislok: Ekkert gildislok, 30 dagar, 90 dagar, 1 ár eða Dagsetning (frá morgundeginum, í mesta lagi þremur árum síðar). Settu inn undir IP-takmörkun eitt vistfang eða CIDR-net í hverri línu, í mesta lagi 20. Ef reiturinn er tómur eru öll vistföng leyfð. Undir Athugasemd heldurðu eftir innri ábendingu.
- Veldu Búa til. STRYK sýnir API-lykill búinn til með lyklinum og athugasemdinni Aðeins sýnilegt núna.
- Afritaðu lykilinn og vistaðu hann til dæmis í lykilorðastjóranum. Veldu Lokið.
Stjórna lyklum
In STRYKRásirAPIAPI-lyklar
Listinn sýnir fyrir hvern lykil Nafn, upphaf lykilsins, Réttindi, Búið til, Síðast notað, Gildislok og stöðuna: Virkt, Rennur fljótlega út, Afturkallað eða Útrunnið. Veldu lykil til að sjá Réttindi, Gildislok, Leyfð IP-vistföng, Takmörkun beiðna (beiðnir á mínútu), Notkun, Síðustu beiðnir og Söguna.
- Opnaðu valmyndina Valkostir í línunni.
- Veldu Endurnýja ef samþættingin á að fá nýjan lykil með sömu réttindum. Veldu undir Núverandi lykill Gamli lykillinn gildir enn í 24 klst. til að geta skipt samþættingunni yfir, eða Afturkalla strax. Staðfestu með Endurnýja. STRYK sýnir nýja lykilinn einu sinni.
- Veldu Afturkalla og staðfestu Afturkalla API-lykil? til að loka lykli strax. STRYK hafnar þá beiðnum sem nota þennan lykil.
Setja upp webhook
In STRYKRásirAPIWebhook
Webhook sendir völdu atburðina undirritaða um HTTPS til kerfanna þinna.
- Veldu Búa til webhook. Glugginn Nýr webhook opnast.
- Settu inn Móttökuslóð, til dæmis https://crm.nordlicht.invalid/hooks/stryk. Vistfangið verður að byrja á https://.
- Valfrjálst: Settu inn Lýsing, til dæmis „Bókanir í CRM-kerfið okkar“.
- Veldu undir Atburðir að minnsta kosti einn: Bókun stofnuð, Bókun uppfærð, Bókun afbókuð, Gestur breyttur, Framboð breytt, Verð breytt, Greiðsla breytt eða Staða herbergis breytt. Með Velja allt og Afvelja allt velur þú alla eða engan.
- Veldu Búa til webhook. STRYK sýnir Undirritunarleyndarmálið þitt einu sinni.
- Geymdu leyndarmálið í móttakaranum. Hvernig móttakarinn athugar undirritunina lýsir þróunarskjölunum undir Webhook og yfirferð undirritunar.
- Veldu webhook-ið og síðan Senda prófunaratburð. STRYK segir „Prófunaratburðurinn er sendur.“
Stjórna webhook
Ort: Rásir > API > Webhook, veldu webhook
- Með rofanum Afhending virk gerirðu hlé á webhook-inu eða virkjar það. Webhook í bið fær engin atburði. Eftir virkjun byrjar afhendingin með nýjum atburðum.
- Síðustu 7 daga, Síðasti árangur og Síðasta villa sýna stöðuna. Undir Sendingar sérðu hverja sendingu með HTTP-staða og Tilraunir. Með Senda aftur endurtekur þú sendingu.
- Endurnýja leyndarmál býr til nýtt leyndarmál. Það fyrra gildir enn í 24 klukkustundir svo þú getir skipt móttakaranum yfir.
- Með Breyta breytir þú vistfangi og atburðum, með Eyða og staðfestingunni Eyða vefkrók? fjarlægir þú hann. Afhendingarskráin er varðveitt í 30 daga.
Svona athugar þú niðurstöðuna
- Á lyklinum stendur Síðast notað með dagsetningu um leið og samþættingin notar hann. Beiðnir 24 klst. telur beiðnirnar.
- Á webhook-inu sýnir Síðustu 7 daga „{Zahl} afhent, {Zahl} mistókst“, og prófunaratburðurinn er undir Sendingar.
Ef eitthvað virkar ekki
| Hvað þú sérð | Orsök | Svona lagar þú það |
|---|---|---|
| „Veldu að minnsta kosti einn rétt.“ | Ekkert svið hefur réttindi. | Veldu mynstur eða gefðu að minnsta kosti einu sviði Lesa eða Skrifa. |
| „Vinsamlegast settu inn nafn.“ | Reitinn Nafn vantar. | Settu inn nafn. |
| „Athugaðu:“ ásamt vistfangi | Vistfang í IP-takmörkun er ógilt. | Leiðréttu vistfangið eða CIDR-netið. Leyfðar eru í mesta lagi 20 færslur. |
| „Veldu dagsetningu frá morgundeginum, í mesta lagi þremur árum síðar.“ | Gildislokadagsetningin er utan tímabilsins. | Veldu dagsetningu frá morgundeginum sem er í mesta lagi þrjú ár fram í tímann. |
| „Vistfangið verður að byrja á https://.“ | Móttökuslóð er ekki HTTPS-vistfang. | Settu inn vistfang sem byrjar á https://. |
| „Veldu að minnsta kosti einn atburð.“ | Webhook-ið hefur engan atburð. | Veldu að minnsta kosti einn undir Atburðir. |
| Í bið vegna endurtekinna villna | Móttakarinn svarar ekki með 2xx-stöðu. | Athugaðu hvort móttakarinn sé aðgengilegur og veldu Virkja aftur. |
| „Virkjaðu webhook-ið til að senda prófunaratburð.“ | Webhook-ið er í bið. | Virkjaðu Afhending virk og sendu prófunaratburðinn. |
| „Ekki tókst að hlaða valkostunum. Vinsamlegast lokaðu og opnaðu aftur.“ | Listinn yfir réttindi og atburði hefur ekki hlaðist. | Lokaðu glugganum og opnaðu hann aftur. |