Documentazione API

L'infrastruttura AI
che alimenta le moderne piattaforme per l'ospitalità

API dati in sola lettura e deep-link di attivazione partner per integrare gli agenti AI di Host Logic nel Suo PMS o nella Sua piattaforma di property management. Questa pagina documenta solo ciò che è attivo oggi — una sezione Roadmap chiaramente etichettata copre ciò che arriverà in seguito.

Tre passaggi per andare live

Ottenga la Sua API key → legga l'utilizzo dei posti e i segnali di pricing → incorpori il link di attivazione dell'host nella Sua UI. Questo è l'intero flusso di integrazione disponibile oggi.

Step 1 Ottieni la Sua API key

Diventi partner. Una volta approvato, Host Logic crea il Suo account partner e Le invia un link di rivelazione monouso contenente la Sua API key hlk_. La conservi in modo sicuro — non potrà essere visualizzata di nuovo dopo la rivelazione.

Step 2 Leggi utilizzo & segnali di pricing

Chiama GET /partner-api/v1/usage per monitorare il consumo dei posti e GET /partner-api/v1/properties/{id}/pricing-signals per mostrare i dati di pricing Marcus all'interno della Sua piattaforma.

Step 3 Incorpora il link di attivazione

Aggiunga un pulsante nella Sua UI che apra il deep-link firmato HMAC https://hostlogic.io/partner/{slug}/activate?token=…. L'host seleziona i prodotti, il suo account Host Logic viene provisionato e Laura è pronta.

GET /partner-api/v1/usage Verifichi che la Sua chiave funzioni
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — la chiave è valida, la risposta contiene l'utilizzo dei Suoi posti
# 401 Unauthorized — chiave mancante o non valida
# 403 Forbidden — chiave valida ma scope richiesto mancante
# 429 Too Many Requests — limite di richieste superato (120 req/min)

Autenticazione con API key

Tutte le richieste API richiedono un Bearer token nell'header Authorization. Ricevi la Sua API key dopo l'approvazione come partner tramite un link di rivelazione monouso — la chiave in chiaro non viene mai memorizzata lato server e non può essere mostrata di nuovo.

Le API key hanno il prefisso hlk_, sono associate al Suo account partner e possono essere ruotate senza interruzioni. Ogni chiave include un insieme di scope che determina quali endpoint può chiamare. I primi 12 caratteri di ogni chiave (il prefisso della chiave) vengono memorizzati in chiaro per l'identificazione nei log — il resto è sottoposto a hash.

URL base https://api.hostlogic.io/partner-api/v1

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

Limite di richieste

120 richieste/minuto per API key. Il superamento restituisce 429 Too Many Requests.

Scope

metrics:read — sempre concesso; copre l'endpoint usage.
marcus:read — concesso quando il Suo accordo partner include i dati Marcus (Revenue Manager); copre gli endpoint properties e pricing-signals.

Codici di errore

CodiceSignificato
401API key mancante o non valida
403Chiave valida, ma scope richiesto per questo endpoint mancante
404Risorsa non trovata, oppure non di proprietà del Suo account partner
429Limite di richieste superato — 120 req/min
Ogni richiesta — intestazione preferita
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Intestazione alternativa (comoda da CLI)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Endpoint e funzionalità live

I seguenti endpoint e pattern di integrazione sono già in produzione. Tutto ciò che è elencato qui è reale e richiamabile con una chiave API valida.

GET /usage

Utilizzo posti per il Suo account partner. Scope: metrics:read (sempre concesso). Vedi riferimento completo qui sotto.

GET /properties

Elenca le strutture appartenenti ai Suoi host sponsorizzati. Scope: marcus:read. Vedi riferimento completo qui sotto.

GET /properties/{propertyId}/pricing-signals

Segnali di pricing di Marcus e occupazione imminente per una struttura sponsorizzata. Scope: marcus:read. Vedi riferimento completo qui sotto.

LINK Deep link di attivazione partner

URL firmato con HMAC che provisiona un account host sponsorizzato. Da incorporare nella Sua UI come pulsante. Vedi riferimento completo qui sotto.

GET /usage — Utilizzo posti

Restituisce il numero di posti attivi del partner autenticato con una ripartizione per host. Utile per riconciliare la fatturazione o creare una dashboard di utilizzo all'interno della Sua piattaforma.

Scope richiesto

metrics:read — sempre concesso a tutte le chiavi partner.

Protezione IDOR

Questo endpoint restituisce solo i dati del partner autenticato. Non accetta mai un parametro di query partner_id — l'identità deriva interamente dalla Sua chiave API.

Minimizzazione PII

La ripartizione utilizza ID utente host opachi e conteggi dei posti. Le email degli host sono volutamente escluse.

Richiesta
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Risposta
{
  "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 — Elenca le strutture sponsorizzate

Restituisce tutte le strutture appartenenti agli host sponsorizzati dal Suo account partner. Usalo per scoprire quali strutture può interrogare per i segnali di pricing.

Scope richiesto

marcus:read — concesso quando il Suo accordo partner include il data plane di Marcus Revenue Manager.

Dati restituiti

Ogni voce contiene l'id interno della struttura (necessario per l'endpoint pricing-signals) e il name della struttura. Sono esclusi i dati PII dell'host oltre al nome della struttura.

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

Restituisce i segnali di pricing di Marcus e l'occupazione imminente per una singola struttura sponsorizzata. Usi i valori id della struttura restituiti da GET /properties. Viene restituito un 404 se la struttura non viene trovata o non è di proprietà del Suo account partner.

Scope richiesto

marcus:read

Parametro di query

lookback_days (intero, predefinito 90) — finestra della cronologia delle prenotazioni usata per calcolare i segnali.

Nota sulla struttura della risposta

L'oggetto signals contiene indicatori di pricing e statistiche sulle prenotazioni. Il set esatto di campi può evolvere man mano che Marcus aggiunge nuove fonti dati. L'esempio rappresentativo qui sotto mostra i campi disponibili al lancio — considera eventuali campi non riconosciuti come aggiuntivi.

Richiesta
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Risposta rappresentativa (i campi possono evolvere)
{
  "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
  }
}

In arrivo

Le funzionalità seguenti sono pianificate o in sviluppo. Sono elencate qui per trasparenza, così può pianificare la Sua roadmap di integrazione. Nessuna di queste è chiamabile oggi — sviluppare ora su queste funzionalità genererà errori.

ROADMAP Generazione self-service dei token da parte del partner

Un endpoint API o uno snippet SDK scaricabile che consente al Suo backend di generare token di attivazione firmati senza coinvolgere Host Logic. Oggi i token vengono generati su richiesta tramite uno strumento amministrativo.

ROADMAP Scope di scrittura & endpoint mutativi

Scope come marcus:write e pierre:write ed endpoint REST per registrare le strutture (POST /properties), attivare o disattivare singole unità e aggiornare le impostazioni del partner.

ROADMAP Webhook / eventi in tempo reale

Notifiche push per onboarding completato, unità attivata/disattivata e soglie di utilizzo. Registra un URL webhook e ricevi payload firmati.

ROADMAP Portale self-service per partner

Un portale self-service protetto da flag per gestire le API key, visualizzare l'utilizzo dei posti e configurare gli origin consentiti per l'embedding. Attualmente in beta privata.

PRIVATE BETA Endpoint di manutenzione di Pierre

GET /properties/{propertyId}/operational-state — stato di manutenzione e operativo per una struttura sponsorizzata. Realizzato ma disabilitato tramite un feature flag; richiede lo scope pierre:read. Disponibile per partner selezionati su richiesta.

ROADMAP Integrazione iframe per l'onboarding

Incorpora il wizard di configurazione di Laura come iframe nella UI del Suo PMS, con eventi postMessage per l'avanzamento dei passaggi e il completamento. Dipende dal lancio del portale self-service per i partner.

ROADMAP Server MCP ospitato per enterprise

Un endpoint MCP ospitato su mcp.hostlogic.io che fornisce accesso agli strumenti di Claude Desktop / Cursor ai dati con scope partner. Architettura pianificata; non ancora attivo per i partner enterprise.

Vuoi accesso anticipato o contribuire alle priorità della roadmap?

I partner enterprise hanno un canale Slack dedicato con il team di Host Logic. Contattaci all'indirizzo [email protected] per discutere i requisiti di integrazione e le tempistiche.

Vuole portare gli agenti Host Logic sulla Sua piattaforma?

Raccontaci del Suo PMS, channel manager o prodotto software per l'hospitality. Valutiamo le richieste dei partner entro 2 giorni lavorativi e forniamo la Sua API key e un canale di supporto dedicato.

Ambiente sandbox incluso
Supporto all'integrazione entro 24 ore
Canale Slack dedicato