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

В этой инструкции:

Как делать запросы
Где взять ключ API в Restoplace
Резервы
Список слотов для бронирования
Список меток (тегов)
Объекты бронирования (столы)
Список наименований объектов бронирования
Залы
Общая информация

Как делать запросы

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

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

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

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

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

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

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

{
  "error": "Invalid Key"
}

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

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

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

Резервы

Раскрыть все методы

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

Получить список резервов`GET /reserves`

Параметр	Тип данных	Описание
`updatedAfterTime`	int	Вернутся резервы которые были созданы/изменены после указанного времени в формате unix
`query`	string	Поисковый запрос (осуществляет поиск по полям резервов) Доступные поля: reserve_id, phone, email, status, depositPaid, date, item_id, floor_id, is_banquet, is_fast, createdDate - дата создания резерва, date - резервы за указанный рабочий день. Формат даты 2000-01-01. *рабочий день может попадать на следующий фактический день, пример: 2000-01-01 08:00:00 - 2000-01-02 02:00:00 Пример: /reserves?query[phone]=79000000000
`page`	int	Страница выводимых объектов (по умолчанию: 1)

Получение резерва по ID`GET /reserves/{id}`

Создание резерва`POST /reserves/`

Запрос

GET параметры

Параметр	Тип данных	Описание
`from`	string	начало резерва (обязательно). Пример: 2024-05-20 17:20:00
`to`	string	конец резерва (обязательно). Пример: 2024-05-20 19:00:00
`name`	string	имя гостя (обязательно). Пример: Иван
`phone`	string	телефон гостя. Пример: 79876543210
`email`	string	почта гостя. Пример: name@mail.ru
`count`	int	количество человек
`text`	string	комментарий к резерву
`source`	string	источник бронирования (нужно указывать в виде домена). Пример: telegram.ru
`tags`	array	Добавление тегов к резерву, из списка GET /tags. Пример: ["vip", birthday"]
`item_ids`	array	id бронируемого стола или столов. Если не указывать id стола, то автоматически подберется свободный столик, с минимальным количеством мест. Пример: [1542, 2460]
`floorid`	int	если не указан id стола/столов, можно указать id зала, тогда выберется автоматически свободный стол этого зала
`waitlist`	boolean	заявка попадет в Лист ожидания, без выбранного стола. Далее хостес нужно будет выбрать столик у заявки, только тогда время будет забронировано. Пример: true/false
`deposit`	boolean default:true	При true, если у бронируемого стола установлен депозит, вернется ссылка на оплату. При false, стол забронируется игнорируя депозит у стола. Пример: true/false
`deposit_total`	float	Указать свою сумму депозита. Если не указано, то рассчитывается депозит из настроек стола
`deposit_paid`	boolean default:false	Факт внесения оплаты. Если указан true, то сумма депозита будет указана как внесенная оплата «Наличными»

Успешный ответ

— Если создан резерв с выбранным столом:

{
  "method":"reserves",
  "requestDate":1716998092,
  "responseData":{
    "id":"145248",  /* id резерва */
    "number":"107", 
    "message":"Резерв создан" 
  },
  "page":1,
  "totalPages":1  
}

— Если создана заявка в Листе ожидания:

{
  "method":"reserves",
  "requestDate":1716998092,
  "responseData":{
    "id":"145248", /* id резерва */
    "number":"107", 
    "message":"Заявка добавлена в Лист ожидания" 
  },
  "page":1,
  "totalPages":1  
}

— Если создана заявка или резерв с необходимостью внесения онлайн оплаты:

{
  "method":"reserves",
  "requestDate":1716998092,
  "responseData":{
    "id":"145248", /* id резерва */ 
                "number":"107", 
              "message":"Ожидание оплаты",
    "paymentNeed":true, /* необходимо произвести оплату */
    "paymentLink":"https://acquiring.bank.com/pay"/* ссылка на страницу оплаты. Ссылка может не сформироваться, если интернет эквайринг настроен некорректно */ 
    "paymentPrice":"1000", /* сумма оплаты */ 
    "paymentWaitMinutes":"40", /* время ожидания оплаты, в минутах */ 
    "paymentWaitTo":"2025-08-28 18:27:21", /* до скольки будет активна ссылка на оплату */ 
  },
  "page":1,
  "totalPages":1  
}

Ответ с ошибкой

{
  "error":"Нет свободных столов на выбранное время для 2 персон"  
}

Изменение статуса резерва`PUT /reserves/{id}/status`

Параметр	Тип данных	Описание
`status`	int	Возможные статусы: 1) новая заявка 2) обычная заявка – просмотренная 3) ожидаем 4) открыть стол, гость пришел 5) закрыть/отменить

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

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 - отменен, не внесён депозит) success;резерв подтвержден (т.е. выбран стол или зал) is_fast;тип бронирования (0 - бронировалось заранее, 1 - гость пришёл по факту) source;источник резерва tags;массив ключей меток. Актуальный список меток можете получить через запрос /tags getparams;get параметры, которые были указаны при бронировании в виджете (utm_source, utm_medium, utm_campaign, utm_content, utm_term, utm_referrer, roistat) depositPriceDesired;необходимый депозит для выбранного объекта бронирования (рассчитывается в зависимости от настроек условий депозита в адресе заведения) depositPrice;конечная внесённая сумма депозита depositPaid;подтверждение внесения депозита depositPrice (0 - не внесён, 1 - внесён) depositOnline;внесен онлайн, через интернет-эквайринг order_sum;если есть интеграция с iiko или rkeeper, при закрытии счета будет передаваться итоговая сумма заказа 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 другого объекта, на который пересадили)

Список слотов для бронирования

По api можно получить список слотов времени со статусами: доступно для бронирования / не доступно для бронирования

Получить список слотов`GET /times/`

Запрос

GET параметры

Параметр	Тип данных	Описание
`date`	string	дата (обязательно). Пример: 2024-05-20
`length`	int default:120	продолжительность слота. Указывать минуты. Стандартное значение 120. Так же этот параметр можно менять в админ панели Restoplace, но параметры передаваемые через запрос API - приоритетнее.
`shift`	int	сдвиг начала слота относительно начала предыдущего. Если не указывать, то начало слота будет равен, концу прошлого слота. Указывать минуты, от 30 до 1440. Так же этот параметр можно менять в админ панели Restoplace, но параметры передаваемые через запрос API - приоритетнее.
`floorid`	int	получить список свободных слотов выбранного зала
`dateFormat`	string default:standart	standart - формат даты и времени будет "2024-05-31 00:00:00". RFC3339 - формат даты и времени будет "2024-12-02T14:12:43+00:00"

В ответ получаете список слотов, с полями:

{
	"method":"times",
	"requestDate":1717098170,
	"responseData":[
		{
			"from":"2024-05-31 00:00:00", /* начало слота */
			"to":"2024-05-31 01:00:00", /* конец слота */
			"free":true, /* есть ли вообще свободный стол в данном промежутке времени слота (false/true) */
			"counts":{
				"1":"busy", /* нет свободных столиков */
				"2":"free", /* есть свободный столик или столики */
				"3":"free",
				"4":"free",
				"5":"free",
				"6":"free" },
			"free_tables":{ 
				"2":["1542", "1543", "2460"],
				"3":["1542", "1543", "2460"],
				"4":["1542", "1543", "2460"],
				"5":["1542"],
				"6":["1542"]
			}
		},
		{
			"from":"2024-05-31 01:00:00",
			"to":"2024-05-31 02:00:00",
			"free":true,
			"counts":{
				"1":"busy",
				"2":"free",
				"3":"free",
				"4":"free",
				"5":"free",
				"6":"free" },
			"free_tables":{ /* id свободных столиков */
				"2":["1542", "1543", "2460"],
				"3":["1542", "1543", "2460"],
				"4":["1542", "1543", "2460"],
				"5":["1542"],
				"6":["1542"]
			}
		},
	],
	"page":1,
	"totalPages":1 
}

Список меток (тегов)

Метод позволяет получить список меток, которые можно указывать у резервов при бронировании:
Не пересаживать, VIP гость, День Рождения ...

Получить список меток`GET /tags`

Параметр	Тип данных	Описание
`query`	string	Поисковый запрос. Доступные поля: checked Пример: /tags?query[checked]=1

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

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

Параметр	Тип данных	Описание
`query`	string	Поисковый запрос (осуществляет поиск по полям объектов бронирования) Доступные поля: checked, floorid, type, reserve, view_hostess Пример: /item?query[floorid]=100
`page`	int default:1	Страница выводимых объектов (по умолчанию: 1)

Получение данных объекта бронирования по ID`GET /items/{id}`

Метод позволяет получить данные конкретного объекта бронирования по уникальному id

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

Список наименований объектов бронирования

Метод позволяет получить список названий объектов бронирования:
Стол, Бильярд, Беседка ...

Получить список наименований объектов`GET /itemTypes`

Параметр	Тип данных	Описание
`query`	string	Поисковый запрос. Доступные поля: lang Пример: /itemTypes?query[lang]=en

Залы

Получение списка залов`GET /halls`

Параметр	Тип данных	Описание
`query`	string	Поисковый запрос (осуществляет поиск по полям залов) Доступные поля: checked, banquet, view_only_hostess Пример: /item?query[banquet]=1
`page`	int default:1	Страница выводимых объектов (по умолчанию: 1)

Получение данных зала по ID`GET /halls/{id}`

ПОЛЯ ЗАЛОВ:

Общая информация

Метод позволяет получить общую информацию по адресу/заведению

Получение общей информации`GET /info/`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Как делать запросы

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

Резервы

Получить список резервовGET /reserves

Запрос

GET параметры

Ответ

Получение резерва по IDGET /reserves/{id}

Создание резерваPOST /reserves/

Запрос

GET параметры

Успешный ответ

Ответ с ошибкой

Изменение статуса резерваPUT /reserves/{id}/status

Запрос

GET параметры

Успешный ответ

Ответ с ошибкой

Список слотов для бронирования

Получить список слотовGET /times/

Запрос

GET параметры

В ответ получаете список слотов, с полями:

Список меток (тегов)

Получить список метокGET /tags

Запрос

GET параметры

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

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

Запрос

GET параметры

Получение данных объекта бронирования по IDGET /items/{id}

Список наименований объектов бронирования

Получить список наименований объектовGET /itemTypes

Запрос

GET параметры

Залы

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

Запрос

GET параметры

Получение данных зала по IDGET /halls/{id}

Общая информация

Получение общей информацииGET /info/

В ответ получаете :

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

Получить список резервов`GET /reserves`

Получение резерва по ID`GET /reserves/{id}`

Создание резерва`POST /reserves/`

Изменение статуса резерва`PUT /reserves/{id}/status`

Получить список слотов`GET /times/`

Получить список меток`GET /tags`

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

Получение данных объекта бронирования по ID`GET /items/{id}`

Получить список наименований объектов`GET /itemTypes`

Получение списка залов`GET /halls`

Получение данных зала по ID`GET /halls/{id}`

Получение общей информации`GET /info/`