API kūrėjams

Kodėl	Suteikti viešbučio kūrėjui arba integratoriui išeities tašką: kas tai per API, kur jo specifikacija ir kaip veikia prieiga.
Kam	Kūrėjui, kuris prie HotelsCalendar prijungia savo sistemą; savininkui – kad būtų ką parodyti rangovui.
Ką gausite	API galimybių vaizdas – kokie duomenys per jį pasiekiami – ir prieigos proceso supratimas: tokenas ir bazinis URL.
Apribojimai	Tai išeities taškas, o ne metodų žinynas: pilnas sąrašas – specifikacijoje; techniniai limitai neskelbiami.

HotelsCalendar turi API: tas pačias rezervacijas, prieinamumą ir svečius, su kuriais dirbate sąsajoje, galima pasiekti ir programiniu būdu. Šis puslapis – išeities taškas: kas tai per sąsaja, kur jos specifikacija ir kaip gauti prieigą. Kodo pavyzdžių čia nėra – juos pakeičia specifikacija.

Kas yra HotelsCalendar API

API – programinė sąsaja virš produkto. Ji atiduoda ir priima tuos pačius duomenis, kuriuos pateikia PMS sąsaja: rezervacijas, prieinamumą, svečius. Sąsaja – žmonėms, API – programoms: sava apskaitos sistema, scenarijus arba lentelė skaito ir keičia viešbučio duomenis be rankinio perkėlimo.

API duomenys kalba tais pačiais žodžiais kaip šios dokumentacijos straipsniai: rezervacijos su būsenomis ir svečiais, prieinamumas pagal datas, svečių duomenys. Todėl prieš prijungiant verta suprasti, kaip produktas aprašo šias sąvokas – nuo to ir prasideda kiekviena integracija.

Specifikacija

Pilną API aprašą sudaro OpenAPI specifikacija – failas openapi.yaml: joje išvardyti visi metodai – ką kiekvienas priima ir grąžina – bei duomenų modeliai. Specifikacija sugrupuota maždaug į 24 teminius skyrius.

Specifikaciją galima atidaryti ir atsisiųsti per API bazinį URL – adresą, kuris išduodamas kartu su prieiga. Ji – tiesos šaltinis apie galimybes: visa, ką ji aprašo, API moka; ko joje nėra – to API nežada.

Autorizacija

Prieiga prie API – per tokeną: asmeninį raktą, kuris perduodamas su kiekviena užklausa. Iš tokeno API supranta, iš kurio objekto ateina užklausa ir ką šiai prieigai leista daryti.

Tokenas ir bazinis URL atkeliauja kartu – prijungiant prieigą (kaip jų paprašyti – žemiau). Elkitės su tokenu kaip su slaptažodžiu: jis atveria objekto duomenis, todėl laikomas jūsų pusėje ir neskelbiamas.

Tipiniai scenarijai

• Sava analitika. Rezervacijos eksportuojamos į jūsų BI sistemą arba lentelę – ir ten skaičiuojamos taip, kaip jums reikia, be rankinio eksporto kiekvieną mėnesį.
• Sinchronizacija su vidinėmis sistemomis. Apskaitos programa arba viešbučio vidaus sistema gauna rezervacijas ir pakeitimus iš PMS – ir duomenys tarp sistemų nesiskiria.
• Smulkūs įrankiai ir valdikliai. Nedidelis įrankis, paremtas viešbučio duomenimis – vidinis puslapis personalui, santrauka valdytojui, – kuris duomenis iš PMS paima tiesiogiai.

Visuose trijuose scenarijuose kelias tas pats: gaukite tokeną, specifikacijoje raskite reikiamus metodus ir prijunkite savo sistemą.

Ko nėra / ribos

• Techniniai API limitai – užklausų dažnis, eksportų apimtys – šiame straipsnyje neskelbiami.
• Galimybių sąrašas – vien specifikacija: metodus ir modelius aprašo openapi.yaml, o straipsnis nieko daugiau nežada.
• Kaip API keičiasi laikui bėgant – versijų suderinamumas, kaip pranešama apie pakeitimus – to šis puslapis irgi nežada: sąlygos aptariamos prijungimo metu.
• Žingsnis po žingsnio pateikiamų kodo pavyzdžių čia irgi nėra – jų vaidmenį atlieka specifikacija.

Kaip gauti prieigą

1. Parašykite mums per svetainės HotelsCalendar puslapį „Kontaktai“: aprašykite užduotį – kokia sistema prijungiama ir kokių duomenų jai reikia.
2. Atsiųsime tokeną ir bazinį API URL.
3. Toliau – pagal specifikaciją: raskite savo užduočiai tinkamus metodus ir prijunkite savo sistemą.

Jei klausimas ne apie kūrimą, o apie viešbučio tvarkymą – pradėkite nuo palaikymo puslapio.

Taip pat žr.

• Palaikymas ir kontaktai – kur ir kaip rašyti komandai: nuo palaikymo prasideda ir API prieiga.
• Viešbučių terminų žodynas – duomenyse sutinkamų srities terminų paaiškinimai: rezervacija, prieinamumas, tarifas, įsiregistravimas.