API dokumentacija

DI infrastruktūra
varanti šiuolaikines svetingumo platformas

Tik skaitymui skirta duomenų API ir partnerio aktyvavimo gilusis saitas, skirti integruoti Host Logic DI agentus į Jūsų PMS arba turto valdymo platformą. Šiame puslapyje dokumentuojama tik tai, kas šiandien jau veikia — aiškiai pažymėtas Roadmap skyrius apima tai, kas bus toliau.

Trys žingsniai iki paleidimo

Gaukite savo API raktą → peržiūrėkite vietų naudojimą ir kainodaros signalus → įterpkite šeimininko aktyvavimo nuorodą į savo UI. Tai yra visa šiandien prieinama integracijos eiga.

Step 1 Gaukite savo API raktą

Tapkite partneriu. Patvirtinus Host Logic sukuria Jūsų partnerio paskyrą ir atsiunčia vienkartinę atskleidimo nuorodą su Jūsų hlk_ API raktu. Saugiai jį išsaugokite — po atskleidimo jis nebegalės būti parodytas dar kartą.

Step 2 Skaitykite naudojimo ir kainodaros signalus

Kreipkitės į GET /partner-api/v1/usage, kad stebėtumėte vietų sunaudojimą, ir į GET /partner-api/v1/properties/{id}/pricing-signals, kad savo platformoje matytumėte Marcus kainodaros duomenis.

Step 3 Įterpkite aktyvavimo nuorodą

Pridėkite savo UI mygtuką, kuris atidaro HMAC pasirašytą gilųjį saitą https://hostlogic.io/partner/{slug}/activate?token=…. Šeimininkas pasirenka produktus, jo Host Logic paskyra sukonfigūruojama, o Laura yra pasirengusi.

GET /partner-api/v1/usage Patikrinkite, ar Jūsų raktas veikia
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — raktas galiojantis, atsakyme pateikiamas Jūsų vietų naudojimas
# 401 Unauthorized — rakto nėra arba jis neteisingas
# 403 Forbidden — raktas galiojantis, bet trūksta reikiamos apimties
# 429 Too Many Requests — užklausų limitas (120 req/min)

API rakto autentifikavimas

Visoms API užklausoms Authorization antraštėje reikalingas Bearer žetonas. API raktą gausite po partnerio patvirtinimo per vienkartinę atskleidimo nuorodą — paprastas raktas niekada nesaugomas serverio pusėje ir negali būti parodytas dar kartą.

API raktai prasideda hlk_, yra priskirti Jūsų partnerio paskyrai ir gali būti keičiami nenutraukiant veikimo. Kiekvienas raktas turi nustatytą apimčių rinkinį, kuris valdo, kuriuos galinius taškus jis gali kviesti. Pirmi 12 kiekvieno rakto simbolių (rakto prefiksas) žurnaluose saugomi paprastu tekstu identifikavimui — likusi dalis yra maišoma.

Bazės URL https://api.hostlogic.io/partner-api/v1

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

Užklausų limitas

120 užklausų per minutę vienam API raktui. Viršijus grąžinama 429 Too Many Requests.

Apimtys

metrics:read — visada suteikiama; apima naudojimo galinį tašką.
marcus:read — suteikiama, kai Jūsų partnerio sutartyje yra Marcus (Revenue Manager) duomenys; apima properties ir pricing-signals galinius taškus.

Klaidų kodai

KodasReikšmė
401Trūksta API rakto arba jis neteisingas
403Raktas galiojantis, bet šiam galiniam taškui trūksta reikiamos apimties
404Išteklius nerastas arba nepriklauso Jūsų partnerio paskyrai
429Viršytas užklausų limitas — 120 užklausų/min.
Kiekvienai užklausai — rekomenduojama antraštė
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Alternatyvi antraštė (patogu naudojant CLI)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Veikiantys galiniai taškai ir funkcijos

Toliau nurodyti galiniai taškai ir integracijos modeliai šiuo metu veikia gamybinėje aplinkoje. Viskas, kas čia išvardyta, yra realu ir gali būti iškviesta su galiojančiu API raktu.

GET /usage

Jūsų partnerio paskyros vietų naudojimas. Sritis: metrics:read (visada suteikiama). Žr. visą nuorodą žemiau.

GET /properties

Jūsų remiamiems šeimininkams priklausančių objektų sąrašas. Sritis: marcus:read. Žr. visą nuorodą žemiau.

GET /properties/{propertyId}/pricing-signals

Marcus kainodaros signalai ir artėjantis užimtumas remiamam objektui. Sritis: marcus:read. Žr. visą nuorodą žemiau.

LINK Partnerio aktyvavimo gilioji nuoroda

HMAC pasirašytas URL, kuriuo sukuriama remiamo šeimininko paskyra. Įterpiamas į Jūsų sąsają kaip mygtukas. Žr. visą nuorodą žemiau.

GET /usage — vietų naudojimas

Grąžina autentifikuoto partnerio aktyvių vietų skaičių su suskirstymu pagal kiekvieną šeimininką. Naudinga suderinant sąskaitas arba kuriant naudojimo suvestinę Jūsų platformoje.

Reikalinga sritis

metrics:read — visada suteikiama visiems partnerio raktams.

IDOR apsauga

Šis galinis taškas grąžina duomenis tik autentifikuotam partneriui. Jis niekada nepriima partner_id užklausos parametro — tapatybė nustatoma tik pagal Jūsų API raktą.

PII minimizavimas

Suskirstyme naudojami neidentifikuojami šeimininkų naudotojų ID ir vietų skaičiai. Šeimininkų el. pašto adresai sąmoningai neįtraukiami.

Užklausa
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Atsakymas
{
  "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 — remiamų objektų sąrašas

Grąžina visus objektus, priklausančius šeimininkams, kuriuos remia Jūsų partnerio paskyra. Naudokite tai norėdami sužinoti, kurių objektų kainodaros signalus galite užklausti.

Reikalinga sritis

marcus:read — suteikiama, kai Jūsų partnerio sutartyje yra Marcus Revenue Manager duomenų sluoksnis.

Grąžinami duomenys

Kiekviename įraše yra vidinis objekto id (reikalingas pricing-signals galiniam taškui) ir objekto name. Su objektu nesusiję šeimininko PII duomenys neįtraukiami.

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

Grąžina Marcus kainodaros signalus ir artėjantį užimtumą vienam remiamam objektui. Naudokite objekto id reikšmes, grąžintas iš GET /properties. Jei objektas nerandamas arba nepriklauso Jūsų partnerio paskyrai, grąžinamas 404.

Reikalinga sritis

marcus:read

Užklausos parametras

lookback_days (sveikasis skaičius, numatytoji reikšmė 90) — rezervacijų istorijos laikotarpis, naudojamas signalams apskaičiuoti.

Pastaba apie atsakymo struktūrą

signals objektas apima kainodaros rodiklius ir rezervacijų statistiką. Tikslus laukų rinkinys gali keistis, Marcus pridedant naujus duomenų šaltinius. Toliau pateiktas pavyzdys rodo paleidimo metu prieinamus laukus — visus neatpažintus laukus laikykite papildomais.

Užklausa
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Atstovo atsakymas (laukeliai gali keistis)
{
  "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
  }
}

Netrukus

Toliau pateiktos galimybės yra planuojamos arba kuriamos. Jos čia išvardytos skaidrumo tikslais, kad galėtumėte planuoti savo integracijos kelią. Šiuo metu nė viena iš jų dar nėra pasiekiama — bandant jas naudoti dabar bus gaunamos klaidos.

ROADMAP Partnerio savitarnos žetonų generavimas

API galinis taškas arba atsisiunčiamas SDK fragmentas, leidžiantis Jūsų backend'ui generuoti pasirašytus aktyvavimo žetonus neįtraukiant Host Logic. Šiandien žetonai generuojami pagal užklausą administravimo įrankiu.

ROADMAP Rašymo teisės ir keičiančios galinius taškus operacijos

Teisės, tokios kaip marcus:write ir pierre:write, bei REST galiniai taškai objektams registruoti (POST /properties), atskiriems vienetams aktyvuoti arba deaktyvuoti ir partnerio nustatymams atnaujinti.

ROADMAP Webhook'ai / realaus laiko įvykiai

Pranešimai apie užbaigtą įtraukimą, vieneto aktyvavimą / deaktyvavimą ir naudojimo ribas. Užregistruokite webhook URL ir gaukite pasirašytus duomenų paketus.

ROADMAP Partnerio savitarnos portalas

Savitarnos portalas su įjungimo vėliavėle API raktams valdyti, vietų naudojimui peržiūrėti ir leidžiamiems įterpimo originams konfigūruoti. Šiuo metu privati beta versija.

PRIVATE BETA Pierre priežiūros galinis taškas

GET /properties/{propertyId}/operational-state — sponsoruoto objekto priežiūros ir veikimo būsena. Sukurtas, bet išjungtas naudojant funkcijos vėliavą; reikalinga pierre:read prieiga. Prieinamas atrinktiems partneriams pagal užklausą.

ROADMAP Įdiegimo vedlio įterpimas per iframe

Įterpkite Laura konfigūravimo vedlį kaip iframe į savo PMS sąsają, naudojant postMessage įvykius žingsnių eigai ir užbaigimui. Priklauso nuo partnerių savitarnos portalo paleidimo.

ROADMAP Priglobtas MCP serveris įmonėms

Priglobtas MCP galinis taškas adresu mcp.hostlogic.io, suteikiantis Claude Desktop / Cursor įrankių prieigą prie partneriui priskirtų duomenų. Architektūra suplanuota; įmonių partneriams dar neprieinama.

Norite ankstyvos prieigos arba norite pateikti įžvalgų dėl kelrodžio prioritetų?

Įmonių partneriai turi atskirą Slack kanalą su Host Logic komanda. Susisiekite adresu [email protected], kad aptartume Jūsų integracijos poreikius ir terminus.

Norite Host Logic agentus integruoti į savo platformą?

Papasakokite apie savo PMS, kanalų valdymo sistemą arba svetingumo programinės įrangos produktą. Partnerių paraiškas peržiūrime per 2 darbo dienas ir suteikiame Jums API raktą bei atskirą palaikymo kanalą.

Įtraukta smėlio dėžės aplinka
Integracijos palaikymas per 24 valandas
Atskiras Slack kanalas