Dokumentace API

AI infrastruktura
pohánějící moderní hotelové platformy

API pro čtení dat a deep-link pro aktivaci partnera pro integraci AI agentů Host Logic do vašeho PMS nebo platformy pro správu nemovitostí. Tato stránka dokumentuje pouze to, co je dnes aktivní — jasně označená sekce Roadmap popisuje, co přijde dál.

Tři kroky k nasazení do provozu

Získejte API klíč → načtěte využití licencí a cenové signály → vložte aktivační odkaz hosta do svého UI. To je celý integrační cyklus dostupný dnes.

Step 1 Získejte svůj API klíč

Staňte se partnerem. Po schválení Host Logic vytvoří váš partnerský účet a pošle vám jednorázový odkaz pro zobrazení, který obsahuje váš API klíč hlk_. Uložte jej bezpečně — po zobrazení už jej nelze znovu zobrazit.

Step 2 Načtěte využití & cenové signály

Voláním GET /partner-api/v1/usage sledujte čerpání licencí a pomocí GET /partner-api/v1/properties/{id}/pricing-signals zobrazte cenová data Marcus ve své platformě.

Step 3 Vložte aktivační odkaz

Přidejte do svého UI tlačítko, které otevře HMAC podepsaný deep-link https://hostlogic.io/partner/{slug}/activate?token=…. Host vybere produkty, jeho účet Host Logic bude zřízen a Laura je připravena.

GET /partner-api/v1/usage Ověřte, že váš klíč funguje
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — klíč je platný, odpověď obsahuje využití vašich licencí
# 401 Unauthorized — klíč chybí nebo je neplatný
# 403 Forbidden — klíč je platný, ale chybí požadovaný scope
# 429 Too Many Requests — limit požadavků (120 req/min)

Autentizace pomocí API klíče

Všechny požadavky API vyžadují Bearer token v hlavičce Authorization. API klíč obdržíte po schválení partnerství prostřednictvím jednorázového odkazu pro zobrazení — samotný klíč se na serveru neukládá a nelze jej znovu zobrazit.

API klíče mají prefix hlk_, jsou přiřazené k vašemu partnerskému účtu a lze je rotovat bez výpadku. Každý klíč má sadu scope, které určují, na které endpointy může volat. Prvních 12 znaků každého klíče (prefix klíče) se ukládá v prostém textu pro identifikaci v logách — zbytek je hashovaný.

Základní URL https://api.hostlogic.io/partner-api/v1

Sandbox / DEV:
https://api-dev.hostlogic.io/partner-api/v1

Rate limit

120 požadavků/minutu na API klíč. Při překročení se vrací 429 Too Many Requests.

Scopy

metrics:read — vždy udělen; pokrývá endpoint pro využití.
marcus:read — udělen, pokud vaše partnerská smlouva zahrnuje data Marcus (Revenue Manager); pokrývá endpointy properties a pricing-signals.

Chybové kódy

KódVýznam
401Chybějící nebo neplatný API klíč
403Klíč je platný, ale pro tento endpoint chybí požadovaný scope
404Zdroj nebyl nalezen nebo nepatří vašemu partnerskému účtu
429Překročen limit požadavků — 120 req/min
Každý požadavek — preferovaný header
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Alternativní header (pro pohodlí v CLI)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Živé endpointy a funkce

Následující endpointy a integrační vzory jsou dnes v produkci. Vše uvedené zde je skutečné a lze to volat s platným API klíčem.

GET /usage

Využití míst pro váš partnerský účet. Scope: metrics:read (vždy uděleno). Viz úplná reference níže.

GET /properties

Seznam nemovitostí patřících hostitelům, které sponzorujete. Scope: marcus:read. Viz úplná reference níže.

GET /properties/{propertyId}/pricing-signals

Cenové signály Marcus a nadcházející obsazenost pro sponzorovanou nemovitost. Scope: marcus:read. Viz úplná reference níže.

LINK Deep link pro aktivaci partnera

URL podepsaná HMAC, která založí účet sponzorovaného hostitele. Vložená do vašeho rozhraní jako tlačítko. Viz úplná reference níže.

GET /usage — Využití míst

Vrací počet aktivních míst ověřeného partnera s rozpisem podle jednotlivých hostitelů. Užitečné pro párování fakturace nebo pro vytvoření dashboardu využití ve vaší platformě.

Požadovaný scope

metrics:read — vždy udělen všem partnerským klíčům.

Ochrana proti IDOR

Tento endpoint vrací data pouze pro ověřeného partnera. Nikdy nepřijímá parametr dotazu partner_id — identita vychází výhradně z vašeho API klíče.

Minimalizace PII

Rozpis používá neprůhledná ID uživatelů hostitelů a počty míst. E-maily hostitelů jsou záměrně vynechány.

Požadavek
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Odpověď
{
  "partner_id": 1,
  "generated_at": "2026-06-01T10:30:00Z",
  "active_seats": 7,
  "hosts": [
    { "host_user_id": 42, "active_seats": 4 },
    { "host_user_id": 67, "active_seats": 3 }
  ]
}

GET /properties — Seznam sponzorovaných nemovitostí

Vrací všechny nemovitosti patřící hostitelům, které váš partnerský účet sponzoruje. Použijte to ke zjištění, pro které nemovitosti můžete dotazovat cenové signály.

Požadovaný scope

marcus:read — udělen, pokud vaše partnerská smlouva zahrnuje datovou vrstvu Marcus Revenue Manageru.

Vrácená data

Každá položka obsahuje interní id nemovitosti (potřebné pro endpoint pricing-signals) a name nemovitosti. PII hostitele nad rámec názvu nemovitosti je vynecháno.

Požadavek
curl https://api.hostlogic.io/partner-api/v1/properties \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Odpověď
{
  "partner_id": 1,
  "generated_at": "2026-06-01T10:30:00Z",
  "properties": [
    { "id": 12, "name": "Harbour View Apartment" },
    { "id": 17, "name": "Old Town Studio" }
  ]
}

GET /properties/{propertyId}/pricing-signals

Vrací cenové signály Marcus a nadcházející obsazenost pro jednu sponzorovanou nemovitost. Použijte hodnoty id nemovitostí vrácené z GET /properties. Pokud nemovitost nebyla nalezena nebo není vlastněna vaším partnerským účtem, vrací se 404.

Požadovaný scope

marcus:read

Parametr dotazu

lookback_days (integer, výchozí 90) — okno historie rezervací použité pro výpočet signálů.

Poznámka ke struktuře odpovědi

Objekt signals obsahuje cenové indikátory a statistiky rezervací. Přesná sada polí se může vyvíjet, jak Marcus přidává nové zdroje dat. Ukázka níže zobrazuje pole dostupná při spuštění — jakákoli nerozpoznaná pole považujte za doplňková.

Požadavek
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Ukázková odpověď (pole se mohou vyvíjet)
{
  "property_id": 12,
  "signals": {
    "occupancy_today": 0.75,
    "avg_lead_time_days": 18.4,
    "avg_stay_nights": 3.2,
    "source_mix": {
      "booking.com": 0.62,
      "direct": 0.38
    },
    "total_reservations": 87
  },
  "occupancy_30d": {
    "2026-06-01": 0.75,
    "2026-06-02": 0.80
  }
}

Již brzy

Následující funkce jsou plánované nebo ve vývoji. Uvádíme je zde pro transparentnost, abyste si mohli naplánovat integrační roadmapu. Žádná z nich dnes není k dispozici k volání — pokud na ně budete stavět už teď, dojde k chybám.

ROADMAP Samoobslužné generování tokenů partnerem

API endpoint nebo stažitelný SDK snippet, který umožní vašemu backendu generovat podepsané aktivační tokeny bez zapojení Host Logic. Dnes jsou tokeny generovány na vyžádání přes administrátorský nástroj.

ROADMAP Write scopes & mutující endpointy

Scopes jako marcus:write a pierre:write a REST endpointy pro registraci objektů (POST /properties), aktivaci nebo deaktivaci jednotlivých jednotek a aktualizaci nastavení partnera.

ROADMAP Webhooky / události v reálném čase

Push notifikace pro dokončený onboarding, aktivaci/deaktivaci jednotky a prahové hodnoty využití. Zaregistrujte webhook URL a přijímejte podepsané payloady.

ROADMAP Samoobslužný partnerský portál

Samoobslužný portál řízený feature flagem pro správu API klíčů, zobrazení využití seatů a konfiguraci povolených embed originů. Aktuálně v privátní betě.

PRIVATE BETA Údržbový endpoint Pierre

GET /properties/{propertyId}/operational-state — stav údržby a provozní stav pro sponzorovaný objekt. Funkčně připraveno, ale vypnuto pomocí feature flagu; vyžaduje scope pierre:read. K dispozici vybraným partnerům na vyžádání.

ROADMAP Vložení onboardingového iframe

Vložte průvodce konfigurací Laura jako iframe do rozhraní vašeho PMS, s událostmi postMessage pro průběh kroků a dokončení. Závisí na spuštění partnerského self-service portálu.

ROADMAP Hostovaný MCP server pro enterprise

Hostovaný MCP endpoint na mcp.hostlogic.io poskytující přístup k nástrojům Claude Desktop / Cursor nad daty v rámci partnera. Architektura je plánovaná; pro enterprise partnery zatím není v provozu.

Chcete včasný přístup nebo možnost ovlivnit priority roadmapy?

Enterprise partneři mají vyhrazený Slack kanál s týmem Host Logic. Ozvěte se na [email protected] a probereme vaše integrační požadavky i časový plán.

Chcete přivést agenty Host Logic na svou platformu?

Povězte nám o svém PMS, channel manageru nebo produktu pro hospitality software. Žádosti partnerů vyhodnocujeme do 2 pracovních dnů a poskytneme vám API klíč i vyhrazený kanál podpory.

Sandbox prostředí v ceně
Podpora integrace do 24 hodin
Vyhrazený Slack kanál