Skip to content
HotelsCalendar Docs
Eesti

API arendajatele

MiksAnda hotelli arendajale või integreerijale lähtepunkt: mis see API on, kus asub tema spetsifikatsioon ja kuidas toimib juurdepääs.
KelleleArendajale, kes ühendab HotelsCalendariga oma süsteemi; majutusasutuse omanikule — et näidata allhankijale.
Mida saateArusaam API pinnast — milliseid andmeid sellega kätte saab — ja juurdepääsu saamise protsessist: token ja baas-URL.
PiirangudSee on lähtepunkt, mitte meetodite käsiraamat: täielik loend on spetsifikatsioonis; tehnilised piirid ei ole avaldatud.

HotelsCalendaril on API: samad broneeringud, saadavus ja külalised, millega Te liideses töötate, — programmiliselt. See leht on lähtepunkt: mis see liides on, kus asub tema spetsifikatsioon ja kuidas juurdepääsu saada. Koodinäiteid siin ei ole — need asendab spetsifikatsioon.

Mis on HotelsCalendari API

Section titled “Mis on HotelsCalendari API”

API on programmiline liides HotelsCalendari peal. See väljastab ja võtab vastu samu andmeid, millega töötab PMS-i liides: broneeringud, saadavus, külalised. Liides on inimestele, API tarkvarale: hotelli oma süsteem — majandustarkvara, skript või tabel — loeb ja muudab hotelli andmeid ilma käsitsi ülekandeta.

API andmed räägivad sama keelt nagu selle dokumentatsiooni artiklid: broneeringud olekute ja külalistega, saadavus kuupäevade kaupa, külaliste andmed. Seepärast tasub enne ühendamist mõista, kuidas toode neid mõisteid kirjeldab — just sellest algab iga integreerimine.

Spetsifikatsioon

Section titled “Spetsifikatsioon”

API täielik kirjeldus on OpenAPI spetsifikatsioon — fail openapi.yaml: seal on loetletud kõik meetodid — mida igaüks vastu võtab ja tagastab — ning andmemudelid. Spetsifikatsioon on rühmitatud umbes 24 teemalisse jaotisesse.

Spetsifikatsiooni saab avada ja alla laadida API baas-URL-i kaudu — aadressilt, mis väljastatakse koos juurdepääsuga. See on võimaluste tõeallikas: kõik, mis seal kirjas, suudab API; seda, mis seal puudub, API ei luba.

Autoriseerimine

Section titled “Autoriseerimine”

Juurdepääs API-le toimub tokeniga: isikliku võtmega, mis kaasneb iga päringuga. Tokeni põhjal saab API aru, millisest majutusasutusest päring tuleb ja mida see juurdepääs tohib.

Token ja baas-URL tulevad koos — juurdepääsu avamisel (kuidas seda taotleda — allpool). Käitu tokeniga nagu parooliga: see avab majutusasutuse andmed, seepärast hoitakse seda Teie poolel ega avalikustata.

Tüüpilised stsenaariumid

Section titled “Tüüpilised stsenaariumid”
  • Teie oma analüütika. Broneeringud eksporditakse Teie BI-süsteemi või tabelisse — ja seal arvutatakse neid nii, nagu Teile vaja, ilma igakuise käsitsi eksportimiseta.
  • Sünkroonimine sisemiste süsteemidega. Hotelli majandustarkvara või siseteenus saab broneeringud ja muudatused PMS-ist — ja andmed ei lähe süsteemide vahel lahku.
  • Väiksed tööriistad ja vidinad. Kerge tööriist hotelli andmete peal — siseline leht personalile, kokkuvõte haldajale —, mis loeb andmeid otse PMS-ist.

Kõigis kolmes stsenaariumis on teekond sama: saage token, leidke spetsifikatsioonist vajalikud meetodid ja ühendage oma süsteem.

Mida ei ole / piirid

Section titled “Mida ei ole / piirid”
  • API tehnilised piirid — päringute sagedus, eksportide mahud — ei ole selles artiklis avaldatud.
  • Võimaluste loend on ainult spetsifikatsioon: meetodeid ja andmemudeleid kirjeldab openapi.yaml, artikkel ei luba sellest midagi enamat.
  • Kuidas API aja jooksul muutub — versioonide ühilduvus, kuidas muudatustest teavitatakse —, seda see leht samuti ei luba: tingimused lepitakse kokku juurdepääsu avamisel.
  • Samm-sammulisi koodinäiteid ei ole siin samuti — nende rolli täidab spetsifikatsioon.

Kuidas juurdepääsu saada

Section titled “Kuidas juurdepääsu saada”
  1. Kirjutage meile HotelsCalendari veebisaidi lehelt „Kontakt“: kirjeldage ülesannet — milline süsteem ühendatakse ja milliseid andmeid tal on vaja.
  2. Saadame Teile tokeni ja API baas-URL-i.
  3. Edasi — spetsifikatsiooni järgi: leidke oma ülesandele sobivad meetodid ja ühendage oma süsteem.

Kui küsimus ei puuduta arendust, vaid hotelli haldamist — alustage tugilehelt.

Vaata ka

Section titled “Vaata ka”