База знаний Restoplace

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

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

Ключ можно передавать двумя способами:
  1. Как заголовок: X-API-Key: abcdefgh123456789
  2. В строке запроса: GET /reserves?api_key=abcdefgh123456789

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

На главном экране сервиса app.restoplace.cc, перейдите в адрес заведения
Админка Restoplace
Вы попадёте в книгу резервов адреса. Нажмите кнопку «Настройки» в правом верхнем углу.
Настройка адреса заведения Restoplace
Перейдите в «Интеграции» — «API» и нажмите «Обновить ключ api» и скопируйте ваш ключ API
Ключ API Restoplace

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

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

{
  "method": "reserves",
  "requestDate": 1641796526,
  "responseData": {}
}
method - метод запроса
requestDate - время запроса, в формате unix
responseData - результат запроса
ОТВЕТ НЕВЕРНОГО ЗАПРОСА:
{
  "error": "Invalid Key"
}
error - текст ошибки запроса

1. Резервы

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


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

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

МЕТОД
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 на Ваш сайт

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

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

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

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

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