Přeskočit na obsah
Čeština

API pro vývojáře

PročDát vývojáři hotelu nebo integrátorovi výchozí bod: co je to za API, kde je jeho specifikace a jak je postavený přístup.
Pro kohoVývojáři, který k HotelsCalendar připojuje vlastní systém; majiteli – aby měl co ukázat dodavateli.
Co získátePochopení plochy API – jaká data jde přes něj dostat – a procesu získání přístupu: token a základní URL.
OmezeníToto je výchozí bod, ne přehled metod: úplný seznam je ve specifikaci; technické limity se nepublikují.

HotelsCalendar má API: tytéž rezervace, dostupnost a hosté, se kterými pracujete v rozhraní, – programově. Tato stránka je výchozí bod: co je to za rozhraní, kde je jeho specifikace a jak získat přístup. Příkladů s kódem tady není – nahrazuje je specifikace.

Co je API HotelsCalendar

Sekce “Co je API HotelsCalendar”

API je programové rozhraní nad produktem. Odevzdává a přijímá tytéž data jako rozhraní PMS: rezervace, dostupnost, hosty. Rozhraní je pro lidi, API pro programy: vlastní účetní systém, skript nebo tabulka čte a mění data hotelu bez ručního přenášení.

Data v API mluví týmtéž jazykem jako články tohoto průvodce: rezervace se stavy a hosty, dostupnost po datech, údaje hostů. Proto se před napojením vyplácí pochopit, jak produkt tyto entity popisuje, – tím jakákoli integrace začíná.

Úplný popis API je OpenAPI specifikace, soubor openapi.yaml: vyjmenovává všechny metody – co každá přijímá a vrací – i datové modely. Specifikace je seřazená zhruba do 24 tematických sekcí.

Otevře se a stáhne přes základní URL API – adresu, která se vydává spolu s přístupem. Je to zdroj pravdy o možnostech: všechno, co popisuje, API umí; co v ní není, API neslibuje.

Přístup k API je přes token: osobní klíč, který se předává s každým požadavkem. Z tokenu API pozná, od kterého objektu požadavek jde, a co je tomuto přístupu dovoleno.

Token a základní URL přicházejí spolu – při napojování (jak ho zařídit – níže). Zacházejte s tokenem jako s heslem: otevírá data objektu, proto se ukládá na vaší straně a nepublikuje se.

  • Vlastní analytika. Rezervace se vyexportují do vašeho BI systému nebo tabulky – a počítají se tam, jak potřebujete, bez ručního exportu každý měsíc.
  • Synchronizace s vnitřními systémy. Účetní program nebo servis hotelu dostává rezervace a změny z PMS – a data se mezi systémy nerozejdou.
  • Mini-služby a widgety. Malý nástroj nad daty hotelu – vnitřní stránka pro personál, souhrn pro správce, – který bere data z PMS přímo.

Pro všechny tři scénáře je cesta jedna: získat token, najít potřebné metody ve specifikaci, napojit vlastní systém.

  • Technické limity API – frekvence požadavků, rozsahy exportů – se v tomto článku nepublikují.
  • Seznam možností je jen specifikace: metody a modely popisuje openapi.yaml, článek nic nad rámec neslibuje.
  • Jak se API v čase mění – kompatibilita verzí, pořad upozornění na změny, – tato stránka neslibuje: podmínky se probírají při napojování.
  • Příkladů krok za krokem s kódem tady také není – jejich roli plní specifikace.
  1. Napište nám přes stránku „Kontakty“ na webu HotelsCalendar: popište úkol – jaký systém se napojuje a jaká data potřebuje.
  2. Pošleme vám token a základní URL API.
  3. Dál – podle specifikace: najděte metody pro svůj úkol a napojte vlastní systém.

Není-li dotaz o vývoji, ale o nastavení hotelu – začněte stránkou podpory.

  • Podpora a kontakty – kam a jak psát týmu: přístup k API začíná také tam.
  • Slovník pojmů – vysvětlení hotelových pojmů, které se objeví v datech: rezervace, dostupnost, cena, check-in.