Введение
Обновлено: 2026-06-25 00:15 MSK
Hostme API — это REST API платформы управления рестораном Hostme. С его помощью партнёры и сторонние сервисы (POS, CRM, виджеты бронирования, маркетплейсы, телефония) интегрируются с рестораном: создают и читают бронирования, проверяют доступность столов, работают с гостями, синхронизируют меню и заказы.
Документация написана на основе реальной спецификации Hostme API v1 (Swagger UI). Все пути, имена полей и типы данных взяты напрямую из спецификации.
Для кого эта документация
- Интеграторы бронирований — внешние виджеты, маркетплейсы, агрегаторы, телефонные сервисы, которым нужно создавать и синхронизировать брони.
- POS / CRM системы — которым нужно обмениваться гостями, заказами и инвентарём.
- Партнёрские приложения — встроенные сервисы, работающие от имени ресторана.
Базовый формат
| Свойство | Значение |
|---|---|
| Протокол | HTTPS |
| Формат | JSON (application/json) |
| Кодировка | UTF-8 |
| Аутентификация | OAuth2, Bearer-токен в заголовке Authorization |
| Базовый URL (прод) | https://api.hostmeapp.com |
| Версия | v1 |
Спецификация не содержит блока
servers— базовый URL совпадает с хостом, на котором размещён Swagger:https://api.hostmeapp.com. Тестовое окружение —https://api-qa.hostmeapp.com.
Структура путей
Эндпоинты сгруппированы по подсистемам платформы. Префикс пути указывает на подсистему:
| Префикс | Подсистема |
|---|---|
/api/core/... | Аккаунты, рестораны, базовые сущности |
/api/rsv/... | Бронирования, доступность, заявки |
/api/loyalty/... | Гости (гостевая книга, профили) |
/api/tm/... | Столы и управление залом (table management) |
/api/pos/... | Интеграция с POS / вендорскими приложениями |
Почти все «ресторанные» эндпоинты адресуются по числовому идентификатору ресторана: /api/.../restaurants/{restaurantId}/.... Подробнее — в разделе Основные понятия.
С чего начать
- Прочитайте Окружения и доступы — где боевой и тестовый контуры, как получить учётные данные.
- Настройте Аутентификацию — получите Bearer-токен.
- Пройдите Быстрый старт — сквозной пример «токен → доступность → бронь».
- Дальше — по разделам: Бронирования, Гости, Меню.
Статус документации
Это живая документация. Покрытие в первой версии — партнёрский слой Hostme API: бронирования, доступность, гости, меню и заказы, лист ожидания, столы, события, платежи. Внутренние и служебные эндпоинты (вебхуки мессенджеров, AI-агент, тестовые контроллеры) в неё не входят.
Chat API — отдельный сервис. Приём/отправка сообщений (входящие, статусы доставки, каналы уведомлений) вынесены в отдельный Chat API на другом хосте и в эту документацию не входят. Для уведомлений гостям из событий брони см. раздел Сообщения и уведомления.