Основные понятия
Обновлено: 2026-06-25 00:15 MSK
Базовые сущности и термины, на которых строится интеграция.
Ресторан
Центральная сущность. Почти все эндпоинты адресуются по числовому restaurantId: /api/.../restaurants/{restaurantId}/.... Один доступ (учётная запись) может иметь права на несколько ресторанов — их список и id возвращает GET /api/core/admin/account/me.
Профиль ресторана (часы работы, контакты, настройки) — см. Информация о ресторане.
Бронирование (reservation / booking)
Запись о визите гостя: дата-время, размер компании (groupSize), гость, стол, статус. Жизненный цикл: создаётся → подтверждается → гость садится → визит завершается (или отменяется/неявка).
| Понятие | Описание |
|---|---|
reservationTime | Дата и время визита (локальное время ресторана) |
groupSize | Количество гостей |
tableNumber | Назначенный стол (может назначаться автоматически) |
source | Источник брони (например, ваше приложение/виджет) |
state / статус | Текущее состояние брони |
additionals | Признаки и пожелания (VIP, детский стул, аллергия и т.п.) |
Подробно — Бронирования: создание и управление.
Доступность (availability)
Расчёт свободных слотов и столов на дату для заданного размера компании. Может считаться двумя способами: как для онлайн-гостя (AsOnlineGuest=true, ограниченные слоты) или полная хостовая доступность. См. Доступность столов.
Заявка на бронь (request reservation)
Бронь, требующая подтверждения хостом: создаётся как заявка, затем подтверждается (approve) или отклоняется. Полезно, когда ресторан хочет модерировать брони из внешних каналов. См. Запросы на бронь.
Гость (guest)
У гостя есть профиль (customerProfile): контакты, пожелания (аллергия, вегетарианство, VIP), адрес доставки, история визитов. Поиск и создание — Гостевая книга.
| Понятие | Описание |
|---|---|
memberId | Идентификатор гостя (string) |
customerProfile | Профиль гостя (пожелания, контакты, адрес) |
guestTags | Теги гостя |
Столы и залы (tables / areas)
Ресторан разбит на залы/зоны (areas) и столы. План зала и статусы столов — Столы и залы. Зоны можно указывать при расчёте доступности (Areas).
Меню, продукты, заказы
Меню состоит из секций и продуктов; у продуктов есть модификаторы и налоги. Заказ (order) может прикрепляться к брони. См. Меню: каталог и связанные разделы.
Типы токенов
Поведение части эндпоинтов зависит от типа токена — Hostme, Partner, Vendor. Например, под токеном Vendor записи создаются «от имени внешнего приложения» с автоматической простановкой VendorAppId. Подробно — Аутентификация.
Партнёрское приложение (appId)
Внешнее приложение, зарегистрированное в Hostme, имеет идентификатор appId. По нему можно получить брони, созданные этим приложением: GET /api/rsv/partner/{appId}/reservations. См. Партнёрские брони и Регистрация приложения.
Время и часовые пояса
Время бронирований — в локальном часовом поясе ресторана (restaurants[].timeZone из /me). Формат — ISO 8601. Подробнее — Соглашения.