API-dokumentaatio

AI-infrastruktuuri
modernien majoitusalustojen taustalla

Vain lukuoikeudella toimiva data-API ja kumppanin aktivointiin tarkoitettu syvälinkki Host Logicin AI-agenttien integroimiseksi PMS-järjestelmäänne tai kiinteistöhallinta-alustaanne. Tällä sivulla dokumentoidaan vain se, mikä on tänään käytössä — selkeästi merkitty Roadmap-osio kattaa tulevat ominaisuudet.

Kolme vaihetta käyttöönottoon

Hanki API-avaimenne → lue istumapaikkojen käyttö ja hinnoittelusignaalit → upota isännän aktivointilinkki käyttöliittymäänne. Tämä on koko tämänhetkinen integraatiokokonaisuus.

Step 1 Hanki API-avaimenne

Tule kumppaniksi. Hyväksynnän jälkeen Host Logic luo kumppanitilinne ja lähettää teille kertakäyttöisen paljastuslinkin, joka sisältää hlk_-API-avaimenne. Säilyttäkää se turvallisesti — sitä ei voi näyttää uudelleen paljastamisen jälkeen.

Step 2 Lue käyttö- ja hinnoittelusignaalit

Kutsukaa GET /partner-api/v1/usage seurataksenne istumapaikkojen käyttöä ja GET /partner-api/v1/properties/{id}/pricing-signals näyttääksenne Marcusin hinnoittelutiedot alustallanne.

Step 3 Upota aktivointilinkki

Lisätkää käyttöliittymäänne painike, joka avaa HMAC-allekirjoitetun syvälinkin https://hostlogic.io/partner/{slug}/activate?token=…. Isäntä valitsee tuotteet, hänen Host Logic -tilinsä otetaan käyttöön, ja Laura on valmis.

GET /partner-api/v1/usage Varmistakaa, että avaimenne toimii
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — avain on kelvollinen, vastaus sisältää istumapaikkojen käytön
# 401 Unauthorized — avain puuttuu tai on virheellinen
# 403 Forbidden — avain on kelvollinen, mutta vaadittu käyttöoikeus puuttuu
# 429 Too Many Requests — pyyntöraja ylittynyt (120 pyyntöä/min)

API-avaimella tunnistautuminen

Kaikki API-pyynnöt edellyttävät Bearer-tunnistetta Authorization-otsakkeessa. Saatte API-avaimenne kumppanihyväksynnän jälkeen kertakäyttöisen paljastuslinkin kautta — selväkielistä avainta ei koskaan tallenneta palvelinpuolelle, eikä sitä voi näyttää uudelleen.

API-avaimissa on etuliite hlk_, ne on rajattu kumppanitilillenne, ja ne voidaan kierrättää ilman käyttökatkoa. Jokaisella avaimella on joukko käyttöoikeuksia, jotka määrittävät, mitä päätepisteitä se voi kutsua. Kunkin avaimen ensimmäiset 12 merkkiä (avaimen etuliite) tallennetaan selväkielisenä lokien tunnistamista varten — loppu on tiivistetty.

Perus-URL-osoitteet https://api.hostlogic.io/partner-api/v1

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

Pyyntörajoitus

120 pyyntöä/minuutti API-avainta kohden. Rajoituksen ylitys palauttaa 429 Too Many Requests.

Käyttöoikeusalueet

metrics:read — myönnetään aina; kattaa usage-päätepisteen.
marcus:read — myönnetään, kun kumppanisopimukseenne sisältyy Marcus (Revenue Manager) -data; kattaa properties- ja pricing-signals-päätepisteet.

Virhekoodit

KoodiMerkitys
401API-avain puuttuu tai on virheellinen
403Avain on kelvollinen, mutta tästä päätepisteestä puuttuva vaadittu käyttöoikeus
404Resurssia ei löytynyt tai se ei kuulu kumppanitilillenne
429Pyyntöjen määrä ylitti rajan — 120 pyyntöä/min
Jokaisessa pyynnössä — ensisijainen otsake
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Vaihtoehtoinen otsake (kätevä CLI-käytössä)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Reaaliaikaiset päätepisteet ja ominaisuudet

Seuraavat päätepisteet ja integraatiomallit ovat tuotannossa jo nyt. Kaikki tässä luetellut kohteet ovat todellisia ja kutsuttavissa voimassa olevalla API-avaimella.

GET /usage

Istumapaikkojen käyttö kumppanitilillenne. Laajuus: metrics:read (myönnetään aina). Katso täydellinen viite alta.

GET /properties

Luettelee sponsoroituihin majoittajiinne kuuluvat majoituspaikat. Laajuus: marcus:read. Katso täydellinen viite alta.

GET /properties/{propertyId}/pricing-signals

Marcusin hinnoittelusignaalit ja tuleva käyttöaste sponsoroidulle majoituspaikalle. Laajuus: marcus:read. Katso täydellinen viite alta.

LINK Kumppanin aktivointisyvälinkki

HMAC-allekirjoitettu URL-osoite, joka luo sponsoroidun majoittajatilin. Upotetaan käyttöliittymäänne painikkeena. Katso täydellinen viite alta.

GET /usage — Istumapaikkojen käyttö

Palauttaa todennetun kumppanin aktiivisten istumapaikkojen määrän sekä erittelyn majoittajakohtaisesti. Hyödyllinen laskutuksen täsmäyttämiseen tai käyttökoontinäytön rakentamiseen alustallenne.

Vaadittu laajuus

metrics:read — myönnetään aina kaikille kumppaniavaimille.

IDOR-suojaus

Tämä päätepiste palauttaa tietoja vain todennetulle kumppanille. Se ei koskaan hyväksy partner_id-kyselyparametria — identiteetti tulee kokonaan API-avaimestanne.

Henkilötietojen minimointi

Erittely käyttää peitettyjä majoittajakohtaisia käyttäjätunnuksia ja istumapaikkamääriä. Majoittajien sähköpostiosoitteet on tarkoituksella jätetty pois.

Pyyntö
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Vastaus
{
  "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 — Luettele sponsoroidut majoituspaikat

Palauttaa kaikki majoituspaikat, jotka kuuluvat majoittajille, joita kumppanitilinne sponsoroi. Käyttäkää tätä selvittääksenne, mistä majoituspaikoista voitte hakea hinnoittelusignaaleja.

Vaadittu laajuus

marcus:read — myönnetään, kun kumppanisopimukseenne sisältyy Marcus Revenue Managerin datataso.

Palautettavat tiedot

Jokainen merkintä sisältää sisäisen majoituspaikan id-tunnuksen (tarvitaan pricing-signals-päätepistettä varten) sekä majoituspaikan name-nimen. Majoittajan henkilötiedot majoituspaikan nimeä lukuun ottamatta on jätetty pois.

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

Palauttaa Marcusin hinnoittelusignaalit ja tulevan käyttöasteen yhdelle sponsoroidulle majoituspaikalle. Käyttäkää GET /properties-kutsun palauttamia majoituspaikan id-arvoja. 404 palautetaan, jos majoituspaikkaa ei löydy tai se ei kuulu kumppanitilillenne.

Vaadittu laajuus

marcus:read

Kyselyparametri

lookback_days (kokonaisluku, oletus 90) — varaushistorian aikajakso, jota käytetään signaalien laskemiseen.

Huomio vastauksen rakenteesta

signals-objekti sisältää hinnoitteluindikaattorit ja varaustilastot. Tarkka kenttäjoukko voi kehittyä, kun Marcus lisää uusia tietolähteitä. Alla oleva esimerkkitapaus näyttää julkaisussa saatavilla olevat kentät — käsitelkää mahdollisia tunnistamattomia kenttiä lisäyksinä.

Pyyntö
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Edustava vastaus (kentät voivat muuttua)
{
  "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
  }
}

Tulossa pian

Seuraavat ominaisuudet on suunniteltu tai ne ovat kehitteillä. Ne on listattu tässä läpinäkyvyyden vuoksi, jotta voitte suunnitella integraatioroadmapinne. Yksikään näistä ei ole vielä kutsuttavissa — niiden rakentaminen nyt johtaa virheisiin.

ROADMAP Kumppanin itsepalveluna tekemä tokenien luonti

API-päätepiste tai ladattava SDK-koodinpätkä, jonka avulla taustajärjestelmänne voi luoda allekirjoitettuja aktivointitokeneita ilman Host Logicia. Tällä hetkellä tokenit luodaan pyynnöstä hallintatyökalulla.

ROADMAP Kirjoitusoikeudet & muokkaavat päätepisteet

Oikeudet kuten marcus:write ja pierre:write sekä REST-päätepisteet kohteiden rekisteröintiin (POST /properties), yksittäisten yksiköiden aktivointiin tai deaktivointiin sekä kumppaniasetusten päivittämiseen.

ROADMAP Webhookit / reaaliaikaiset tapahtumat

Push-ilmoitukset käyttöönoton valmistumisesta, yksikön aktivoinnista/deaktivoinnista sekä käyttörajojen ylittymisestä. Rekisteröikää webhook-URL ja vastaanottakaa allekirjoitetut hyötykuormat.

ROADMAP Kumppanin itsepalveluportaali

Lippujen avulla ohjattu itsepalveluportaali API-avainten hallintaan, paikkakäytön tarkasteluun ja sallittujen upotussivustojen määrittämiseen. Tällä hetkellä yksityisessä betassa.

PRIVATE BETA Pierre-huolto-rajapinta

GET /properties/{propertyId}/operational-state — sponsoroidun majoituskohteen huolto- ja toimintatila. Toteutettu, mutta poistettu käytöstä ominaisuuslipulla; edellyttää pierre:read-oikeutta. Saatavilla valituille kumppaneille pyynnöstä.

ROADMAP Käyttöönoton iframe-upotus

Upottakaa Laura-määritystoiminto iframe-kehyksenä PMS-käyttöliittymäänne, ja käyttäkää postMessage-tapahtumia vaiheen etenemisen ja valmistumisen ilmoittamiseen. Riippuu kumppanin itsepalveluportaalin julkaisusta.

ROADMAP Isännöity MCP-palvelin yritysasiakkaille

Isännöity MCP-päätepiste osoitteessa mcp.hostlogic.io, joka tarjoaa Claude Desktopin / Cursorin työkalukäytön kumppanikohtaisiin tietoihin. Arkkitehtuuri on suunnitteilla; ei vielä käytössä yrityskumppaneille.

Haluatteko varhaisen käyttöoikeuden tai vaikuttaa tiekartan prioriteetteihin?

Yrityskumppaneilla on oma Slack-kanava Host Logic -tiimin kanssa. Ottakaa yhteyttä osoitteessa [email protected] keskustellaksenne integraatiovaatimuksistanne ja aikataulustanne.

Haluatteko tuoda Host Logic -agentit alustallenne?

Kertokaa meille PMS-järjestelmästänne, channel manageristanne tai majoitusalan ohjelmistotuotteestanne. Arvioimme kumppanuushakemukset 2 arkipäivän kuluessa ja toimitamme API-avaimenne sekä oman tukikanavan.

Sandbox-ympäristö sisältyy
Integraatiotuki 24 tunnin kuluessa
Oma Slack-kanava