Dokumentacija API-ja

Infrastruktura AI
ki poganja sodobne platforme za gostinstvo

API za podatke samo za branje in aktivacijska globoka povezava za partnerje za integracijo agentov AI Host Logic v vaš PMS ali platformo za upravljanje nepremičnin. Ta stran dokumentira samo to, kar je danes v živo — jasno označen razdelek Roadmap zajema, kaj prihaja naslednje.

Trije koraki do zagona

Pridobite svoj API ključ → preberite uporabo sedežev in cenovne signale → v svoj vmesnik vgradite aktivacijsko povezavo za gostitelja. To je celoten integracijski tok, ki je na voljo danes.

Step 1 Pridobite svoj API ključ

Postanite partner. Ko bo vaša prijava odobrena, Host Logic ustvari vaš partnerski račun in vam pošlje enkratno povezavo za razkritje, ki vsebuje vaš API ključ hlk_. Shranite ga varno — po razkritju ga ni mogoče znova prikazati.

Step 2 Preberite uporabo & cenovne signale

Pokličite GET /partner-api/v1/usage za spremljanje porabe sedežev in GET /partner-api/v1/properties/{id}/pricing-signals za prikaz podatkov o cenah Marcus v vaši platformi.

Step 3 Vgradite aktivacijsko povezavo

V svoj vmesnik dodajte gumb, ki odpre z HMAC podpisano globoko povezavo https://hostlogic.io/partner/{slug}/activate?token=…. Gostitelj izbere produkte, njegov račun Host Logic je vzpostavljen, Laura pa je pripravljena.

GET /partner-api/v1/usage Preverite, ali vaš ključ deluje
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — ključ je veljaven, odgovor vsebuje vašo uporabo sedežev
# 401 Unauthorized — ključ manjka ali je neveljaven
# 403 Forbidden — ključ je veljaven, vendar manjka zahtevani obseg
# 429 Too Many Requests — omejitev hitrosti (120 zahtev/min)

Avtentikacija z API ključem

Vse zahteve API-ja zahtevajo Bearer žeton v glavi Authorization. API ključ prejmete po odobritvi partnerstva prek enkratne povezave za razkritje — goli ključ ni nikoli shranjen na strežniku in ga ni mogoče ponovno prikazati.

API ključi imajo predpono hlk_, so vezani na vaš partnerski račun in jih je mogoče zamenjati brez izpada. Vsak ključ ima nabor obsegov, ki določajo, katere končne točke lahko kliče. Prvih 12 znakov vsakega ključa (predpona ključa) je shranjenih v navadnem besedilu za identifikacijo v dnevnikih — ostalo je zgoščeno.

Osnovni URL-ji https://api.hostlogic.io/partner-api/v1

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

Omejitev hitrosti

120 zahtev/minuto na API ključ. Ob preseganju se vrne 429 Too Many Requests.

Obsegi

metrics:read — vedno dodeljen; zajema končno točko za uporabo.
marcus:read — dodeljen, ko vaša partnerska pogodba vključuje podatke Marcus (Revenue Manager); zajema končni točki properties in pricing-signals.

Kode napak

KodaPomen
401Manjkajoč ali neveljaven API ključ
403Ključ je veljaven, vendar za to končno točko manjka zahtevani obseg
404Vir ne najden ali pa ni v lasti vašega partnerskega računa
429Presežena omejitev hitrosti — 120 zahtevkov/min
Pri vsaki zahtevi — priporočena glava
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Alternativna glava (za udobje v CLI)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Živi končni točki in funkcionalnosti

Naslednje končne točke in integracijski vzorci so danes že v produkciji. Vse, kar je navedeno tukaj, je resnično in ga je mogoče poklicati z veljavnim API ključem.

GET /usage

Poraba sedežev za vaš partnerski račun. Obseg: metrics:read (vedno dodeljeno). Glejte celotno referenco spodaj.

GET /properties

Seznam nepremičnin, ki pripadajo vašim sponzoriranim gostiteljem. Obseg: marcus:read. Glejte celotno referenco spodaj.

GET /properties/{propertyId}/pricing-signals

Marcusovi cenovni signali in prihajajoča zasedenost za sponzorirano nepremičnino. Obseg: marcus:read. Glejte celotno referenco spodaj.

LINK Globoka povezava za aktivacijo partnerja

URL, podpisan z HMAC, ki omogoči račun sponzoriranega gostitelja. V vaš uporabniški vmesnik je vdelan kot gumb. Glejte celotno referenco spodaj.

GET /usage — Poraba sedežev

Vrne število aktivnih sedežev overjenega partnerja z razčlenitvijo po posameznih gostiteljih. Uporabno za usklajevanje obračunavanja ali za izdelavo nadzorne plošče porabe v vaši platformi.

Zahtevan obseg

metrics:read — vedno dodeljeno vsem partnerskim ključem.

Zaščita pred IDOR

Ta končna točka vrne podatke samo za overjenega partnerja. Nikoli ne sprejme poizvedbenega parametra partner_id — identiteta izhaja izključno iz vašega API ključa.

Minimizacija osebnih podatkov

Razčlenitev uporablja neprosojne ID-je uporabnikov gostiteljev in število sedežev. E-poštni naslovi gostiteljev so namerno izključeni.

Zahteva
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Odgovor
{
  "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 sponzoriranih nepremičnin

Vrne vse nepremičnine, ki pripadajo gostiteljem, ki jih sponzorira vaš partnerski račun. Uporabite to za ugotavljanje, za katere nepremičnine lahko poizvedujete po cenovnih signalih.

Zahtevan obseg

marcus:read — dodeljeno, kadar vaša partnerska pogodba vključuje podatkovno plast Marcus Revenue Managerja.

Vrnjeni podatki

Vsak vnos vsebuje notranji ID nepremičnine id (potreben za končno točko pricing-signals) in ime nepremičnine name. Osebni podatki gostitelja, ki presegajo ime nepremičnine, so izključeni.

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

Vrne Marcusove cenovne signale in prihajajočo zasedenost za eno sponzorirano nepremičnino. Uporabite vrednosti ID-ja nepremičnine id, vrnjene z GET /properties. Če nepremičnina ni najdena ali ni v lasti vašega partnerskega računa, se vrne 404.

Zahtevan obseg

marcus:read

Poizvedbeni parameter

lookback_days (celo število, privzeto 90) — časovno okno zgodovine rezervacij, uporabljeno za izračun signalov.

Opomba o obliki odgovora

Objekt signals vsebuje cenovne kazalnike in statistiko rezervacij. Natančen nabor polj se lahko razvija, ko Marcus dodaja nove podatkovne vire. Spodnji reprezentativni primer prikazuje polja, ki so na voljo ob zagonu — vsa neprepoznana polja obravnavajte kot dodatna.

Zahteva
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Predstavitveni odgovor (polja se lahko razvijajo)
{
  "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
  }
}

Kmalu na voljo

Naslednje zmožnosti so načrtovane ali v razvoju. Tukaj so navedene zaradi preglednosti, da lahko načrtujete svojo integracijsko pot. Nobene od njih danes ni mogoče klicati — razvoj proti njim zdaj bo povzročil napake.

ROADMAP Samostojno generiranje žetonov s strani partnerja

Končna točka API-ja ali prenesljiv izrezek SDK-ja, ki vašemu zaledju omogoča generiranje podpisanih aktivacijskih žetonov brez vključevanja Host Logic. Danes se žetoni generirajo na zahtevo prek skrbniškega orodja.

ROADMAP Obsegi za zapisovanje & končne točke za spreminjanje

Obsegi, kot sta marcus:write in pierre:write, ter REST končne točke za registracijo nepremičnin (POST /properties), aktivacijo ali deaktivacijo posameznih enot in posodobitev partnerskih nastavitev.

ROADMAP Webhooki / dogodki v realnem času

Potisna obvestila za dokončano uvajanje, aktivirano/deaktivirano enoto in pragove uporabe. Registrirajte URL webhooka in prejemajte podpisane podatkovne pakete.

ROADMAP Partnerski portal za samostojno upravljanje

Portal za samostojno upravljanje, zaščiten z zastavico, za upravljanje API ključev, ogled porabe sedežev in konfiguracijo dovoljenih izvorov za vdelavo. Trenutno v zasebni beta različici.

PRIVATE BETA Vzdrževalna končna točka za Pierre

GET /properties/{propertyId}/operational-state — vzdrževalno in operativno stanje za sponzorirano nepremičnino. Funkcionalnost je pripravljena, vendar onemogočena z zastavico funkcije; zahteva obseg pierre:read. Na voljo izbranim partnerjem na zahtevo.

ROADMAP Vdelava onboarding vmesnika prek iframe

Čarovnika za konfiguracijo Laura vdelajte kot iframe v svoj PMS vmesnik, z dogodki postMessage za napredovanje po korakih in dokončanje. Odvisno od zagona partnerskega samopostrežnega portala.

ROADMAP Gostujoči MCP strežnik za podjetja

Gostujoča končna točka MCP na mcp.hostlogic.io, ki omogoča dostop do orodij Claude Desktop / Cursor za podatke, vezane na partnerja. Arhitektura je načrtovana; za podjetniške partnerje še ni v živo.

Želite zgodnji dostop ali vplivati na prioritete na načrtu razvoja?

Podjetniški partnerji imajo namenski Slack kanal s ekipo Host Logic. Pišite nam na [email protected], da se pogovorimo o vaših integracijskih zahtevah in časovnici.

Želite pripeljati agente Host Logic na svojo platformo?

Povejte nam več o svojem PMS, channel managerju ali programski opremi za gostinstvo. Vloge partnerjev pregledamo v 2 delovnih dneh ter vam zagotovimo API ključ in namenski kanal za podporo.

Vključen testni okoljski sistem
Podpora za integracijo v 24 urah
Namenski Slack kanal