API izstrādātājiem

Kāpēc	Dot viesnīcas izstrādātājam vai integratoram sākumpunktu: kas šis API ir, kur atrodas tā specifikācija un kā darbojas piekļuve.
Kam	Izstrādātājam, kas HotelsCalendar pieslēdz savu sistēmu; objekta īpašniekam — lai parādītu izpildītājam.
Ko iegūsiet	Skaidrību par API iespēju apjomu — kādus datus ar to var iegūt — un par piekļuves procesu: tokens un bāzes URL.
Ierobežojumi	Šis ir sākumpunkts, nevis metožu uzziņa: pilnais saraksts ir specifikācijā; tehniskie ierobežojumi netiek publicēti.

HotelsCalendar ir API: tie paši rezervējumi, pieejamība un viesi, ar kuriem strādājat saskarnē, — tagad pieejami arī programmām. Šī lapa ir sākumpunkts: kas tas ir par saskarni, kur atrodas tās specifikācija un kā iegūt piekļuvi. Kodu piemēru šeit nav — to vietā nāk specifikācija.

Kas ir HotelsCalendar API

API ir programmēšanas saskarne virs produkta. Tas atdod un pieņem tos pašus datus, ar kuriem strādā PMS saskarne: rezervējumus, pieejamību, viesus. Saskarne ir cilvēkiem, API — programmām: sava uzskaites sistēma, skripts vai izklājlapa nolasa un maina viesnīcas datus bez manuālas pārnešanas.

API dati runā tajā pašā valodā, kādā rakstīti šīs dokumentācijas raksti: rezervējumi ar statusiem un viesiem, pieejamība pa dienām, viesu dati. Tāpēc pirms pieslēgšanas noder saprast, kā produkts apraksta šos jēdzienus — jebkura integrācija sākas tieši ar to.

Specifikācija

Pilns API apraksts ir OpenAPI specifikācija — fails openapi.yaml: tajā uzskaitītas visas metodes (ko katra pieņem un ko atgriež) un datu modeļi. Specifikācija sadalīta aptuveni 24 tematiskās sadaļās.

Specifikāciju var atvērt un lejupielādēt, izmantojot API bāzes URL — adresi, ko izsniedz kopā ar piekļuvi. Tā ir patiesības avots par iespējām: viss, kas tajā aprakstīts, API spēj; kas tajā nav iekļauts, to API nesola.

Autorizācija

Piekļuve API — ar tokenu: personīgu atslēgu, ko līdzi nodod katrs pieprasījums. Pēc tokena API zina, no kura objekta nāk pieprasījums un ko šai piekļuvei atļauts darīt.

Tokens un bāzes URL nonāk pie Jums kopā — pieslēgšanas brīdī (kā to noformēt — zemāk). Ar tokenu rīkojieties kā ar paroli: tas atver objekta datus, tāpēc glabājas Jūsu pusē un netiek publicēts.

Tipiski scenāriji

• Sava analītika. Rezervējumus eksportē uz Jūsu BI sistēmu vai izklājlapu — un tur tos rēķina tā, kā Jums vajag, bez manuālas eksportēšanas katru mēnesi.
• Sinhronizācija ar iekšējām sistēmām. Uzskaites programma vai viesnīcas iekšējā sistēma saņem rezervējumus un izmaiņas no PMS — un dati visās sistēmās paliek saskaņoti.
• Mazie rīki un logrīki. Neliels rīks virs viesnīcas datiem — iekšēja lapa darbiniekiem, pārskats vadītājam — kas datus nolasa tieši no PMS.

Visiem trim scenārijiem ceļš ir viens: iegūt tokenu, specifikācijā atrast vajadzīgās metodes un pieslēgt savu sistēmu.

Ko šeit nav / robežas

• Tehniskie API ierobežojumi — pieprasījumu biežums, eksporta apjomi — šajā rakstā netiek publicēti.
• Iespēju sarakstu nosaka tikai specifikācija: metodes un modeļus apraksta openapi.yaml, un raksts nesola neko vairāk par to.
• Kā API mainās laika gaitā — versiju saderība, kārtība, kādā par izmaiņām tiek ziņots, — arī šī lapa to nesola: par nosacījumiem vienojas pieslēgšanas brīdī.
• Arī soli pa solim izklāstītu kodu piemēru šeit nav — šo lomu pilda specifikācija.

Kā iegūt piekļuvi

1. Uzrakstiet mums, izmantojot HotelsCalendar vietnes lapu „Kontakti”: aprakstiet uzdevumu — kāda sistēma tiek pieslēgta un kādi dati tai vajadzīgi.
2. Mēs nosūtīsim tokenu un API bāzes URL.
3. Tālāk — pēc specifikācijas: atrodiet savam uzdevumam piemērotās metodes un pieslēdziet savu sistēmu.

Ja jautājums nav par izstrādi, bet gan par viesnīcas iestatīšanu — sāciet no atbalsta lapas.

Skatiet arī

• Atbalsts un kontakti — kur un kā rakstīt komandai: caur atbalstu sākas arī piekļuve API.
• Viesnīcu terminu vārdnīca — viesnīcu terminu skaidrojumi, kas datos satiksies: rezervējums, pieejamība, tarifs, reģistrēšanās.