Dokumentacja API

Infrastruktura AI
napędzająca nowoczesne platformy hotelarskie

API danych tylko do odczytu oraz deep link aktywacyjny partnera do integracji agentów AI Host Logic z Państwa PMS lub platformą do zarządzania obiektem. Ta strona dokumentuje wyłącznie to, co jest dziś dostępne — wyraźnie oznaczona sekcja Roadmap obejmuje to, co pojawi się w kolejnym etapie.

Trzy kroki do uruchomienia

Pobierz klucz API → odczytuj wykorzystanie miejsc i sygnały cenowe → osadź link aktywacyjny hosta w swoim interfejsie. To pełny proces integracji dostępny już dziś.

Step 1 Pobierz klucz API

Zostań partnerem. Po zatwierdzeniu Host Logic tworzy Państwa konto partnerskie i wysyła jednorazowy link do ujawnienia, zawierający klucz API hlk_. Proszę przechowywać go bezpiecznie — po ujawnieniu nie można go wyświetlić ponownie.

Step 2 Odczytuj użycie i sygnały cenowe

Wywołaj GET /partner-api/v1/usage, aby monitorować wykorzystanie miejsc, oraz GET /partner-api/v1/properties/{id}/pricing-signals, aby wyświetlać dane cenowe Marcus w swojej platformie.

Step 3 Osadź link aktywacyjny

Dodaj w swoim interfejsie przycisk, który otwiera podpisany HMAC deep link https://hostlogic.io/partner/{slug}/activate?token=…. Host wybiera produkty, jego konto Host Logic zostaje skonfigurowane, a Laura jest gotowa.

GET /partner-api/v1/usage Sprawdź, czy klucz działa
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_your_key_here" \
  -H "Accept: application/json"

# 200 OK — klucz jest prawidłowy, odpowiedź zawiera wykorzystanie miejsc
# 401 Unauthorized — brak klucza lub jest on nieprawidłowy
# 403 Forbidden — klucz jest prawidłowy, ale brakuje wymaganego zakresu
# 429 Too Many Requests — limit zapytań (120 żądań/min)

Uwierzytelnianie kluczem API

Wszystkie żądania API wymagają tokenu Bearer w nagłówku Authorization. Klucz API otrzymują Państwo po zatwierdzeniu partnera za pośrednictwem jednorazowego linku do ujawnienia — jawny klucz nigdy nie jest przechowywany po stronie serwera i nie można go ponownie wyświetlić.

Klucze API mają prefiks hlk_, są przypisane do Państwa konta partnerskiego i można je rotować bez przestojów. Każdy klucz ma zestaw zakresów, które określają, do których endpointów może się odwoływać. Pierwsze 12 znaków każdego klucza (prefiks klucza) są przechowywane w postaci jawnej do identyfikacji w logach — reszta jest haszowana.

Adresy bazowe https://api.hostlogic.io/partner-api/v1

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

Limit zapytań

120 żądań/minutę na klucz API. Po przekroczeniu zwracany jest kod 429 Too Many Requests.

Zakresy

metrics:read — zawsze przyznawany; obejmuje endpoint usage.
marcus:read — przyznawany, gdy umowa partnerska obejmuje dane Marcus (Revenue Manager); obejmuje endpointy properties i pricing-signals.

Kody błędów

KodZnaczenie
401Brak klucza API lub jest on nieprawidłowy
403Klucz jest prawidłowy, ale brakuje wymaganego zakresu dla tego endpointu
404Zasób nie został znaleziony lub nie należy do konta Państwa partnera
429Przekroczono limit żądań — 120 żądań/min
Każde żądanie — preferowany nagłówek
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Alternatywny nagłówek (wygodne w CLI)
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "X-Enterprise-Key: hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"

Działające endpointy i funkcje

Poniższe endpointy i wzorce integracji są już dostępne w środowisku produkcyjnym. Wszystko wymienione poniżej jest rzeczywiste i można to wywołać przy użyciu prawidłowego klucza API.

GET /usage

Wykorzystanie miejsc dla konta Państwa partnera. Zakres: metrics:read (zawsze przyznawany). Zobacz pełną dokumentację poniżej.

GET /properties

Lista obiektów należących do hostów objętych sponsoringiem przez Państwa partnera. Zakres: marcus:read. Zobacz pełną dokumentację poniżej.

GET /properties/{propertyId}/pricing-signals

Sygnały cenowe Marcus i nadchodzące obłożenie dla obiektu objętego sponsoringiem. Zakres: marcus:read. Zobacz pełną dokumentację poniżej.

LINK Deep link aktywacyjny dla partnera

Adres URL podpisany HMAC, który tworzy konto hosta objętego sponsoringiem. Osadzany w Państwa interfejsie jako przycisk. Zobacz pełną dokumentację poniżej.

GET /usage — wykorzystanie miejsc

Zwraca liczbę aktywnych miejsc zalogowanego partnera z podziałem na poszczególnych hostów. Przydatne do uzgadniania rozliczeń lub budowy panelu wykorzystania w Państwa platformie.

Wymagany zakres

metrics:read — zawsze przyznawany wszystkim kluczom partnera.

Ochrona przed IDOR

Ten endpoint zwraca dane wyłącznie dla uwierzytelnionego partnera. Nigdy nie akceptuje parametru zapytania partner_id — tożsamość wynika wyłącznie z Państwa klucza API.

Minimalizacja danych osobowych

Podział wykorzystuje niejawne identyfikatory użytkowników hostów oraz liczbę miejsc. Adresy e-mail hostów są celowo wykluczone.

Żądanie
curl https://api.hostlogic.io/partner-api/v1/usage \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Odpowiedź
{
  "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 sponsorowanych obiektów

Zwraca wszystkie obiekty należące do hostów sponsorowanych przez Państwa konto partnera. Użyj tego, aby sprawdzić, dla których obiektów mogą Państwo pobierać sygnały cenowe.

Wymagany zakres

marcus:read — przyznawany, gdy umowa partnerska obejmuje warstwę danych Marcus Revenue Manager.

Zwracane dane

Każdy wpis zawiera wewnętrzny identyfikator obiektu id (wymagany przez endpoint pricing-signals) oraz nazwę obiektu name. Dane osobowe hosta poza nazwą obiektu są wykluczone.

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

Zwraca sygnały cenowe Marcus oraz nadchodzące obłożenie dla jednego sponsorowanego obiektu. Użyj wartości id obiektu zwróconych przez GET /properties. Jeśli obiekt nie zostanie znaleziony lub nie należy do konta Państwa partnera, zwracany jest kod 404.

Wymagany zakres

marcus:read

Parametr zapytania

lookback_days (liczba całkowita, domyślnie 90) — okno historii rezerwacji używane do obliczania sygnałów.

Uwaga dotycząca struktury odpowiedzi

Obiekt signals zawiera wskaźniki cenowe oraz statystyki rezerwacji. Dokładny zestaw pól może się zmieniać wraz z dodawaniem przez Marcus nowych źródeł danych. Poniższy przykładowy zestaw pokazuje pola dostępne przy uruchomieniu — wszelkie nierozpoznane pola należy traktować jako dodatkowe.

Żądanie
curl "https://api.hostlogic.io/partner-api/v1/properties/12/pricing-signals?lookback_days=90" \
  -H "Authorization: Bearer hlk_a8f3c2e1b4d5..." \
  -H "Accept: application/json"
Przykładowa odpowiedź (pola mogą ulec zmianie)
{
  "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
  }
}

Wkrótce dostępne

Poniższe funkcje są planowane lub w trakcie tworzenia. Zostały tu wymienione dla przejrzystości, aby mogli Państwo zaplanować integrację. Żadna z nich nie jest obecnie dostępna do wywołania — budowanie integracji w oparciu o nie spowoduje błędy.

ROADMAP Samoobsługowe generowanie tokenów przez partnera

Punkt końcowy API lub fragment SDK do pobrania, który pozwoli Państwa backendowi generować podpisane tokeny aktywacyjne bez udziału Host Logic. Obecnie tokeny są generowane na żądanie za pomocą narzędzia administracyjnego.

ROADMAP Zakresy zapisu i endpointy modyfikujące

Zakresy takie jak marcus:write i pierre:write oraz endpointy REST do rejestrowania obiektów (POST /properties), aktywowania lub dezaktywowania pojedynczych jednostek i aktualizowania ustawień partnera.

ROADMAP Webhooki / zdarzenia w czasie rzeczywistym

Powiadomienia push o zakończonym onboardingu, aktywacji/dezaktywacji jednostki oraz progach użycia. Zarejestruj adres URL webhooka i odbieraj podpisane ładunki.

ROADMAP Portal samoobsługowy partnera

Portal samoobsługowy z flagą funkcji do zarządzania kluczami API, podglądu wykorzystania miejsc i konfiguracji dozwolonych źródeł osadzania. Obecnie w prywatnej becie.

PRIVATE BETA Punkt końcowy konserwacji Pierre

GET /properties/{propertyId}/operational-state — stan konserwacji i stan operacyjny dla obiektu sponsorowanego. Zbudowany, ale wyłączony flagą funkcji; wymaga zakresu pierre:read. Dostępny dla wybranych partnerów na życzenie.

ROADMAP Osadzanie onboardingu w iframe

Osadź kreator konfiguracji Laura jako iframe w interfejsie PMS, z wydarzeniami postMessage dotyczącymi postępu kroków i zakończenia. Zależne od uruchomienia portalu samoobsługowego dla partnerów.

ROADMAP Hostowany serwer MCP dla enterprise

Hostowany punkt końcowy MCP pod adresem mcp.hostlogic.io, zapewniający dostęp narzędzi Claude Desktop / Cursor do danych w zakresie partnera. Architektura jest planowana; dla partnerów enterprise nie jest jeszcze uruchomiony.

Chcą Państwo uzyskać wcześniejszy dostęp lub wpłynąć na priorytety roadmapy?

Partnerzy enterprise mają dedykowany kanał Slack z zespołem Host Logic. Prosimy o kontakt pod adresem [email protected], aby omówić wymagania integracyjne i harmonogram.

Chcą Państwo wprowadzić agentów Host Logic na swoją platformę?

Prosimy opowiedzieć nam o swoim PMS, channel managerze lub produkcie z obszaru oprogramowania hotelarskiego. Wnioski partnerskie analizujemy w ciągu 2 dni roboczych i zapewniamy klucz API oraz dedykowany kanał wsparcia.

Środowisko sandbox w cenie
Wsparcie integracyjne w ciągu 24 godzin
Dedykowany kanał Slack