Описание
Shelter CLOUD предоставляет API для подключения сторонних электронных замков. Для интеграции необходимо разработать программу-агент, которая устанавливается на компьютер, напрямую подключенный к энкодеру (или имеющий к нему сетевой доступ). Данная программа выполняет следующие функции:
-
управление настройками подключения;
-
отправка запросов в Shelter CLOUD о наличии команд для энкодера;
-
передача полученных команд на энкодер и обработка ответов.
Настройка подключения
Программа должна предоставлять возможность гибкой настройки следующих параметров:
-
URL API-сервиса Shelter CLOUD (на случай его изменения).
-
Сетевой адрес энкодера.
-
Токен доступа для аутентификации в API.
Параметры по умолчанию:
-
URL API: https://pms.frontdesk24.ru/locks/WebServiceHmsLocks.asmx
-
Токен доступа: предоставляется технической поддержкой Shelter CLOUD.
Получение команд
Для получения команд программа должна с интервалом 10 секунд вызывать метод API GetLocksCommands. Если для энкодера есть ожидающая команда, метод вернет ее данные.
Список вариантов команд:
| Код команды | Описание |
|---|---|
| WriteCard = 1 | Записать карту (ключ). |
| ReadCard = 3 | Прочитать карту. Программа обрабатывает данные карты самостоятельно. |
| ExpireCard = 4 | Аннулировать карту (например, при выезде гостя). |
| Exception= -1 | Ошибка на стороне сервера. Сервис временно недоступен. |
Обработка команды WriteCard
Для команды записи карты WriteCard вместе с командой передаются следующие параметры:
from
|
дата и время заезда |
until
|
дата и время выезда |
room
|
номер комнаты |
copies
|
количество карт для записи |
user
|
идентификатор пользователя, выдавшего карту |
guests
|
количество гостей в номере |
mainGuestInfo
|
ФИО основного гостя |
Механизм подтверждения команд
Каждая команда считается обработанной после однократного получения от метода GetLocksCommands. Система не повторяет отправку одной и той же команды.
Важно: Если программа не смогла выполнить команду (например, из-за отсутствия связи с энкодером), необходимо повторно инициировать ее отправку вручную через интерфейс Shelter CLOUD. Автоматический повтор запроса на выполнение не предусмотрен.