API dokumentatsioon

AI taristu
mis toidab kaasaegseid hotellindusplatvorme

Ainult lugemiseks mõeldud andme-API ja partneri aktiveerimise süvalink Host Logicu AI-agentide integreerimiseks teie PMS-i või kinnisvarahaldusplatvormi. See leht dokumenteerib ainult seda, mis on täna live'is — selgelt märgistatud Roadmapi jaotis käsitleb seda, mis tuleb järgmisena.

Kolm sammu käivitamiseni

Saage oma API-võti → lugege istekohtade kasutust ja hinnasignaale → lisage hosti aktiveerimislink oma kasutajaliidesesse. See on täielik integratsioonivoog, mis on täna saadaval.

Step 1 Saage oma API-võti

Saage partneriks. Pärast heakskiitu loob Host Logic teie partnerikonto ja saadab teile ühekordse avalikustamislingi, mis sisaldab teie hlk_ API-võtit. Hoidke see turvaliselt — pärast avalikustamist ei saa seda enam uuesti kuvada.

Step 2 Lugege kasutust & hinnasignaale

Kutsuge GET /partner-api/v1/usage, et jälgida istekohtade tarbimist, ja GET /partner-api/v1/properties/{id}/pricing-signals, et kuvada Marcuse hinnainfo oma platvormis.

Step 3 Lisage aktiveerimislink

Lisage oma kasutajaliidesesse nupp, mis avab HMAC-iga allkirjastatud süvalingi https://hostlogic.io/partner/{slug}/activate?token=…. Hosti valib tooted, tema Host Logicu konto seadistatakse ning Laura on valmis.

GET /partner-api/v1/usage Kontrollige, et teie võti töötab
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — võti on kehtiv, vastus sisaldab teie istekohtade kasutust
# 401 Unauthorized — võti puudub või on kehtetu
# 403 Forbidden — võti on kehtiv, kuid vajalik ulatus puudub
# 429 Too Many Requests — kiirusepiirang (120 päringut/min)

API-võtmega autentimine

Kõik API-päringud nõuavad Bearer-tokenit Authorization päises. Te saate oma API-võtme pärast partneri heakskiitu ühekordse avalikustamislingi kaudu — lihtvõtit ei salvestata kunagi serveripoolselt ja seda ei saa uuesti kuvada.

API-võtmete eesliide on hlk_, need on seotud teie partnerikontoga ja neid saab seisakuta roteerida. Iga võti sisaldab õiguste kogumit, mis määrab, milliseid lõpp-punkte see võib kasutada. Iga võtme esimesed 12 märki (võtme eesliide) salvestatakse logides tuvastamiseks lihttekstina — ülejäänu on räsitud.

Baas-URL-id https://api.hostlogic.io/partner-api/v1

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

Kiirusepiirang

120 päringut minutis API-võtme kohta. Piiri ületamisel tagastatakse 429 Too Many Requests.

Õigused

metrics:read — antakse alati; katab kasutuse lõpp-punkti.
marcus:read — antakse siis, kui teie partnerleping sisaldab Marcuse (Revenue Manager) andmeid; katab properties- ja pricing-signals-lõpp-punktid.

Veakoodid

KoodTähendus
401API-võti puudub või on kehtetu
403Võti on kehtiv, kuid selle lõpp-punkti jaoks vajalik õigus puudub
404Ressurssi ei leitud või see ei kuulu teie partnerikontole
429Päringute limiit ületatud — 120 päringut/min
Iga päring — eelistatud päis
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Alternatiivne päis (CLI mugavuseks)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Reaalajas lõpp-punktid ja funktsioonid

Järgmised lõpp-punktid ja integratsioonimustrid on täna tootmiskeskkonnas kasutusel. Kõik siin loetletu on päriselt olemas ja kehtiva API-võtmega kasutatav.

GET /usage

Teie partnerikonto istekohtade kasutus. Ulatus: metrics:read (alati antud). Vaadake täielikku viidet allpool.

GET /properties

Loetleb teie sponsoreeritud hostidele kuuluvad majutusasutused. Ulatus: marcus:read. Vaadake täielikku viidet allpool.

GET /properties/{propertyId}/pricing-signals

Marcus'e hinnasignaalid ja eelseisev täituvus sponsoreeritud majutusasutuse jaoks. Ulatus: marcus:read. Vaadake täielikku viidet allpool.

LINK Partneri aktiveerimise süvalink

HMAC-iga allkirjastatud URL, mis loob sponsoreeritud hostikonto. Lisatakse teie kasutajaliidesesse nupuna. Vaadake täielikku viidet allpool.

GET /usage — istekohtade kasutus

Tagastab autentitud partneri aktiivsete istekohtade arvu koos jaotusega hostide lõikes. Kasulik arvelduse kooskõlastamiseks või kasutuse juhtpaneeli loomiseks teie platvormis.

Nõutav ulatus

metrics:read — antakse alati kõigile partnerivõtmetele.

IDOR-kaitse

See lõpp-punkt tagastab andmeid ainult autentitud partneri kohta. See ei aktsepteeri kunagi partner_id päringuparameetrit — identiteet tuleb täielikult teie API-võtmest.

PII minimeerimine

Jaotuses kasutatakse anonüümseid hosti kasutaja ID-sid ja istekohtade arvu. Hosti e-posti aadressid on tahtlikult välja jäetud.

Päring
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Vastus
{
  "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 — sponsoreeritud majutusasutuste loend

Tagastab kõik majutusasutused, mis kuuluvad hostidele, keda teie partnerikonto sponsoreerib. Kasutage seda, et leida, milliste majutusasutuste kohta saate hinnasignaale küsida.

Nõutav ulatus

marcus:read — antakse, kui teie partnerleping sisaldab Marcus Revenue Manageri andmeplatvormi.

Tagastatavad andmed

Iga kirje sisaldab majutusasutuse sisemist id-d (vajalik pricing-signals lõpp-punkti jaoks) ja majutusasutuse name-i. Hosti PII, mis jääb väljapoole majutusasutuse nime, jäetakse välja.

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

Tagastab Marcus'e hinnasignaalid ja eelseisva täituvuse ühe sponsoreeritud majutusasutuse kohta. Kasutage GET /properties kaudu tagastatud majutusasutuse id väärtusi. Kui majutusasutust ei leita või see ei kuulu teie partnerikontole, tagastatakse 404.

Nõutav ulatus

marcus:read

Päringu parameeter

lookback_days (täisarv, vaikeväärtus 90) — broneerimisajaloo aken, mida kasutatakse signaalide arvutamiseks.

Märkus vastuse struktuuri kohta

signals-objekt sisaldab hinnanäitajaid ja broneerimisstatistikat. Täpne väljade komplekt võib Marcus'e uute andmeallikate lisandumisel muutuda. Allolev näidis näitab käivitamisel saadaolevaid välju — käsitlege kõiki tundmatuid välju lisanditena.

Päring
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Esinduslik vastus (väljad võivad muutuda)
{
  "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
  }
}

Peagi tulekul

Järgmised võimalused on planeeritud või arenduses. Need on siin läbipaistvuse huvides, et saaksite oma integratsioonitegevuskava planeerida. Ükski neist ei ole praegu kasutatav — nende vastu ehitamine põhjustab vigu.

ROADMAP Partneri iseteeninduslik tokenite loomine

API lõpp-punkt või allalaaditav SDK-koodilõik, mis võimaldab teie taustsüsteemil genereerida allkirjastatud aktiveerimistokeneid ilma Host Logicut kaasamata. Praegu genereeritakse tokenid soovi korral administraatori tööriista kaudu.

ROADMAP Kirjutamisõigused & muutvad lõpp-punktid

Õigused nagu marcus:write ja pierre:write ning REST-lõpp-punktid objektide registreerimiseks (POST /properties), üksikute üksuste aktiveerimiseks või deaktiveerimiseks ning partnerseadete uuendamiseks.

ROADMAP Veebikonksud / reaalajas sündmused

Push-teavitused onboarding'u lõpetamise, üksuse aktiveerimise/deaktiveerimise ja kasutuslävede kohta. Registreerige veebikonksu URL ja saate allkirjastatud andmepakette.

ROADMAP Partneri iseteenindusportaal

Lippudega juhitav iseteenindusportaal API-võtmete haldamiseks, istekohtade kasutuse vaatamiseks ja lubatud embed-lähteallikate seadistamiseks. Praegu privaatses beetaversioonis.

PRIVATE BETA Pierre’i hoolduslõpp-punkt

GET /properties/{propertyId}/operational-state — sponsoreeritud majutusobjekti hooldus- ja tööolek. Valmis, kuid funktsioonilipuga keelatud; nõuab pierre:read õigust. Saadaval valitud partneritele soovi korral.

ROADMAP Liidestamise iframe’i sisestus

Sisestage Laura seadistusviisard iframe’ina oma PMS-i kasutajaliidesesse, kasutades postMessage sündmusi etapi edenemise ja lõpetamise jaoks. Sõltub partneri iseteenindusportaali käivitamisest.

ROADMAP Majutatud MCP-server ettevõtetele

Majutatud MCP-lõpp-punkt aadressil mcp.hostlogic.io, mis pakub Claude Desktopi / Cursori tööriistade juurdepääsu partneri ulatuses andmetele. Arhitektuur on planeeritud; ettevõttepartneritele veel ei ole aktiivne.

Kas soovite varajast ligipääsu või panustada tegevuskava prioriteetidesse?

Ettevõttepartneritel on Host Logicu meeskonnaga eraldi Slacki kanal. Võtke ühendust aadressil [email protected], et arutada oma liidestusnõudeid ja ajakava.

Kas soovite tuua Host Logicu agendid oma platvormile?

Rääkige meile oma PMS-ist, kanalihaldurist või majutustarkvara tootest. Vaatame partneritaotlused läbi 2 tööpäeva jooksul ning anname teile API-võtme ja eraldi tugikanali.

Liivakastikeskkond kaasas
Integreerimistugi 24 tunni jooksul
Eraldi Slacki kanal