API dokumentācija

MI infrastruktūra
kas nodrošina mūsdienīgas viesmīlības platformas

Tikai lasāma datu API un partnera aktivizācijas dziļā saite Host Logic MI aģentu integrēšanai Jūsu PMS vai īpašumu pārvaldības platformā. Šajā lapā ir dokumentēts tikai tas, kas šodien ir aktīvs — skaidri marķēta ceļveža sadaļa aptver to, kas būs pieejams nākamajā posmā.

Trīs soļi, lai palaistu risinājumu

Saņemiet savu API atslēgu → nolasiet sēdvietu lietojumu un cenu signālus → ieguliet hosta aktivizācijas saiti savā lietotāja saskarnē. Tas ir pilnais integrācijas cikls, kas pieejams jau šodien.

Step 1 Saņemiet savu API atslēgu

Kļūstiet par partneri. Pēc apstiprināšanas Host Logic izveido Jūsu partnera kontu un nosūta vienreizēju atklāšanas saiti ar Jūsu hlk_ API atslēgu. Glabājiet to droši — pēc atklāšanas to vairs nevarēs parādīt atkārtoti.

Step 2 Nolasiet lietojumu un cenu signālus

Izsauciet GET /partner-api/v1/usage, lai uzraudzītu sēdvietu patēriņu, un GET /partner-api/v1/properties/{id}/pricing-signals, lai savā platformā attēlotu Marcus cenu datus.

Step 3 Ieguliet aktivizācijas saiti

Pievienojiet savā lietotāja saskarnē pogu, kas atver ar HMAC parakstītu dziļo saiti https://hostlogic.io/partner/{slug}/activate?token=…. Viesis izvēlas produktus, viņa Host Logic konts tiek izveidots, un Laura ir gatava darbam.

GET /partner-api/v1/usage Pārbaudiet, vai Jūsu atslēga darbojas
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — atslēga ir derīga, atbilde satur Jūsu sēdvietu lietojumu
# 401 Unauthorized — atslēga nav norādīta vai nav derīga
# 403 Forbidden — atslēga ir derīga, bet trūkst nepieciešamās piekļuves tiesības
# 429 Too Many Requests — pieprasījumu limita pārsniegums (120 pieprasījumi/min)

API atslēgas autentifikācija

Visiem API pieprasījumiem Authorization galvenē ir nepieciešams Bearer tokens. Jūs saņemat savu API atslēgu pēc partnera apstiprināšanas, izmantojot vienreizēju atklāšanas saiti — pati atslēga servera pusē nekad netiek glabāta un to nevar parādīt atkārtoti.

API atslēgas sākas ar hlk_, ir piesaistītas Jūsu partnera kontam un tās var nomainīt bez dīkstāves. Katrai atslēgai ir piešķirts tiesību kopums, kas nosaka, kuriem galapunktiem tā drīkst piekļūt. Katras atslēgas pirmās 12 rakstzīmes (atslēgas prefikss) tiek glabātas atklātā tekstā identifikācijai žurnālos — pārējā daļa tiek jaukta.

Pamata URL https://api.hostlogic.io/partner-api/v1

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

Pieprasījumu limits

120 pieprasījumi/minūtē uz vienu API atslēgu. Pārsniedzot limitu, tiek atgriezts 429 Too Many Requests.

Tiesības

metrics:read — vienmēr piešķirts; attiecas uz lietojuma galapunktu.
marcus:read — piešķirts, ja Jūsu partnera līgumā ir iekļauti Marcus (Revenue Manager) dati; attiecas uz īpašumu un cenu signālu galapunktiem.

Kļūdu kodi

KodsNozīme
401Nav norādīta API atslēga vai tā nav derīga
403Atslēga ir derīga, bet šim galapunktam trūkst nepieciešamās piekļuves tiesības
404Resurss nav atrasts vai nepieder Jūsu partnera kontam
429Pieprasījumu limits pārsniegts — 120 pieprasījumi/min
Katram pieprasījumam — ieteicamā galvene
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Alternatīva galvene (ērtībai CLI)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Aktīvie galapunkti un funkcijas

Tālāk norādītie galapunkti un integrācijas modeļi šobrīd ir pieejami ražošanas vidē. Viss šeit uzskaitītais ir reāls un izsaucams ar derīgu API atslēgu.

GET /usage

Vietu izmantošana Jūsu partnera kontam. Tvērums: metrics:read (vienmēr piešķirts). Skatiet pilnu atsauci zemāk.

GET /properties

Uzskaitiet īpašumus, kas pieder Jūsu sponsorētajiem saimniekiem. Tvērums: marcus:read. Skatiet pilnu atsauci zemāk.

GET /properties/{propertyId}/pricing-signals

Marcus cenu signāli un gaidāmā noslodze sponsorētam īpašumam. Tvērums: marcus:read. Skatiet pilnu atsauci zemāk.

LINK Partnera aktivizācijas dziļā saite

Ar HMAC parakstīts URL, kas izveido sponsorēta saimnieka kontu. Iegults Jūsu saskarnē kā poga. Skatiet pilnu atsauci zemāk.

GET /usage — vietu izmantošana

Atgriež autentificētā partnera aktīvo vietu skaitu ar sadalījumu pa saimniekiem. Noder rēķinu salīdzināšanai vai izmantošanas paneļa izveidei Jūsu platformā.

Nepieciešamais tvērums

metrics:read — vienmēr piešķirts visām partnera atslēgām.

IDOR aizsardzība

Šis galapunkts atgriež datus tikai autentificētajam partnerim. Tas nekad nepieņem partner_id vaicājuma parametru — identitāte tiek noteikta pilnībā pēc Jūsu API atslēgas.

Personas datu minimizēšana

Sadalījumā tiek izmantoti anonīmi saimnieku lietotāju ID un vietu skaits. Saimnieku e-pasta adreses ir apzināti izslēgtas.

Pieprasījums
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Atbilde
{
  "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 — sponsorēto īpašumu saraksts

Atgriež visus īpašumus, kas pieder saimniekiem, kurus sponsorē Jūsu partnera konts. Izmantojiet to, lai noskaidrotu, par kuriem īpašumiem varat pieprasīt cenu signālus.

Nepieciešamais tvērums

marcus:read — piešķirts, ja Jūsu partnera līgumā ir iekļauts Marcus Revenue Manager datu slānis.

Atgrieztie dati

Katrs ieraksts satur iekšējo īpašuma id (nepieciešams pricing-signals galapunktam) un īpašuma name. Saimnieka PII ārpus īpašuma nosaukuma netiek iekļauta.

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

Atgriež Marcus cenu signālus un gaidāmo noslodzi vienam sponsorētam īpašumam. Izmantojiet īpašuma id vērtības, kas atgrieztas ar GET /properties. Ja īpašums netiek atrasts vai nepieder Jūsu partnera kontam, tiek atgriezts 404.

Nepieciešamais tvērums

marcus:read

Vaicājuma parametrs

lookback_days (vesels skaitlis, noklusējums 90) — rezervāciju vēstures periods, ko izmanto signālu aprēķināšanai.

Piezīme par atbildes struktūru

signals objekts satur cenu indikatorus un rezervāciju statistiku. Precīzs lauku kopums var mainīties, Marcus pievienojot jaunus datu avotus. Tālāk redzamais reprezentatīvais piemērs parāda laukus, kas bija pieejami palaišanas brīdī — jebkurus neatpazītus laukus uzskatiet par papildinošiem.

Pieprasījums
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Pārstāvja atbilde (lauki var mainīties)
{
  "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
  }
}

Drīzumā

Tālāk norādītās iespējas ir plānotas vai tiek izstrādātas. Tās šeit ir uzskaitītas caurspīdīguma nolūkos, lai jūs varētu plānot savu integrācijas ceļvedi. Neviena no tām šobrīd nav izsaucama — mēģinot tās izmantot tagad, tiks saņemtas kļūdas.

ROADMAP Partnera pašapkalpošanās tokenu ģenerēšana

API galapunkts vai lejupielādējams SDK fragments, kas ļauj jūsu aizmugursistēmai ģenerēt parakstītus aktivizācijas tokenus bez Host Logic iesaistes. Šobrīd tokeni tiek ģenerēti pēc pieprasījuma, izmantojot administrēšanas rīku.

ROADMAP Rakstīšanas tvērumi & modificējošie galapunkti

Tādi tvērumi kā marcus:write un pierre:write, kā arī REST galapunkti īpašumu reģistrēšanai (POST /properties), atsevišķu vienību aktivizēšanai vai deaktivizēšanai un partnera iestatījumu atjaunināšanai.

ROADMAP Webhooki / reāllaika notikumi

Paziņojumi par onboarding pabeigšanu, vienības aktivizēšanu/deaktivizēšanu un lietojuma sliekšņiem. Reģistrējiet webhook URL un saņemiet parakstītas datu paketes.

ROADMAP Partnera pašapkalpošanās portāls

Ar karodziņu kontrolēts pašapkalpošanās portāls API atslēgu pārvaldībai, vietu lietojuma skatīšanai un atļauto iegulšanas avotu konfigurēšanai. Pašlaik privātajā beta versijā.

PRIVATE BETA Pierre uzturēšanas galapunkts

GET /properties/{propertyId}/operational-state — sponsorētā īpašuma uzturēšanas un darbības statuss. Izstrādāts, bet atspējots ar funkcijas karogu; nepieciešams pierre:read tvērums. Pieejams atsevišķiem partneriem pēc pieprasījuma.

ROADMAP Ieviešanas iframe iegulšana

Ieguliet Laura konfigurācijas vedni kā iframe savā PMS lietotāja saskarnē, izmantojot postMessage notikumus soļu progresam un pabeigšanai. Atkarīgs no partneru pašapkalpošanās portāla palaišanas.

ROADMAP Mākoņhostēts MCP serveris uzņēmumiem

Mākoņhostēts MCP galapunkts mcp.hostlogic.io, kas nodrošina Claude Desktop / Cursor rīku piekļuvi partnera tvēruma datiem. Arhitektūra ir plānota; uzņēmuma partneriem vēl nav pieejama.

Vai vēlaties agrīnu piekļuvi vai ietekmēt ceļveža prioritātes?

Uzņēmuma partneriem ir īpašs Slack kanāls ar Host Logic komandu. Sazinieties ar mums, rakstot uz [email protected], lai apspriestu Jūsu integrācijas prasības un laika grafiku.

Vai vēlaties integrēt Host Logic aģentus savā platformā?

Pastāstiet mums par savu PMS, channel manager vai viesmīlības programmatūras produktu. Partneru pieteikumus izskatām 2 darba dienu laikā un nodrošinām Jums API atslēgu un īpašu atbalsta kanālu.

Iekļauta sandbox vide
Integrācijas atbalsts 24 stundu laikā
Īpašs Slack kanāls