API-dokumentation

AI-infrastrukturen
som driver moderna hospitality-plattformar

Skrivskyddat data-API och partneraktiverings-deep-link för att integrera Host Logics AI-agenter i ditt PMS eller din fastighetsförvaltningsplattform. Denna sida dokumenterar endast det som är live i dag — en tydligt märkt Roadmap-sektion beskriver vad som kommer härnäst.

Tre steg till drift

Hämta din API-nyckel → läs sätesanvändning och prissignaler → bädda in värdens aktiveringslänk i ditt gränssnitt. Det är hela integrationsflödet som finns tillgängligt i dag.

Step 1 Hämta din API-nyckel

Bli partner. När du har godkänts skapar Host Logic ditt partnerkonto och skickar en engångslänk för visning som innehåller din hlk_-API-nyckel. Förvara den säkert — den kan inte visas igen efter att den har avslöjats.

Step 2 Läs användning & prissignaler

Anropa GET /partner-api/v1/usage för att övervaka sätesförbrukning, och GET /partner-api/v1/properties/{id}/pricing-signals för att visa Marcus prisdata i din plattform.

Step 3 Bädda in aktiveringslänken

Lägg till en knapp i ditt gränssnitt som öppnar den HMAC-signerade deep-linken https://hostlogic.io/partner/{slug}/activate?token=…. Värden väljer produkter, deras Host Logic-konto provisioneras och Laura är redo.

GET /partner-api/v1/usage Verifiera att din nyckel fungerar
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — nyckeln är giltig, svaret innehåller din sätesanvändning
# 401 Unauthorized — nyckeln saknas eller är ogiltig
# 403 Forbidden — nyckeln är giltig men saknar nödvändig behörighet
# 429 Too Many Requests — hastighetsgräns (120 förfrågningar/min)

API-nyckelautentisering

Alla API-förfrågningar kräver en Bearer-token i Authorization-huvudet. Du får din API-nyckel efter partnergodkännande via en engångslänk för visning — den okrypterade nyckeln lagras aldrig på serversidan och kan inte visas igen.

API-nycklar har prefixet hlk_, är kopplade till ditt partnerkonto och kan roteras utan driftstopp. Varje nyckel har en uppsättning scopes som styr vilka endpoints den får anropa. De första 12 tecknen i varje nyckel (nyckelprefixet) lagras i klartext för identifiering i loggar — resten hashas.

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

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

Hastighetsgräns

120 förfrågningar/minut per API-nyckel. Överskridande returnerar 429 Too Many Requests.

Scopes

metrics:read — beviljas alltid; omfattar usage-endpointen.
marcus:read — beviljas när ditt partneravtal inkluderar Marcus-data (Revenue Manager); omfattar endpoints för properties och pricing-signals.

Felkoder

KodBetydelse
401API-nyckel saknas eller är ogiltig
403Nyckeln är giltig, men saknar nödvändigt scope för denna endpoint
404Resursen hittades inte, eller ägs inte av ditt partnerkonto
429Gränsen för anrop har överskridits — 120 anrop/min
Varje begäran — föredragen rubrik
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Alternativ rubrik (praktiskt för CLI)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Live-endpoints och funktioner

Följande endpoints och integrationsmönster är redan i produktion. Allt som listas här är verkligt och kan anropas med en giltig API-nyckel.

GET /usage

Sätesanvändning för ditt partnerkonto. Omfattning: metrics:read (beviljas alltid). Se fullständig referens nedan.

GET /properties

Lista över fastigheter som tillhör dina sponsrade värdar. Omfattning: marcus:read. Se fullständig referens nedan.

GET /properties/{propertyId}/pricing-signals

Marcus prissignaler och kommande beläggning för en sponsrad fastighet. Omfattning: marcus:read. Se fullständig referens nedan.

LINK Djup länk för partneraktivering

HMAC-signerad URL som provisionerar ett sponsrat värdkonto. Inbäddad i ditt gränssnitt som en knapp. Se fullständig referens nedan.

GET /usage — Sätesanvändning

Returnerar den autentiserade partnerns aktiva sätesantal med en uppdelning per värd. Användbart för att stämma av fakturering eller bygga en användningsdashboard i din plattform.

Nödvändig omfattning

metrics:read — beviljas alltid för alla partnernycklar.

IDOR-skydd

Denna endpoint returnerar endast data för den autentiserade partnern. Den accepterar aldrig en frågeparameter partner_id — identiteten kommer helt från din API-nyckel.

Minimering av personuppgifter

Uppdelningen använder opaka användar-ID:n för värdar och sätesantal. Värdarnas e-postadresser är medvetet exkluderade.

Begäran
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 — Lista sponsrade fastigheter

Returnerar alla fastigheter som tillhör värdar som ditt partnerkonto sponsrar. Använd detta för att identifiera vilka fastigheter du kan fråga efter prissignaler för.

Nödvändig omfattning

marcus:read — beviljas när ditt partneravtal inkluderar Marcus Revenue Manager data plane.

Returnerade data

Varje post innehåller fastighetens interna id (behövs för pricing-signals-endpointen) och fastighetens name. Värdens personuppgifter utöver fastighetsnamnet exkluderas.

Begäran
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

Returnerar Marcus prissignaler och kommande beläggning för en enskild sponsrad fastighet. Använd de värden för fastighetens id som returneras av GET /properties. En 404 returneras om fastigheten inte hittas eller inte ägs av ditt partnerkonto.

Nödvändig omfattning

marcus:read

Frågeparameter

lookback_days (heltal, standard 90) — tidsfönster för bokningshistorik som används för att beräkna signaler.

Anmärkning om svarsstruktur

signals-objektet innehåller prissättningsindikatorer och bokningsstatistik. Det exakta fältsetet kan utvecklas i takt med att Marcus lägger till nya datakällor. Det representativa exemplet nedan visar de fält som finns vid lansering — behandla eventuella okända fält som tillägg.

Begäran
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 (fälten kan utvecklas)
{
  "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öljande funktioner är planerade eller under utveckling. De listas här för transparens så att du kan planera din integrationsroadmap. Inga av dessa går att anropa i dag — att bygga mot dem nu kommer att leda till fel.

ROADMAP Partnerns självbetjäning för att skapa token

En API-slutpunkt eller ett nedladdningsbart SDK-utdrag som låter din backend generera signerade aktiveringstoken utan att involvera Host Logic. I dag genereras token på begäran via ett administratörsverktyg.

ROADMAP Skrivscopes & muterande slutpunkter

Scopes som marcus:write och pierre:write samt REST-slutpunkter för att registrera fastigheter (POST /properties), aktivera eller avaktivera enskilda enheter och uppdatera partnerinställningar.

ROADMAP Webhooks / realtidsändelser

Pushnotiser för onboarding slutförd, enhet aktiverad/avaktiverad och användningströsklar. Registrera en webhook-URL och ta emot signerade nyttolaster.

ROADMAP Partnerns självbetjäningsportal

En flaggstyrd självbetjäningsportal för att hantera API-nycklar, se platsanvändning och konfigurera tillåtna inbäddningsdomäner. För närvarande i privat beta.

PRIVATE BETA Pierre-underhållsändpunkt

GET /properties/{propertyId}/operational-state — underhålls- och driftstatus för en sponsrad fastighet. Finns implementerad men är avstängd via en funktionsflagga; kräver omfånget pierre:read. Tillgänglig för utvalda partners på begäran.

ROADMAP Inbäddning av onboarding via iframe

Bädda in Laura-konfigurationsguiden som en iframe i ditt PMS-gränssnitt, med postMessage-händelser för stegvis förlopp och slutförande. Beroende av lanseringen av partnerportalen för självbetjäning.

ROADMAP Hostad MCP-server för enterprise

En hostad MCP-ändpunkt på mcp.hostlogic.io som ger Claude Desktop / Cursor åtkomst till verktyg för partneravgränsade data. Arkitekturen är planerad; ännu inte live för enterprise-partners.

Vill du ha tidig åtkomst eller påverka prioriteringarna i roadmapen?

Enterprise-partners har en dedikerad Slack-kanal med Host Logic-teamet. Kontakta oss på [email protected] för att diskutera dina integrationskrav och din tidsplan.

Vill du ta Host Logic-agenter till din plattform?

Berätta om ditt PMS, din channel manager eller din hospitality-programvara. Vi granskar partneransökningar inom 2 arbetsdagar och tillhandahåller din API-nyckel samt en dedikerad supportkanal.

Sandboxmiljö ingår
Integrationsstöd inom 24 timmar
Dedikerad Slack-kanal