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

AI инфраструктурата
задвижваща модерните платформи за хотелиерство

API за данни само за четене и deep-link за активиране от партньора за интегриране на AI агентите на Host Logic във Вашата PMS или платформа за управление на имоти. Тази страница документира само това, което е налично днес — ясно обозначен раздел Roadmap описва какво предстои.

Три стъпки до пускане в действие

Вземете Вашия API ключ → прочетете използването на места и ценовите сигнали → вградете линка за активиране на хоста във Вашия UI. Това е пълният интеграционен цикъл, наличен днес.

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 Вградете линка за активиране

Добавете бутон във Вашия UI, който отваря 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 — ключът е валиден, но липсва изискван scope
# 429 Too Many Requests — ограничение на заявките (120 заявки/мин)

Удостоверяване с API ключ

Всички API заявки изискват Bearer token в заглавката Authorization. Получавате Вашия API ключ след одобрение за партньор чрез еднократен линк за разкриване — обикновеният ключ никога не се съхранява на сървъра и не може да бъде показан повторно.

API ключовете започват с hlk_, обвързани са с Вашия партньорски акаунт и могат да бъдат ротиранe без прекъсване на услугата. Всеки ключ има набор от scopes, които определят кои крайни точки може да извиква. Първите 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.

Scopes

metrics:read — винаги предоставен; обхваща крайната точка за използване.
marcus:read — предоставя се, когато Вашето партньорско споразумение включва данни на Marcus (Revenue Manager); обхваща крайните точки properties и pricing-signals.

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

КодЗначение
401Липсващ или невалиден API ключ
403Ключът е валиден, но липсва необходимият scope за тази крайна точка
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 ключ.

Минимизиране на лични данни

Разбивката използва непрозрачни потребителски 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 на имота (необходим за крайната точка за ценови сигнали) и name на имота. Лични данни на домакина извън името на имота са изключени.

Заявка
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 да генерира подписани activation токени без участието на Host Logic. Днес токените се генерират при поискване чрез административен инструмент.

ROADMAP Write scopes & mutating endpoints

Scopes като marcus:write и pierre:write и REST endpoints за регистриране на имоти (POST /properties), активиране или деактивиране на отделни единици и актуализиране на партньорски настройки.

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

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

ROADMAP Партньорски self-service портал

Self-service портал с флагове за управление на API ключове, преглед на използването на seat-ове и конфигуриране на разрешени embed origins. В момента е в private beta.

PRIVATE BETA Крайната точка за поддръжка на Pierre

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

ROADMAP Вграждане на onboarding iframe

Вградете съветника за конфигуриране на Laura като iframe във Вашия PMS интерфейс, с postMessage събития за напредъка по стъпките и завършването. Зависи от старта на self-service портала за партньори.

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

Хоствана MCP крайна точка на mcp.hostlogic.io, която осигурява достъп от Claude Desktop / Cursor до данни, обхванати от партньорския обхват. Архитектурата е планирана; все още не е активна за enterprise партньори.

Искате ранен достъп или да дадете мнение за приоритетите в пътната карта?

Enterprise партньорите имат отделен Slack канал с екипа на Host Logic. Свържете се с нас на [email protected], за да обсъдим Вашите изисквания за интеграция и времеви график.

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

Разкажете ни за Вашия PMS, channel manager или софтуерен продукт за хотелиерството. Преглеждаме партньорските заявки в рамките на 2 работни дни и предоставяме Вашия API ключ и отделен канал за поддръжка.

Включена sandbox среда
Поддръжка за интеграция до 24 часа
Отделен Slack канал