API-Dokumentation

Die KI-Infrastruktur
als Antrieb moderner Hospitality-Plattformen

Read-only-Daten-API und Deep-Link zur Partner-Aktivierung für die Integration der KI-Agenten von Host Logic in Ihr PMS oder Ihre Property-Management-Plattform. Diese Seite dokumentiert ausschließlich das, was heute live ist — ein deutlich gekennzeichneter Roadmap-Abschnitt beschreibt, was als Nächstes kommt.

In drei Schritten live

API-Schlüssel abrufen → Sitzplatznutzung und Preissignale auslesen → Aktivierungslink für Hosts in Ihre Oberfläche einbetten. Das ist die vollständige Integrationsschleife, die heute verfügbar ist.

Step 1 API-Schlüssel abrufen

Werden Sie Partner. Nach der Freigabe erstellt Host Logic Ihr Partnerkonto und sendet Ihnen einen einmalig einsehbaren Link mit Ihrem hlk_-API-Schlüssel. Bewahren Sie ihn sicher auf — nach der Anzeige kann er nicht erneut eingesehen werden.

Step 2 Nutzung & Preissignale auslesen

Rufen Sie GET /partner-api/v1/usage auf, um den Sitzplatzverbrauch zu überwachen, und GET /partner-api/v1/properties/{id}/pricing-signals, um Marcus-Preisdaten in Ihrer Plattform darzustellen.

Step 3 Aktivierungslink einbetten

Fügen Sie in Ihrer Oberfläche eine Schaltfläche hinzu, die den HMAC-signierten Deep-Link https://hostlogic.io/partner/{slug}/activate?token=… öffnet. Der Host wählt Produkte aus, sein Host-Logic-Konto wird bereitgestellt, und Laura ist einsatzbereit.

GET /partner-api/v1/usage Prüfen Sie, ob Ihr Schlüssel funktioniert
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — key is valid, response contains your seat usage
# 401 Unauthorized — key missing or invalid
# 403 Forbidden — key valid but missing required scope
# 429 Too Many Requests — rate limit (120 req/min)

Authentifizierung per API-Schlüssel

Alle API-Anfragen erfordern ein Bearer-Token im Authorization-Header. Sie erhalten Ihren API-Schlüssel nach der Partnerfreigabe über einen einmalig einsehbaren Link — der Klartext-Schlüssel wird serverseitig niemals gespeichert und kann nicht erneut angezeigt werden.

API-Schlüssel tragen das Präfix hlk_, sind an Ihr Partnerkonto gebunden und können ohne Ausfallzeit rotiert werden. Jeder Schlüssel führt eine Reihe von Scopes, die festlegen, welche Endpunkte er aufrufen darf. Die ersten 12 Zeichen jedes Schlüssels (das Schlüssel-Präfix) werden im Klartext zur Identifikation in Logs gespeichert — der Rest wird gehasht.

Basis-URLs https://api.hostlogic.io/partner-api/v1

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

Ratenbegrenzung

120 Anfragen/Minute pro API-Schlüssel. Bei Überschreitung wird 429 Too Many Requests zurückgegeben.

Scopes

metrics:read — immer gewährt; deckt den Nutzungs-Endpunkt ab.
marcus:read — gewährt, wenn Ihre Partnervereinbarung Marcus-Daten (Revenue Manager) umfasst; deckt die Endpunkte für Objekte und Preissignale ab.

Fehlercodes

CodeBedeutung
401Fehlender oder ungültiger API-Schlüssel
403Schlüssel gültig, aber der für diesen Endpunkt erforderliche Scope fehlt
404Ressource nicht gefunden oder gehört nicht zu Ihrem Partnerkonto
429Ratenbegrenzung überschritten — 120 req/min
Jede Anfrage — bevorzugter Header
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Alternativer Header (CLI-Komfort)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Live-Endpunkte und Funktionen

Die folgenden Endpunkte und Integrationsmuster sind heute in Produktion. Alles hier Aufgeführte ist real und mit einem gültigen API-Schlüssel aufrufbar.

GET /usage

Sitzplatznutzung für Ihr Partnerkonto. Scope: metrics:read (immer gewährt). Siehe vollständige Referenz unten.

GET /properties

Objekte Ihrer gesponserten Hosts auflisten. Scope: marcus:read. Siehe vollständige Referenz unten.

GET /properties/{propertyId}/pricing-signals

Marcus-Preissignale und bevorstehende Auslastung für ein gesponsertes Objekt. Scope: marcus:read. Siehe vollständige Referenz unten.

LINK Deep-Link zur Partner-Aktivierung

HMAC-signierte URL, die ein gesponsertes Host-Konto bereitstellt. Als Schaltfläche in Ihre Oberfläche eingebettet. Siehe vollständige Referenz unten.

GET /usage — Sitzplatznutzung

Gibt die aktive Sitzplatzanzahl des authentifizierten Partners mit einer Aufschlüsselung pro Host zurück. Nützlich zum Abgleich der Abrechnung oder zum Aufbau eines Nutzungs-Dashboards in Ihrer Plattform.

Erforderlicher Scope

metrics:read — wird stets allen Partnerschlüsseln gewährt.

IDOR-Schutz

Dieser Endpunkt gibt ausschließlich Daten für den authentifizierten Partner zurück. Er akzeptiert niemals einen partner_id-Abfrageparameter — die Identität ergibt sich vollständig aus Ihrem API-Schlüssel.

PII-Minimierung

Die Aufschlüsselung verwendet undurchsichtige Host-Benutzer-IDs und Sitzplatzanzahlen. Host-E-Mail-Adressen werden bewusst ausgeschlossen.

Anfrage
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Antwort
{
  "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 — Gesponserte Objekte auflisten

Gibt alle Objekte der Hosts zurück, die Ihr Partnerkonto sponsert. Damit ermitteln Sie, welche Objekte Sie auf Preissignale abfragen können.

Erforderlicher Scope

marcus:read — gewährt, wenn Ihre Partnervereinbarung die Datenebene des Marcus Revenue Manager umfasst.

Zurückgegebene Daten

Jeder Eintrag enthält die interne Objekt-id (erforderlich für den Preissignal-Endpunkt) und den Objekt-name. Über den Objektnamen hinausgehende Host-PII werden ausgeschlossen.

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

Gibt Marcus-Preissignale und die bevorstehende Auslastung für ein einzelnes gesponsertes Objekt zurück. Verwenden Sie die von GET /properties zurückgegebenen Objekt-id-Werte. Ein 404 wird zurückgegeben, wenn das Objekt nicht gefunden wird oder nicht zu Ihrem Partnerkonto gehört.

Erforderlicher Scope

marcus:read

Abfrageparameter

lookback_days (Integer, Standard 90) — Zeitfenster der Reservierungshistorie, das zur Berechnung der Signale verwendet wird.

Hinweis zur Antwortstruktur

Das signals-Objekt enthält Preisindikatoren und Reservierungsstatistiken. Der genaue Feldsatz kann sich weiterentwickeln, wenn Marcus neue Datenquellen hinzufügt. Das repräsentative Beispiel unten zeigt die zum Start verfügbaren Felder — behandeln Sie unbekannte Felder als additiv.

Anfrage
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Repräsentative Antwort (Felder können sich weiterentwickeln)
{
  "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
  }
}

Demnächst

Die folgenden Funktionen sind geplant oder in Entwicklung. Sie sind hier aus Gründen der Transparenz aufgeführt, damit Sie Ihre Integrations-Roadmap planen können. Keine davon ist heute aufrufbar — eine Entwicklung dagegen führt jetzt zu Fehlern.

ROADMAP Self-Service-Token-Minting durch Partner

Ein API-Endpunkt oder herunterladbares SDK-Snippet, mit dem Ihr Backend signierte Aktivierungs-Tokens erzeugen kann, ohne Host Logic einzubeziehen. Heute werden Tokens auf Anfrage über ein Admin-Werkzeug erzeugt.

ROADMAP Write-Scopes & mutierende Endpunkte

Scopes wie marcus:write und pierre:write sowie REST-Endpunkte zum Registrieren von Objekten (POST /properties), zum Aktivieren oder Deaktivieren einzelner Einheiten und zum Aktualisieren von Partnereinstellungen.

ROADMAP Webhooks / Echtzeit-Events

Push-Benachrichtigungen bei abgeschlossenem Onboarding, aktivierter/deaktivierter Einheit und Nutzungsschwellenwerten. Registrieren Sie eine Webhook-URL und erhalten Sie signierte Payloads.

ROADMAP Self-Service-Portal für Partner

Ein flag-gesteuertes Self-Service-Portal zum Verwalten von API-Schlüsseln, Einsehen der Sitzplatznutzung und Konfigurieren erlaubter Embed-Ursprünge. Derzeit in privater Beta.

PRIVATE BETA Pierre-Wartungs-Endpunkt

GET /properties/{propertyId}/operational-state — Wartungs- und Betriebszustand für ein gesponsertes Objekt. Gebaut, aber durch ein Feature-Flag deaktiviert; erfordert den Scope pierre:read. Für ausgewählte Partner auf Anfrage verfügbar.

ROADMAP Onboarding-iframe-Einbettung

Betten Sie den Laura-Konfigurationsassistenten als iframe in Ihre PMS-Oberfläche ein, mit postMessage-Events für Schrittfortschritt und Abschluss. Abhängig vom Start des Self-Service-Portals für Partner.

ROADMAP Gehosteter MCP-Server für Enterprise

Ein gehosteter MCP-Endpunkt unter mcp.hostlogic.io, der Claude Desktop / Cursor Tool-Zugriff auf partnerspezifische Daten bietet. Architektur geplant; für Enterprise-Partner noch nicht live.

Möchten Sie frühen Zugang oder Einfluss auf die Roadmap-Prioritäten?

Enterprise-Partner haben einen dedizierten Slack-Kanal mit dem Host-Logic-Team. Melden Sie sich unter [email protected], um Ihre Integrationsanforderungen und Ihren Zeitplan zu besprechen.

Möchten Sie Host-Logic-Agenten auf Ihre Plattform bringen?

Erzählen Sie uns von Ihrem PMS, Channel Manager oder Hospitality-Software-Produkt. Wir prüfen Partneranträge innerhalb von 2 Werktagen und stellen Ihnen Ihren API-Schlüssel und einen dedizierten Support-Kanal bereit.

Sandbox-Umgebung inklusive
Integrationsunterstützung innerhalb von 24 Stunden
Dedizierter Slack-Kanal