GuestFlow - AI Guest Assistant

API и Webhooks

Интегрирайте GuestFlow с PMS, booking инструменти или собствен backend.

REST API-то позволява на Business акаунти да управляват имоти, knowledge base и chat сесии. Webhooks уведомяват вашия сървър при промени.

API ключове и webhooks изискват активен Business абонамент.

Отвори API таблото

Автентикация

Създайте API ключ в Табло → API & Webhooks и го изпращайте като Bearer token.

Authorization: Bearer YOUR_API_KEY

Лимит: 120 заявки/минута на ключ.

Base URL: https://www.guestflow.in.net/api/v1

Бърз старт

curl -s "https://www.guestflow.in.net/api/v1/properties" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-GuestFlow-Locale: en"

Endpoints

GEThttps://www.guestflow.in.net/api/v1/properties

List all properties for your account.

GEThttps://www.guestflow.in.net/api/v1/properties/{id}

Get property details including photos.

PATCHhttps://www.guestflow.in.net/api/v1/properties/{id}

Update name, description, isActive, website, whatsapp, email, or phone.

{
  "name": "Villa Serenity",
  "isActive": true,
  "website": "https://example.com"
}
GEThttps://www.guestflow.in.net/api/v1/properties/{id}/knowledge

List knowledge base items.

POSThttps://www.guestflow.in.net/api/v1/properties/{id}/knowledge

Add a knowledge item. Types: PDF, DOCX, TEXT, IMAGE. TEXT requires content.

{
  "title": "House Manual",
  "type": "TEXT",
  "content": "Check-in is after 3pm…"
}
DELETEhttps://www.guestflow.in.net/api/v1/properties/{id}/knowledge/{itemId}

Delete a knowledge item.

GEThttps://www.guestflow.in.net/api/v1/properties/{id}/sessions?limit=50&offset=0

List chat sessions with recent messages. Returns sessions, total, limit, offset.

Изходящи webhooks

Регистрирайте HTTPS endpoint. Изпращаме POST JSON при абонирани събития — включително от dashboard и API.

  • property.updated
  • knowledge.created
  • chat.session.created
{
  "event": "property.updated",
  "timestamp": "2026-07-15T00:00:00.000Z",
  "data": { "propertyId": "…", "slug": "villa-serenity" }
}

Проверка на подписи

Header X-GuestFlow-Signature: t=<unix>,v1=<hex>. Преизчислете HMAC-SHA256 върху "{t}.{rawBody}" със signing secret.

X-GuestFlow-Signature: t=1710000000,v1=<hmac_hex>

Грешки

Отговорите съдържат error и опционално code. 401, 403, 404, 429. Опционално X-GuestFlow-Locale.

Виж цените за Business

← Назад към началото

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