API dokumentácia

AI infraštruktúra
poháňajúca moderné hospitality platformy

Read-only dátové API a deep-link na aktiváciu partnera na integráciu AI agentov Host Logic do vášho PMS alebo property management platformy. Táto stránka dokumentuje iba to, čo je dnes dostupné — jasne označená sekcia Roadmap pokrýva to, čo príde ďalej.

Tri kroky k spusteniu

Získajte API kľúč → sledujte využitie miest a cenové signály → vložte aktivačný odkaz hosta do svojho UI. Toto je celý integračný proces dostupný dnes.

Step 1 Získajte svoj API kľúč

Staňte sa partnerom. Po schválení Host Logic vytvorí váš partnerský účet a pošle vám jednorazový odkaz na zobrazenie, ktorý obsahuje váš API kľúč hlk_. Uložte ho bezpečne — po zobrazení sa už nedá znova zobraziť.

Step 2 Čítajte využitie & cenové signály

Volajte GET /partner-api/v1/usage na sledovanie spotreby miest a GET /partner-api/v1/properties/{id}/pricing-signals na zobrazenie cenových údajov Marcus vo vašej platforme.

Step 3 Vložte aktivačný odkaz

Pridajte do svojho UI tlačidlo, ktoré otvorí HMAC podpísaný deep-link https://hostlogic.io/partner/{slug}/activate?token=…. Host si vyberie produkty, jeho účet Host Logic sa zriadi a Laura je pripravená.

GET /partner-api/v1/usage Overte, že váš kľúč funguje
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — kľúč je platný, odpoveď obsahuje využitie vašich miest
# 401 Unauthorized — kľúč chýba alebo je neplatný
# 403 Forbidden — kľúč je platný, ale chýba požadovaný scope
# 429 Too Many Requests — limit požiadaviek (120 req/min)

Autentifikácia API kľúčom

Všetky API požiadavky vyžadujú Bearer token v hlavičke Authorization. API kľúč dostanete po schválení partnerstva cez jednorazový odkaz na zobrazenie — samotný kľúč sa na serveri neukladá a nedá sa znova zobraziť.

API kľúče majú prefix hlk_, sú viazané na váš partnerský účet a možno ich rotovať bez výpadku. Každý kľúč obsahuje sadu scopeov, ktoré určujú, na ktoré endpointy sa môže volať. Prvých 12 znakov každého kľúča (prefix kľúča) sa ukladá v otvorenom texte na identifikáciu v logoch — zvyšok je hashovaný.

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

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

Limit požiadaviek

120 požiadaviek za minútu na API kľúč. Pri prekročení sa vráti 429 Too Many Requests.

Scopy

metrics:read — vždy udelený; pokrýva endpoint využitia.
marcus:read — udelený, keď vaša partnerská zmluva zahŕňa údaje Marcus (Revenue Manager); pokrýva endpointy properties a pricing-signals.

Chybové kódy

KódVýznam
401Chýbajúci alebo neplatný API kľúč
403Kľúč je platný, ale chýba požadovaný scope pre tento endpoint
404Zdroj sa nenašiel alebo nie je vo vlastníctve vášho partnerského účtu
429Prekročený limit požiadaviek — 120 pož./min
Každá požiadavka — preferovaný hlavičkový parameter
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Alternatívny hlavičkový parameter (pre pohodlie v CLI)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Živé endpointy a funkcie

Nasledujúce endpointy a integračné vzory sú dnes v produkcii. Všetko uvedené tu je reálne a volateľné s platným API kľúčom.

GET /usage

Využitie miest pre váš partnerský účet. Scope: metrics:read (vždy udelené). Pozrite si úplnú referenciu nižšie.

GET /properties

Zoznam nehnuteľností patriacich vašim sponzorovaným hostiteľom. Scope: marcus:read. Pozrite si úplnú referenciu nižšie.

GET /properties/{propertyId}/pricing-signals

Cenové signály Marcus a nadchádzajúca obsadenosť pre sponzorovanú nehnuteľnosť. Scope: marcus:read. Pozrite si úplnú referenciu nižšie.

LINK Deep-link na aktiváciu partnera

URL podpísaná HMAC, ktorá zriadi účet sponzorovaného hostiteľa. Vložená vo vašom rozhraní ako tlačidlo. Pozrite si úplnú referenciu nižšie.

GET /usage — Využitie miest

Vracia počet aktívnych miest autentifikovaného partnera s rozpisom podľa jednotlivých hostiteľov. Užitočné na zosúladenie fakturácie alebo na vytvorenie dashboardu využitia vo vašej platforme.

Požadovaný scope

metrics:read — vždy udelené všetkým partnerským kľúčom.

Ochrana proti IDOR

Tento endpoint vracia údaje iba pre autentifikovaného partnera. Nikdy neprijíma query parameter partner_id — identita pochádza výhradne z vášho API kľúča.

Minimalizácia PII

Rozpis používa nepriehľadné ID používateľov hostiteľov a počty miest. E-maily hostiteľov sú zámerne vynechané.

Požiadavka
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Odpoveď
{
  "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 — Zoznam sponzorovaných nehnuteľností

Vracia všetky nehnuteľnosti patriace hostiteľom, ktorých váš partnerský účet sponzoruje. Použite to na zistenie, pre ktoré nehnuteľnosti môžete dopytovať cenové signály.

Požadovaný scope

marcus:read — udelené, keď vaša partnerská zmluva zahŕňa dátovú vrstvu Marcus Revenue Manager.

Vracané údaje

Každá položka obsahuje interné id nehnuteľnosti (potrebné pre endpoint pricing-signals) a name nehnuteľnosti. PII hostiteľa nad rámec názvu nehnuteľnosti je vylúčené.

Požiadavka
curl https://api.hostlogic.io/partner-api/v1/properties \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Odpoveď
{
  "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

Vracia cenové signály Marcus a nadchádzajúcu obsadenosť pre jednu sponzorovanú nehnuteľnosť. Použite hodnoty id nehnuteľností vrátené z GET /properties. Ak sa nehnuteľnosť nenájde alebo nie je vo vlastníctve vášho partnerského účtu, vráti sa 404.

Požadovaný scope

marcus:read

Query parameter

lookback_days (celé číslo, predvolene 90) — okno histórie rezervácií použité na výpočet signálov.

Poznámka k štruktúre odpovede

Objekt signals obsahuje cenové indikátory a štatistiky rezervácií. Presná sada polí sa môže vyvíjať, keď Marcus pridáva nové zdroje dát. Ukážkový príklad nižšie zobrazuje polia dostupné pri spustení — všetky nerozpoznané polia považujte za doplnkové.

Požiadavka
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ážková odpoveď (polia sa môžu meniť)
{
  "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
  }
}

Čoskoro k dispozícii

Nasledujúce funkcie sú plánované alebo vo vývoji. Uvádzame ich tu pre transparentnosť, aby ste si mohli naplánovať integračnú roadmapu. Žiadna z nich dnes nie je dostupná na volanie — ak by ste na nich teraz stavali, skončí to chybami.

ROADMAP Samoobslužné generovanie tokenov pre partnerov

API endpoint alebo stiahnuteľný SDK snippet, ktorý umožní vášmu backendu generovať podpísané aktivačné tokeny bez zapojenia Host Logic. Dnes sa tokeny generujú na požiadanie cez administrátorský nástroj.

ROADMAP Write scopes & mutujúce endpointy

Scopes ako marcus:write a pierre:write a REST endpointy na registráciu objektov (POST /properties), aktiváciu alebo deaktiváciu jednotlivých jednotiek a aktualizáciu partnerských nastavení.

ROADMAP Webhooky / udalosti v reálnom čase

Push notifikácie pre dokončený onboarding, aktiváciu/deaktiváciu jednotiek a prahové hodnoty používania. Zaregistrujte webhook URL a prijímajte podpísané payloady.

ROADMAP Samoobslužný partnerský portál

Samoobslužný portál chránený príznakom, určený na správu API kľúčov, prehľad využitia miest a konfiguráciu povolených embed originov. Momentálne v súkromnej bete.

PRIVATE BETA Údržbový endpoint pre Pierre

GET /properties/{propertyId}/operational-state — stav údržby a prevádzkový stav pre sponzorovaný objekt. Je vytvorený, ale vypnutý cez feature flag; vyžaduje scope pierre:read. Dostupný vybraným partnerom na požiadanie.

ROADMAP Vloženie onboarding iframe

Vložte konfiguračný sprievodca Laura ako iframe do rozhrania vášho PMS, s udalosťami postMessage pre priebeh krokov a dokončenie. Závisí od spustenia partnerského self-service portálu.

ROADMAP Hostovaný MCP server pre enterprise

Hostovaný MCP endpoint na mcp.hostlogic.io poskytujúci prístup k nástrojom Claude Desktop / Cursor nad dátami v rozsahu partnera. Architektúra je naplánovaná; pre enterprise partnerov zatiaľ nie je v prevádzke.

Chcete skorý prístup alebo prispieť k prioritám roadmapy?

Enterprise partneri majú vyhradený Slack kanál s tímom Host Logic. Ozvite sa na [email protected] a preberieme vaše integračné požiadavky a časový plán.

Chcete priniesť agentov Host Logic na vašu platformu?

Povedzte nám o vašom PMS, channel manageri alebo produkte pre hospitality softvér. Žiadosti partnerov posudzujeme do 2 pracovných dní a poskytneme vám API kľúč aj vyhradený podporný kanál.

Vrátane sandbox prostredia
Podpora integrácie do 24 hodín
Vyhradený Slack kanál