API документација

AI инфраструктурата
што ги напојува современите платформи за угостителство

API за податоци само за читање и deep-link за активација на партнерот за интегрирање на AI агентите на Host Logic во Вашиот PMS или платформа за управување со објекти. Оваа страница документира само она што е live денес — јасно означен дел Roadmap ги опфаќа следните чекори.

Три чекори до пуштање во работа

Земете го Вашиот API клуч → прочитајте го користењето на седишта и ценовните сигнали → вградете го линкот за активација на домаќинот во Вашиот интерфејс. Тоа е целиот интеграциски тек што е достапен денес.

Step 1 Земете го Вашиот API клуч

Станете партнер. Откако ќе бидете одобрени, Host Logic ќе Ви отвори партнерска сметка и ќе Ви испрати еднократен линк за откривање што го содржи Вашиот hlk_ API клуч. Чувајте го безбедно — по откривањето не може повторно да се прикаже.

Step 2 Прочитајте користење & ценовни сигнали

Повикајте GET /partner-api/v1/usage за да го следите користењето на седишта, и GET /partner-api/v1/properties/{id}/pricing-signals за да ги прикажете ценовните податоци на Marcus во Вашата платформа.

Step 3 Вградете го линкот за активација

Додајте копче во Вашиот интерфејс што го отвора HMAC-потпишаниот deep-link https://hostlogic.io/partner/{slug}/activate?token=…. Домаќинот ги избира производите, неговата Host Logic сметка се конфигурира, а Laura е подготвена.

GET /partner-api/v1/usage Проверете дали Вашиот клуч работи
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — клучот е валиден, одговорот го содржи Вашето користење на седишта
# 401 Unauthorized — клучот недостасува или е неважечки
# 403 Forbidden — клучот е валиден, но недостасува потребниот опсег
# 429 Too Many Requests — ограничување на брзината (120 барања/мин)

Автентикација со API клуч

Сите API барања бараат Bearer токен во заглавието Authorization. Вашиот API клуч го добивате по одобрување на партнерството преку еднократен линк за откривање — обичниот клуч никогаш не се чува на серверската страна и не може повторно да се прикаже.

API клучевите имаат префикс hlk_, се поврзани со Вашата партнерска сметка и може да се ротираат без прекин во работата. Секој клуч носи збир на опсези што одредуваат кои endpoint-и може да ги повикува. Првите 12 знаци од секој клуч (префиксот на клучот) се чуваат во обичен текст за идентификација во логови — остатокот е хеширан.

Основни URL-адреси https://api.hostlogic.io/partner-api/v1

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

Ограничување на брзина

120 барања/минута по API клуч. При надминување се враќа 429 Too Many Requests.

Опсези

metrics:read — секогаш доделен; го опфаќа endpoint-от за користење.
marcus:read — се доделува кога Вашиот партнерски договор вклучува податоци за Marcus (Revenue Manager); ги опфаќа endpoint-ите properties и pricing-signals.

Кодови за грешки

КодЗначење
401Недостасува или е неважечки API клуч
403Клучот е валиден, но недостасува потребниот опсег за овој endpoint
404Ресурсот не е пронајден или не е во сопственост на Вашата партнерска сметка
429Надминат е лимитот на барања — 120 барања/мин
Секое барање — препорачано заглавие
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Алтернативно заглавие (погодно за CLI)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Активни крајни точки и функции

Следните крајни точки и интеграциски модели се веќе во продукција. Сѐ што е наведено тука е реално и може да се повика со важечки API клуч.

GET /usage

Користење на места за Вашата партнерска сметка. Опсег: metrics:read (секогаш одобрен). Погледнете ја целосната референца подолу.

GET /properties

Листа на објекти што им припаѓаат на Вашите спонзорирани домаќини. Опсег: marcus:read. Погледнете ја целосната референца подолу.

GET /properties/{propertyId}/pricing-signals

Ценовни сигнали на Marcus и претстојна пополнетост за спонзиран објект. Опсег: marcus:read. Погледнете ја целосната референца подолу.

LINK Длабинска врска за активирање на партнер

URL со HMAC потпис што обезбедува сметка за спонзиран домаќин. Вградено во Вашиот интерфејс како копче. Погледнете ја целосната референца подолу.

GET /usage — Користење на места

Го враќа бројот на активни места на автентицираниот партнер, со преглед по домаќин. Корисно за усогласување на наплатата или за изработка на контролна табла за користење во Вашата платформа.

Потребен опсег

metrics:read — секогаш одобрен за сите партнерски клучеви.

Заштита од IDOR

Оваа крајна точка враќа податоци само за автентицираниот партнер. Никогаш не прифаќа параметар за пребарување partner_id — идентитетот целосно доаѓа од Вашиот API клуч.

Минимизирање на PII

Прегледот користи анонимни ID-а на корисници на домаќини и број на места. Е-поштите на домаќините намерно се исклучени.

Барање
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Одговор
{
  "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 — Листа на спонзорирани објекти

Ги враќа сите објекти што им припаѓаат на домаќините што ги спонзорира Вашата партнерска сметка. Користете го ова за да откриете за кои објекти можете да барате ценовни сигнали.

Потребен опсег

marcus:read — се одобрува кога Вашиот партнерски договор го вклучува data plane-от на Marcus Revenue Manager.

Вратени податоци

Секој запис го содржи внатрешниот id на објектот (потребен за крајната точка за pricing-signals) и name на објектот. PII на домаќинот, освен името на објектот, е исклучена.

Барање
curl https://api.hostlogic.io/partner-api/v1/properties \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Одговор
{
  "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

Ги враќа ценовните сигнали на Marcus и претстојната пополнетост за еден спонзиран објект. Користете ги вредностите на id на објектот вратени од GET /properties. Се враќа 404 ако објектот не е пронајден или не е во сопственост на Вашата партнерска сметка.

Потребен опсег

marcus:read

Параметар за пребарување

lookback_days (цел број, стандардно 90) — временски прозорец на историјата на резервации што се користи за пресметување на сигналите.

Забелешка за структурата на одговорот

Објектот signals содржи ценовни индикатори и статистика за резервации. Точниот сет на полиња може да се развива како што Marcus додава нови извори на податоци. Репрезентативниот пример подолу ги прикажува полињата достапни при лансирањето — сите непрепознаени полиња третирајте ги како дополнителни.

Барање
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Пример одговор (полињата може да се менуваат)
{
  "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
  }
}

Наскоро

Следните можности се планирани или се во развој. Тука се наведени за транспарентност, за да можете да го планирате вашиот интеграциски roadmap. Ниту една од нив денес не може да се повикува — ако градите врз нив сега, ќе добиете грешки.

ROADMAP Самостојно генерирање токени од страна на партнерот

API endpoint или преземлив SDK примерок што му овозможува на вашиот backend да генерира потпишани активациски токени без вклучување на Host Logic. Денес токените се генерираат по барање преку админ алатка.

ROADMAP Write-опсези и endpoint-и што менуваат податоци

Scopes како marcus:write и pierre:write и REST endpoints за регистрирање објекти (POST /properties), активирање или деактивирање на поединечни единици и ажурирање на партнерските поставки.

ROADMAP Webhooks / настани во реално време

Push известувања за завршено вклучување, активирана/деактивирана единица и прагови на користење. Регистрирајте webhook URL и примајте потпишани payload-и.

ROADMAP Самостоен партнерски портал

Самостоен портал со flag за управување со API клучеви, преглед на користење на места и конфигурирање на дозволени embed origins. Моментално во приватна бета.

PRIVATE BETA Ендпоинт за одржување Pierre

GET /properties/{propertyId}/operational-state — состојба на одржување и оперативна состојба за спонзорирана сместувачка единица. Изградено, но оневозможено со feature flag; бара pierre:read scope. Достапно за избрани партнери по барање.

ROADMAP Вградување на onboarding iframe

Вградете го конфигурацискиот wizard на Laura како iframe во вашиот PMS UI, со postMessage настани за напредокот низ чекорите и завршувањето. Зависи од лансирањето на self-service порталот за партнери.

ROADMAP Хостиран MCP сервер за enterprise

Хостиран MCP ендпоинт на mcp.hostlogic.io што обезбедува пристап од Claude Desktop / Cursor до податоци во рамки на партнерскиот опсег. Архитектурата е планирана; сѐ уште не е активна за enterprise партнери.

Сакате ран пристап или да дадете придонес за приоритетите на roadmap-от?

Enterprise партнерите имаат посебен Slack канал со тимот на Host Logic. Контактирајте нѐ на [email protected] за да ги разгледаме вашите интеграциски барања и временска рамка.

Сакате да ги донесете агентите на Host Logic на вашата платформа?

Кажете ни повеќе за вашиот PMS, channel manager или софтверски производ за угостителство. Ги разгледуваме партнерските апликации во рок од 2 работни дена и ви обезбедуваме API клуч и посебен канал за поддршка.

Вклучена sandbox средина
Поддршка за интеграција во рок од 24 часа
Посебен Slack канал