API Restoplace. Инструкция для разработчиков

Домен для запросов REST API: https://api.restoplace.cc/

Ключ можно передавать двумя способами:

Как заголовок: X-API-Key: abcdefgh123456789
В строке запроса: GET /reserves?api_key=abcdefgh123456789

Где взять ключ API в Restoplace

На главном экране сервиса app.restoplace.cc, перейдите в адрес заведения

Вы попадёте в книгу резервов адреса. Нажмите кнопку «Настройки» в правом верхнем углу.

В левом меню настроек адреса, раскройте пункт «Интеграции» и выберите подпункт «API Restoplace», нажмите «Обновить ключ api» и скопируйте ваш ключ API

Примеры ответов запросов

ОТВЕТ УДАЧНОГО ЗАПРОСА:


{
  "method": "reserves",
  "requestDate": 1641796526,
  "responseData": {},
  "page": 1,
  "totalPages": 1,
}

method - метод запроса
requestDate - время запроса, в формате unix
responseData - результат запроса
page - страница выводимых объектов
totalPages - количество страниц выводимых объектов

ОТВЕТ НЕВЕРНОГО ЗАПРОСА:


{
  "error": "Invalid Key"
}

error - текст ошибки запроса

1. Резервы

По api можно получить будущие резервы и резервы месячной давности (если весь этот месяц был активирован тариф PRO+) или недельной давности (если тариф PRO+ активировали недавно)

ПОЛЯ РЕЗЕРВОВ:

id;уникальный id userid;id сотрудника, кто создал резерв (0 - создан не сотрудником) created;дата и время создания резерва last_updated;дата и время последнего изменения резерва reserve_id;номер заявки адреса time_from;дата и время начала резерва time_to;дата и время конца резерва name;имя гостя count;количество гостей phone;телефон гостя email;почта гостя text;комментарий status;статус резерва (1 - новая, 2 - заявка, 3 - ожидает, 4 - открыт, 5 - закрыт, 6 - отменен, 8 - отменен, не внесён депозит) is_fast;тип бронирования (0 - бронировалось заранее, 1 - гость пришёл по факту) source;источник резерва depositPriceDesired;необходимый депозит для выбранного объекта бронирования (рассчитывается в зависимости от настроек условий депозита в адресе заведения) depositPrice;конечная внесённая сумма депозита depositPaid;подтверждение внесения депозита depositPrice (0 - не внесён, 1 - внесён) depositOnline;внесен онлайн, через интернет-эквайринг item_ids;список id объектов бронирования, если это групповая бронь (item_type имеет значение group). item_type;тип объекта бронирования group, hall, table, igloo, computer, room, group. Тип group означает, что забронировано несколько объектов (список объектов доступен в поле item_ids) или все объекты зала (забронированный зал доступен в поле floor_id). Тип hall означает, что забронирован банкетный зал. floor_id;id забронированного зала floor_name;название зала time_see;время просмотра резерва сотрудником (перевод с статуса "Новая" в "Заявка") time_open;время открытия резерва time_close;время закрытия резерва time_cancel;время отмены резерва is_banquet;0 - забронирован 1 и более объектов бронирования, но не весь зал. 1 - означает, что забронирован либо зал полностью, либо забронирован банкетный зал. Parent_ID;пересажен с другого резерва (указан reserve_id резерва, с которого пересадили) Next_ID;пересажен в другой резерв (указан reserve_id другого объекта, на который пересадили)

Получение списка резервов адреса

МЕТОД
GET /reserves

ОПИСАНИЕ
Метод позволяет получить список резервов адреса

GET ПАРАМЕТРЫ

Получение данных резерва по ID

МЕТОД
GET /reserves/{id}

ОПИСАНИЕ
Метод позволяет получить данные конкретного резерва адреса по уникальному id

2. Объекты бронирования (столы)

ПОЛЯ ОБЪЕКТОВ БРОНИРОВАНИЯ:

Получение списка объектов бронирования

МЕТОД
GET /items

ОПИСАНИЕ
Метод позволяет получить список объектов бронирования (столы, приставка, компьютер и т. д.)

GET ПАРАМЕТРЫ

Получение данных объекта бронирования по ID

МЕТОД
GET /items/{id}

ОПИСАНИЕ
Метод позволяет получить данные конкретного объекта бронирования по уникальному id

3. Залы

ПОЛЯ ЗАЛОВ:

Получение списка залов

МЕТОД
GET /halls

ОПИСАНИЕ
Метод позволяет получить список залов

GET ПАРАМЕТРЫ

Получение данных зала по ID

МЕТОД
GET /halls/{id}

ОПИСАНИЕ
Метод позволяет получить данные конкретного зала по уникальному id

Прочитайте ещё

Как установить виджет на сайт – общий принцип

В этой инструкции вы узнаете, как установить HTML-код виджета бронирования Restoplace на Ваш сайт

Как установить виджет в группе VK

Пошаговое руководство по установке виджета бронирования RESTOPLACE в группу вашего заведения в Вконтакте

Инструкция по синхронизации iiko c Restoplace

Как произвести интеграцию Restoplace с iiko. Особенности, технические требования, как установить

Дизайн виджета для гостей, как оформить

Как изменить цветовое оформление виджета для гостей, который устанавливается на вашем сайте и в соцсетях

Как установить виджет в Inst-m

Пошаговое руководство по установке виджета бронирования RESTOPLACE в Inst-m вашего заведения

Инструкция по синхронизации Битрикс24 c Restoplace

Как произвести интеграцию Restoplace с Bitrix24. Как подключить и настроить