Подключение электронных замков через API

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

Frontdesk24 позволяет подключить любые электронные замки через механизм API.
Для этого потребуется реализовать программу, которая будет находиться на компьютере, к которому подключен энкодер (или откуда энкодер доступен по сети) и которая выполняет следующие функции:
  • Управляет настройками
  • Запрашивает команды для энкодера из API
  • Передаёт команды в энкодер


Управление настройками требуется для указания пути к API на случай смены адреса, порта (или сетевого адреса энкодера) и токена доступа в API.
Путь к API по умолчанию: https://pms.frontdesk24.ru/locks/WebServiceHmsLocks.asmx
Токен доступа предоставляется командой техподдержки Frontdesk24.

Получение команд
Для получения команд требуется вызвать метод GetLocksCommands из API.
Этот метод программа вызывает каждые 10 секунд. Если пользователь дал команду для энкодера, она будет выдана программе.
Варианты команд:

  • WriteCard = 1 - означает, что требуется запись карты
  • ReadCard = 3 - означает, что требуется чтение карты. Программа отображает данные карты пользователю самостоятельно, без Frontdesk24
  • ExpireCard = 4 - означает, что требуется гость с данной картой выезжает и освобождает номер
  • Exception= -1 - означает, что при работе произошла ошибка, сервис временно недоступен


Для команды WriteCard будут также переданы параметры:

  • from - дата и время заезда
  • until - дата и время выезда
  • room - номер комнаты
  • copies - число карт к выдаче
  • user - пользователь, выдавший карту
  • guests - число гостей в номере
  • mainGuestInfo - ФИО основного гостя


После выдачи команда считается переданной и не повторяется. В случае, если команда не была исполнена по любой причине, требуется повторить команду в интерфейсе FD24.