API-dokumentasjon

AI-infrastrukturen
som driver moderne hospitality-plattformer

Kun lesbar data-API og partneraktiverings-deep-link for integrering av Host Logics AI-agenter i deres PMS eller eiendomsforvaltningsplattform. Denne siden dokumenterer kun det som er live i dag — en tydelig merket Roadmap-seksjon dekker det som kommer neste.

Tre steg til produksjon

Få API-nøkkelen deres → les seteutnyttelse og prissignaler → bygg inn vertens aktiveringslenke i brukergrensesnittet deres. Dette er hele integrasjonsflyten som er tilgjengelig i dag.

Step 1 Få API-nøkkelen deres

Bli partner. Når dere er godkjent, oppretter Host Logic partnerkontoen deres og sender en engangslenke for visning som inneholder hlk_-API-nøkkelen deres. Oppbevar den sikkert — den kan ikke vises igjen etter at den er avslørt.

Step 2 Les bruk og prissignaler

Kall GET /partner-api/v1/usage for å overvåke seteutnyttelse, og GET /partner-api/v1/properties/{id}/pricing-signals for å vise Marcus-prisdata i plattformen deres.

Step 3 Bygg inn aktiveringslenken

Legg til en knapp i brukergrensesnittet deres som åpner den HMAC-signerte deep-linken https://hostlogic.io/partner/{slug}/activate?token=…. Vertens velger produkter, Host Logic-kontoen deres klargjøres, og Laura er klar.

GET /partner-api/v1/usage Kontroller at nøkkelen deres fungerer
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — nøkkelen er gyldig, svaret inneholder seteutnyttelsen deres
# 401 Unauthorized — nøkkelen mangler eller er ugyldig
# 403 Forbidden — nøkkelen er gyldig, men mangler nødvendig scope
# 429 Too Many Requests — hastighetsgrense (120 forespørsler/min)

API-nøkkelautentisering

Alle API-forespørsler krever en Bearer-token i Authorization-headeren. Dere mottar API-nøkkelen etter partnergodkjenning via en engangslenke for visning — selve nøkkelen lagres aldri på serversiden og kan ikke vises på nytt.

API-nøkler har prefikset hlk_, er knyttet til partnerkontoen deres, og kan roteres uten nedetid. Hver nøkkel har et sett med scopes som styrer hvilke endepunkter den kan kalle. De første 12 tegnene i hver nøkkel (nøkkelprefikset) lagres i klartekst for identifikasjon i logger — resten hashes.

Base-URL-er https://api.hostlogic.io/partner-api/v1

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

Hastighetsgrense

120 forespørsler/minutt per API-nøkkel. Ved overskridelse returneres 429 Too Many Requests.

Scopes

metrics:read — gis alltid; dekker bruksendepunktet.
marcus:read — gis når partneravtalen deres inkluderer Marcus-data (Revenue Manager); dekker endepunktene for eiendommer og prissignaler.

Feilkoder

KodeBetydning
401Mangler eller ugyldig API-nøkkel
403Nøkkelen er gyldig, men mangler nødvendig scope for dette endepunktet
404Ressurs ikke funnet, eller ikke eid av partnerkontoen deres
429Rategrensen er overskredet — 120 req/min
Hver forespørsel — foretrukket header
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Alternativ header (CLI-vennlig)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Live-endepunkter og funksjoner

Følgende endepunkter og integrasjonsmønstre er allerede i produksjon. Alt som er listet her, er reelt og kan kalles med en gyldig API-nøkkel.

GET /usage

Setebruk for partnerkontoen deres. Omfang: metrics:read (alltid gitt). Se full referanse nedenfor.

GET /properties

List opp eiendommer som tilhører de sponsede vertene deres. Omfang: marcus:read. Se full referanse nedenfor.

GET /properties/{propertyId}/pricing-signals

Marcus-prissignaler og kommende belegg for en sponset eiendom. Omfang: marcus:read. Se full referanse nedenfor.

LINK Dypkobling for partneraktivering

HMAC-signert URL som oppretter en sponset vertskonto. Innebygd i brukergrensesnittet deres som en knapp. Se full referanse nedenfor.

GET /usage — Setebruk

Returnerer den autentiserte partnerens aktive antall seter, med fordeling per vert. Nyttig for å avstemme fakturering eller bygge et brukspanel i plattformen deres.

Påkrevd omfang

metrics:read — gis alltid til alle partnernøkler.

IDOR-beskyttelse

Dette endepunktet returnerer bare data for den autentiserte partneren. Det aksepterer aldri en partner_id-spørringsparameter — identiteten kommer utelukkende fra API-nøkkelen deres.

Minimering av personopplysninger

Fordelingen bruker ugjennomsiktige vertsbruker-ID-er og setetall. Vertenes e-postadresser er bevisst utelatt.

Forespørsel
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Svar
{
  "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 — List opp sponsede eiendommer

Returnerer alle eiendommer som tilhører verter partnerkontoen deres sponser. Bruk dette for å finne ut hvilke eiendommer dere kan spørre etter prissignaler for.

Påkrevd omfang

marcus:read — gis når partneravtalen deres inkluderer Marcus Revenue Manager-dataplanet.

Data som returneres

Hver oppføring inneholder den interne eiendoms-id-en (nødvendig for pricing-signals-endepunktet) og eiendommens name. Vertens personopplysninger utover eiendomsnavnet er utelatt.

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

Returnerer Marcus-prissignaler og kommende belegg for én sponset eiendom. Bruk eiendoms-id-verdiene som returneres av GET /properties. En 404 returneres hvis eiendommen ikke finnes eller ikke eies av partnerkontoen deres.

Påkrevd omfang

marcus:read

Spørringsparameter

lookback_days (heltall, standard 90) — reservasjonsvinduet som brukes til å beregne signaler.

Merk om responsstruktur

signals-objektet inneholder prisindikatorer og reservasjonsstatistikk. Det nøyaktige feltsettet kan utvikle seg etter hvert som Marcus legger til nye datakilder. Eksempelet nedenfor viser feltene som er tilgjengelige ved lansering — behandle eventuelle ukjente felt som tillegg.

Forespørsel
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Representativt svar (feltene kan endres)
{
  "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
  }
}

Kommer snart

Følgende funksjoner er planlagt eller under utvikling. De er listet her for å gi innsyn, slik at dere kan planlegge integrasjonsveikartet deres. Ingen av disse kan brukes i dag — å bygge mot dem nå vil føre til feil.

ROADMAP Partnernes egen selvbetjening for tokenutstedelse

Et API-endepunkt eller et nedlastbart SDK-utdrag som lar backend-en deres generere signerte aktiveringstokens uten å involvere Host Logic. I dag genereres tokens på forespørsel via et administrasjonsverktøy.

ROADMAP Skrive-scopes & endepunkter som endrer data

Scopes som marcus:write og pierre:write, samt REST-endepunkter for å registrere eiendommer (POST /properties), aktivere eller deaktivere enkelt-enheter og oppdatere partnerinnstillinger.

ROADMAP Webhooks / sanntidshendelser

Push-varsler for fullført onboarding, aktivert/deaktivert enhet og bruksterskler. Registrer en webhook-URL og motta signerte nyttelaster.

ROADMAP Partnernes selvbetjeningsportal

En flaggstyrt selvbetjeningsportal for å administrere API-nøkler, se seteutnyttelse og konfigurere tillatte embed-opprinnelser. For øyeblikket i privat beta.

PRIVATE BETA Pierre vedlikeholdsendepunkt

GET /properties/{propertyId}/operational-state — vedlikeholds- og driftsstatus for en sponset eiendom. Bygget, men deaktivert av en funksjonsflagg; krever pierre:read-scope. Tilgjengelig for utvalgte partnere på forespørsel.

ROADMAP Innebygging av onboarding-iframe

Bygg inn Laura-konfigurasjonsveiviseren som en iframe i PMS-grensesnittet deres, med postMessage-hendelser for fremdrift i trinnene og fullføring. Avhenger av lanseringen av partnernes selvbetjeningsportal.

ROADMAP Hostet MCP-server for enterprise

Et hostet MCP-endepunkt på mcp.hostlogic.io som gir Claude Desktop / Cursor tilgang til verktøy for partneravgrensede data. Arkitekturen er planlagt; ikke live ennå for enterprise-partnere.

Ønsker dere tidlig tilgang eller innspill til prioriteringene i veikartet?

Enterprise-partnere har en egen Slack-kanal med Host Logic-teamet. Ta kontakt på [email protected] for å diskutere integrasjonsbehovene deres og tidslinjen.

Ønsker dere å bringe Host Logic-agenter til plattformen deres?

Fortell oss om PMS-en, channel manageren eller programvareproduktet deres for hospitality. Vi vurderer partnerforespørsler innen 2 virkedager og gir dere API-nøkkelen og en egen supportkanal.

Sandbox-miljø inkludert
Integrasjonsstøtte innen 24 timer
Egen Slack-kanal