Общий принцип обмена данными БИТ Аппетита с сервисом интернет бронирования столиков(СИБС) (Вариант БИТ:Аппетит - клиент)

Материал из Wiki
Перейти к: навигация, поиск

API для сервиса интернет бронирования столиков (Вариант БИТ:Аппетит - клиент)

В данной схеме интеграции БИТ Аппетит выступает в качестве клиента, который инициирует обмен данными по средствам HTTP запросов к серверу сервиса бронирования. Таким образом на стороне сервера должна быть реализована обработка запросов, которые БИТ Аппетит периодически отправляет к нему. Этот подход к построению обмена позволяет на одном сервере интернет бронирования обслуживать работу нескольких ресторанов с автономной установкой БИТ Аппетита.

Обмен данными условно можно разделить на 2 типа запросов:

  • Отправка справочных данных и процессинг бронирования.
  • Справочные данные - это справочники необходимые для заполнения заявки бронирования (список столиков, меню, цены на блюда).

Процессинг бронирования - это набор методов по регистрации заявки бронирования и подтверждения заявки БИТ Аппетитом.

Процесс бронирования можно разделить на следующие этапы:

  • Формирование заявки бронирования на столик и время в базе СИБС
  • Передача заявки серверу БИТ Аппетита
  • Верификация заявки на сервере БИТ Аппетита
  • Подтверждение (или отклонение) заявки БИТ Аппетитом.
  • Информирование пользователя сервиса о результате обработки запроса

Формат HTTP запросов

Запросы, которые осуществляет БИТ Аппетит, представляют собой GET/POST запросы следующего вида:
http(s)://{host}:{port}/{page_prefix}{page}{page_suffix}?{parameter1}={value1}&{parameter2}={value2} ... {parameterN}={valueN}

Где параметры имеют следующие значения

  • host - сетевой адрес
  • port - порт tcp/ip порт соединения (80 по умолчанию)
  • page_prefix - путь к странице
  • page - наименование страницы (метод API)
  • page_suffix - суффикс страницы (например расширение .php или .html)
  • parameterN - имя параметра
  • valueN - значение параметра.

Для передачи параметров содержащих XML структуру предварительно используется кодирование строки в BASE64.