API Shelter Pro (Онлайн-сервер)
Версия: 2.12.159 | Статус: Stable | Лицензия: минимально 3.5 (Online) | Продукт: Shelter Pro | Уровень: Пользовательский
Оглавление
- Описание модуля
- Решаемые задачи
- Доступ к API
- Протокол взаимодействия
- Аутентификация
- Подпись запросов (sign)
- Группы методов
- Методы API
Postman-коллекция: Готовые HTTP-запросы ко всем методам — ShelterProAPI.postman_collection.json
Описание модуля
Онлайн-сервер Shelter Pro — служба, реализующая XML API для интеграции внешних систем с Shelter Pro. Это основной механизм для подключения внешних систем к локальной версии PMS.
Через онлайн-сервер работают:
- Интеграция с Shelter Cloud
- Интеграция с Travelline
- Модули онлайн-бронирования
- Интеграции с внешними системами (СберДевайс и др.)
Важно: Компания Shelter не рекомендует и не поддерживает доработки, которые позволяют через онлайн-сервер делать прямые запросы в БД Shelter (методы SQLOPEN, SQLEXEC), особенно модификацию данных. Методы работы с бронированиями, гостями, справочниками — поддерживаются.
Решаемые задачи
| Задача | Описание |
|---|---|
| Аутентификация | Вход пользователей, организаций и гостей в систему |
| Номерной фонд | Типы номеров, список номеров, свободные номера, квоты |
| Бронирование | Создание, просмотр, отмена бронирований |
| Тарифы | Получение тарифов и стоимости проживания |
| Гости | Создание гостей, информация, работа с фолио |
| Справочники | Страны, валюты, скидки, услуги, типы оплат и др. |
| Организации | Аутентификация организаций, договоры, каналы продаж |
| Подписка на обновления | Получение уведомлений об изменениях в системе |
Доступ к API
Адреса серверов
API Shelter Pro развёртывается локально на сервере клиента. Служба Shelter Online Server работает как TCP-сервер и HTTP-сервер.
| Протокол | Порт по умолчанию | Описание |
|---|---|---|
| TCP (сокет) | Настраивается в Shelter.ini | Основной протокол для XML-команд |
| HTTP | 7798 | HTTP-сервер для запросов через URL |
Порт HTTP-сервера можно изменить параметром ListenPort секции [OnlineServer] в файле Shelter.ini.
Внешний доступ: Если требуется доступ к API снаружи локальной сети, необходимо:
- Настроить проброс портов на маршрутизаторе
- Обеспечить статический IP-адрес или использовать DDNS
- Открыть соответствующий порт в файрволе
- Обязательно использовать подпись запросов (sign)
Тестовое приложение
Для тестирования запросов используется приложение Shelter Online Server Test, которое позволяет:
- Отправлять XML-запросы
- Видеть ответы сервера
- Настраивать версию клиента
Протокол взаимодействия
TCP-протокол (основной)
Shelter Online Server — TCP-сервер, слушающий определённый сокет (пара Хост:Порт) в ожидании команд.
Формат команды:
[9 байт: длина XML][XML-строка]
- Первые 9 байт — длина XML-строки (заполняется нулями слева)
- Далее — XML-строка с командой
Пример команды:
000000063<paymentcategs/>
Формат ответа:
[9 байт: длина][0x0D 0x0A][XML-ответ]
HTTP-протокол
После запуска службы Shelter Online Server также работает как HTTP-сервер.
Методы без передачи данных (GET):
http://localhost:7798/getversion
http://localhost:7798/getstatus
Методы с передачей данных (POST):
- URL:
http://localhost:7798/command - В теле запроса передаётся XML-команда
Аутентификация
Shelter Pro использует XML-based аутентификацию. Существует три типа аутентификации:
| Метод | Команда | Пользователь | Описание |
|---|---|---|---|
| Пользователь | userlogin |
Сотрудник отеля | Доступ к функциям управления |
| Организация | debtorlogin |
Контрагент (турагентство и др.) | Доступ к корпоративным бронированиям |
| Гость | guestlogin |
Гость отеля | Доступ к личному кабинету |
Аутентификация пользователя
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<userlogin login="логин" password="пароль"/>
Ответ:
<?xml version="1.0" encoding="utf-8"?>
<user id="1"/>
| Параметр | Обяз. | Описание |
|---|---|---|
| login | Да | Логин пользователя |
| password | Да | Пароль пользователя |
Аутентификация организации
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<debtorlogin login="логин" password="пароль"/>
Аутентификация гостя
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<guestlogin login="email" password="пароль"/>
Аутентификация поселённого гостя
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GuestClaimLogin langcode="RU" login="+71111111111" password="<пароль>"/>
| Параметр | Обяз. | Описание |
|---|---|---|
| login | Да | Телефон гостя (указывается при поселении) |
| password | Да | Автоматически генерируемый пароль |
Ответ:
<GuestClaimLogin version="12" autoindent="1" langcode="RU">
<claim id="208" resid="68" guest="1170" fullname="Иван Иванов"
folio="1204" balance="-15700" servicebalance="15700"
paymentbalance="0" expectedbalance="-15700"/>
</GuestClaimLogin>
Подпись запросов (sign)
Подпись запросов опциональна для внутренней сети, но обязательна, если онлайн-сервер доступен извне сети (через интернет).
Алгоритм расчёта подписи
- К XML-запросу добавляется атрибут
version - К строке запроса добавляется ключевое слово (настраивается в Shelter Pro: Настройки → Системные настройки → Онлайн сервер → Ключ API)
- Удаляются символы с кодами вне диапазона 32-127
- Вычисляется хеш SHA512
Пример на PHP
function getSign($text, $key) {
$res = '';
for ($i = 0; $i < strlen($text); $i++) {
if ((ord($text[$i]) >= 32) && (ord($text[$i]) <= 127)) {
$res .= $text[$i];
}
}
return hash('sha512', $res . $key);
}
$xmlobj = new SimpleXMLElement($xml);
$xmlobj->addAttribute('version', $VERSION);
$xmlobj->addAttribute('sign', getSign($xmlobj->asXML(), $KEY));
$xml = $xmlobj->asXML();
Группы методов
Система
| Метод | Описание | Лицензия |
|---|---|---|
| GETVERSION | Получить версию программы | — |
| GETSTATUS | Получить статус службы | — |
| GETMEMSTATUS | Получить информацию о памяти | — |
| HOTELSLIST | Список отелей | — |
| GETLANGUAGES | Список локализаций | Online (3:5) |
| DEFAULT_VALUES | Получить настройки | Online (3:5) |
| SENDMAIL | Отправить письмо | Online (3:5) |
| CHANGESLIST | Список изменений | Online (3:5) |
Пользователь
| Метод | Описание | Лицензия |
|---|---|---|
| USERLOGIN | Аутентификация пользователя | Online (3:5) |
| GETUSER | Данные пользователя | Online (3:5) |
| USERROLES | Роли пользователя | Online (3:5) |
| FUNCTIONS | Функции пользователей | Online (3:5) |
| USERFUNCTIONS | Функции пользователя | Online (3:5) |
| GUESTCLAIMLOGIN | Аутентификация поселённого гостя | Online (3:5) |
Номерной фонд
| Метод | Описание | Лицензия |
|---|---|---|
| GETROOMKINDS | Типы номеров | Online (3:5) |
| GETROOMLIST | Список номеров | Online (3:5) |
| GETROOMLISTEX | Список номеров на даты | Online (3:5) |
| VACANCYBYROOMKIND | Свободные номера по типам | Online (3:5) |
| VACANCYBYROOMS | Свободные номера по номерам | Online (3:5) |
| VACANCYLIST | Свободные номера | Online (3:5) |
| VACANCYLISTEX | Свободные номера (расширенная) | Online (3:5) |
| GETROOMKINDAVAILABILITY | Свободные номера за интервал дат | Online (3:5) |
| VACANCYBYROOMKINDWITHQUOTE | Квоты по типам | Online (3:5) |
| GETBUILDINGS | Список корпусов | Online (3:5) |
| GETFLOORS | Список этажей | Online (3:5) |
| GETPLACES | Список мест типов номеров | Online (3:5) |
| GETROOMFEATURES | Особенности номеров (по номерам) | Online (3:5) |
| GETFEATURES | Список особенностей номеров | Online (3:5) |
| GETROOMKINDFACTOR1 | Типы размещения | Online (3:5) |
| GETFACTOR1 | Категории размещения | Online (3:5) |
| GETFACTOR2 | Возрастные категории | Online (3:5) |
Справочники
| Метод | Описание | Лицензия |
|---|---|---|
| PAYMENTCATEGS | Категории оплат | Online (3:5) |
| GETPAYMENTS | Типы оплат | Online (3:5) |
| GETEXTRA | Список доп.услуг | Online (3:5) |
| GETOPERATIONS | Список операций | Online (3:5) |
| GETDISCOUNTS | Список скидок | Online (3:5) |
| GETSOURCES | Список источников информации | Online (3:5) |
| GETCOUNTRIES | Список стран | Online (3:5) |
| GETCUSTOMFIELDS | Список пользовательских полей | Online (3:5) |
| GETCURRENCY | Список валют | Online (3:5) |
| CURRENCYRECALC | Конвертация валют | Online (3:5) |
| REFERENCE | Работа со справочниками (универсальный) | Online (3:5) |
Тарифы
| Метод | Описание | Лицензия |
|---|---|---|
| RESERVATION action="GETRATES" | Список тарифов | Online (3:5) |
| GETRATESEX | Список тарифов по датам | Online (3:5) |
| GETRATESFACTOR | Список тарифов по датам с факторами | Online (3:5) |
| GETROOMKINDCOST | Стоимость проживания по типам номеров | Online (3:5) |
| GETROOMKINDAVAILABILITYANDCOST | Свободные номера за интервал дат с тарифами | Online (3:5) |
| VACANCYLIST_RATES | Свободные номера с тарифами | Online (3:5) |
| VACANCYQUOTE_RATES | Свободные номера с квотами и тарифами | Online (3:5) |
| GETPDSCARDINFO | Информация о карте ПДС | Online (3:5) |
Бронирование
| Метод | Описание | Лицензия |
|---|---|---|
| RESERVATION action="SAVE" | Сохранить заявку | Online (3:5); с create_folio=1 → Assist (4:5) |
| RESERVLIST | Список броней | Online (3:5) |
| RESERVATION action="GETINFO" | Информация о брони | Online (3:5) |
| RESERVATION_CANCEL | Отменить бронь | Online (3:5) |
| GROUP_SERVICES | Список доп.услуг по брони | Online (3:5) |
| PAYSYSTEM | Платёжная система | Online (3:5) |
| GETCLAIMLIST | Список заявок на дату (шахматка) | Online (3:5) |
| GETCLAIMLISTEX | Список заявок на дату (с ценами) | Online (3:5) |
| GetResIdByCode | Получить ID брони по коду | Online (3:5) |
Гость
| Метод | Описание | Лицензия |
|---|---|---|
| GUESTCREATE | Создание гостя | Online (3:5) |
| GUESTLOGIN | Аутентификация гостя | Online (3:5) |
| GUESTEXISTS | Проверка пользователя | Online (3:5) |
| GUESTLOGIN_CHANGE | Смена пароля гостя | Online (3:5) |
| GETGUESTINFO | Получить информацию о госте | Online (3:5) |
| SETGUESTINFO | Сохранить информацию о госте | Online (3:5) |
| FOLIOCONTENTS | Содержимое фолио клиента | Online (3:5) |
| ADDFOLIOPAYMENT | Занесение услуги на фолио | Online (3:5) |
| GROUPSERVICE | Добавить/изменить доп.услуги гостя | Online (3:5) |
| SENDMESSAGE | Сообщение от гостя администрации | Online (3:5) |
| MAILLIST | Список сообщений гостя | Online (3:5) |
| MAILCOUNT | Количество сообщений гостя | Online (3:5) |
Организация
| Метод | Описание | Лицензия |
|---|---|---|
| GETDEBTORS | Список организаций | Online (3:5) |
| GETCHANNELS | Список каналов продаж | Online (3:5) |
| DEBTORLOGIN | Аутентификация организации | Online (3:5) |
| GETDEBTORCONTRACTS | Список договоров организации | Online (3:5) |
Мероприятия и горничные
| Метод | Описание | Лицензия |
|---|---|---|
| GETRESOURCES | Список ресурсов (мероприятия) | Online (3:5) |
| GETCLEANINGROOMINFO | Информация об уборке номера | Online (3:5) |
| CURRENTWORKSFORUSER | Список текущих работ для пользователя | Online (3:5) |
Подписка на обновления
| Метод | Описание | Лицензия |
|---|---|---|
| SUBSCRIBE | Подписаться на обновления | Online (3:5) |
| UNSUBSCRIBE | Отписаться от обновлений | Online (3:5) |
| CONFIRMSUBSCRIBE | Подтвердить получение обновлений | Online (3:5) |
Внешние системы
| Метод | Описание | Лицензия |
|---|---|---|
| GETGUESTLIST | Список гостей (Сбербанк) | Online (3:5) |
| GETRESERVATIONLIST | Список бронирований (HotelAdvisors) | Online (3:5) |
Методы API
Ниже приведены методы API с параметрами запросов и описанием ответов.
GETVERSION — Получение версии сервера
Лицензия: Не требуется
Метод не требует параметров.
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getversion/>
Ответ:
<?xml version="1.0" encoding="utf-8"?>
<getversion version="12" autoindent="1" langcode="RU"
creationdate="27.03.2018 13:30:49.026"
companyname="UCS" filedescription="UCS Shelter2 Interface"
fileversion="3.0.107.2179" winversion="5.1.2600"
memory="1048575 KB"/>
| Атрибут ответа | Описание |
|---|---|
| version | Версия протокола |
| creationdate | Дата создания |
| companyname | Название компании |
| filedescription | Описание файла |
| fileversion | Версия файла |
| winversion | Версия Windows |
| memory | Память |
GETSTATUS — Получение статуса службы
Лицензия: Не требуется
Метод не требует параметров.
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getstatus/>
HOTELSLIST — Список отелей
Лицензия: Не требуется
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getversion/>
Ответ:
<?xml version="1.0" encoding="utf-8"?>
<getversion version="12" autoindent="1" langcode="RU"
creationdate="27.03.2018 13:30:49.026"
companyname="UCS" filedescription="UCS Shelter2 Interface"
fileversion="3.0.107.2179" winversion="5.1.2600"
memory="1048575 KB"/>
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка (RU, EN и др.) |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<hotelslist langcode="RU"/>
Ответ:
<?xml version="1.0" encoding="utf-8"?>
<hotelslist version="12" autoindent="1" langcode="RU">
<hotel id="1" owner="1002" code="SHL" name="Отель"
workshift="43119" country="1" stars="3"
city="Москва" phones="94 94" mails="info@hotel.ru"/>
</hotelslist>
| Атрибут ответа (hotel) | Описание |
|---|---|
| id | Идентификатор отеля (используется в других функциях) |
| code | Код отеля |
| name | Наименование отеля |
| name2 | Дополнительное наименование |
| workshift | Текущая смена |
| country | Идентификатор страны |
| address | Адрес |
| owner | Идентификатор юр.лица |
| stars | Количество звёзд |
| director | Директор |
| accountant | Бухгалтер |
| postcode | Почтовый код |
| city | Город |
| type7 | Тип объекта (гостиница, фитнес-клуб и др.) |
| phones | Телефон |
| mails | |
| www | Веб-сайт |
| hotelorg | Организация-собственник |
GETROOMKINDS — Типы номеров
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| hotel | Да | Идентификатор отеля |
| langcode | Нет | Код языка |
| startdate | Нет | Начало периода |
| finishdate | Нет | Конец периода |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getroomkinds langcode="RU" hotel="1"/>
Ответ:
<?xml version="1.0" encoding="utf-8"?>
<getroomkinds version="12" autoindent="1" langcode="RU" hotel="1">
<roomkind id="1" code="STD" name="Стандарт" beds="2" amountofrooms="1"/>
</getroomkinds>
| Атрибут ответа (roomkind) | Описание |
|---|---|
| id | Идентификатор типа номера (используется в inquiry.roomkind) |
| code | Код типа номера |
| name | Название типа номера |
| beds | Количество мест в одном номере |
| amountofrooms | Количество комнат в одном номере |
| roomkindparamstr | Дополнительные параметры |
| is_sale_places | Продажа местами (0/1) |
VACANCYLIST — Свободные номера
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
| hotel | Нет | Идентификатор отеля |
| startdate | Да | Начало периода (число дней с 30.12.1899) |
| finishdate | Да | Конец периода |
| use_typesale | Нет | Использовать настройку продажи по местам (0/1) |
| use_entire_period | Нет | Учитывать свободные номера во всём интервале (0/1) |
| USE_REAL_INPUT_DATE | Нет | Учитывать время заезда/выезда (0/1) |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<vacancylist langcode="RU" hotel="1" startdate="45000" finishdate="45002" use_typesale="0"/>
Ответ:
<?xml version="1.0" encoding="utf-8"?>
<vacancylist version="12" autoindent="1" langcode="RU" hotel="1">
<roomkind id="1" code="LUXE" name="Люкс">
<record date="45000" amountvacancyrooms="2" amountvacancyplaces="4"
amountquoterooms="0" is_sale_places="0"/>
<record date="45001" amountvacancyrooms="2" amountvacancyplaces="4"
amountquoterooms="0" is_sale_places="0"/>
</roomkind>
</vacancylist>
| Атрибут ответа (record) | Описание |
|---|---|
| date | Дата |
| amountvacancyrooms | Количество свободных номеров |
| amountvacancyplaces | Количество свободных мест |
| amountquoterooms | Количество номеров по квоте |
| is_sale_places | Продажа местами (0/1) |
RESERVATION action="SAVE" — Сохранение бронирования
Лицензия: Online (3:5); с параметром
create_folio=1требуется Assist (4:5)
| Параметр запроса (reservation) | Обяз. | Описание |
|---|---|---|
| action | Да | Действие: SAVE, GETRATES, GETINFO |
| hotel | Да | Идентификатор отеля |
| langcode | Нет | Код языка |
| id | Нет | Идентификатор брони (0 для новой) |
| arrival | Нет | Дата заезда |
| departure | Нет | Дата выезда |
| kind | Нет | Тип: 1=групповая, 2=индивидуальная, 3=корпоративная |
| status | Нет | Статус: 0=гарантированная, 1=негарантированная, 2=лист ожидания |
| state | Нет | Состояние: 1=активная, 2=аннулированная |
| debtor | Нет | Идентификатор организации |
| agent | Нет | Идентификатор агентства |
| contact | Нет | Контактное лицо |
| phone | Нет | Телефон |
| Нет | ||
| info | Нет | Примечание |
| payment | Нет | Идентификатор типа оплаты |
| owner | Нет | Внутренний идентификатор владельца |
| Параметр (inquiry) | Обяз. | Описание |
|---|---|---|
| id | Нет | Идентификатор заезда |
| roomkind | Да | Идентификатор типа номера |
| arrival | Нет | Дата заезда |
| departure | Нет | Дата выезда |
| quant | Нет | Количество номеров |
| adult | Да | Количество взрослых в номере |
| child | Нет | Количество детей в номере |
| infant | Нет | Количество младенцев |
| placesex | Нет | Количество доп.мест взрослых |
| placesex_child | Нет | Количество доп.мест детей |
| rate | Нет | Идентификатор тарифа |
| Параметр (guest) | Обяз. | Описание |
|---|---|---|
| name | Нет | Фамилия гостя |
| name1 | Нет | Имя гостя |
| name2 | Нет | Отчество гостя |
| fullname | Нет | ФИО (формируется как name name1 name2) |
| Нет | Email гостя | |
| phones | Нет | Телефон гостя |
| doc_series | Нет | Серия документа |
| noguest | Нет | Номер документа |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<reservation action="SAVE" hotel="1" langcode="RU" kind="2" status="0" state="1">
<inquiry roomkind="1" arrival="45000" departure="45002" quant="1" adult="2">
<claim>
<guest name="Сидоров" name1="Иван" email="ivan@example.com" phones="+79991234567"/>
</claim>
</inquiry>
</reservation>
RESERVATION_CANCEL — Отмена бронирования
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| hotel | Да | Идентификатор отеля |
| resid | Да | Идентификатор бронирования |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<reservation_cancel hotel="1" resid="12345"/>
GETPAYMENTS — Типы оплат
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getpayments langcode="RU"/>
| Атрибут ответа (payment) | Описание |
|---|---|
| id | Идентификатор типа платежа |
| code | Код типа платежа |
| name | Наименование типа платежа |
| paramstr | Дополнительные параметры |
| paysystem | Идентификатор платёжной системы |
| useinternet | Использование для интернет-бронирования (0/1) |
GETCOUNTRIES — Список стран
Лицензия: Online (3:5)
Метод не требует обязательных параметров.
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetCountries/>
| Атрибут ответа (country) | Описание |
|---|---|
| id | Идентификатор страны |
| code | Код страны (ISO) |
| name | Наименование страны |
| wubook_code | Код WuBook |
| travelline_code | Код TravelLine |
GETCURRENCY — Список валют
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetCurrency langcode="RU"/>
| Атрибут ответа (currency) | Описание |
|---|---|
| id | Идентификатор валюты |
| code | Код валюты (ISO) |
| name | Наименование валюты |
| rate | Курс валюты |
GETEXTRA — Дополнительные услуги
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getextra langcode="RU"/>
| Атрибут ответа (extra) | Описание |
|---|---|
| id | Идентификатор доп.услуги |
| code | Код доп.услуги |
| name | Наименование доп.услуги |
GETDISCOUNTS — Список скидок
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getdiscounts langcode="RU"/>
| Атрибут ответа (discount) | Описание |
|---|---|
| id | Идентификатор скидки |
| code | Код скидки |
| name | Наименование скидки |
| parent | Идентификатор родителя |
| groupid | Идентификатор группы |
| kind2 | Тип: 0=скидка, 1=комиссия, 2=штраф |
| operation | Идентификатор услуги |
| priority | Приоритет скидки |
GETDEBTORS — Список организаций
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getdebtors langcode="RU"/>
GETCHANNELS — Список каналов продаж
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getchannels langcode="RU"/>
| Атрибут ответа (Channel) | Описание |
|---|---|
| id | Идентификатор канала |
| NAME | Название канала |
| WuBookCode | Код WuBook |
| TravelLineCode | Код TravelLine |
| BnovoCode | Код Bnovo |
| frontdeskcode | Код Frontdesk |
USERLOGIN — Аутентификация пользователя
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| login | Да | Логин пользователя |
| password | Да | Пароль пользователя |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<userlogin login="admin" password="password"/>
Ответ:
<?xml version="1.0" encoding="utf-8"?>
<user id="1"/>
| Атрибут ответа (user) | Описание |
|---|---|
| id | Идентификатор пользователя |
GETUSER — Данные пользователя
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| login | Да | Логин пользователя |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getuser login="admin"/>
| Атрибут ответа (user) | Описание |
|---|---|
| id | Идентификатор пользователя |
| name | Имя пользователя |
| login | Логин пользователя |
| Email пользователя | |
| hotel | Идентификатор отеля |
| roleid | Идентификатор роли |
USERROLES — Роли пользователя
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| userid | Да | Идентификатор пользователя |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<userroles userid="1"/>
| Атрибут ответа (role) | Описание |
|---|---|
| id | Идентификатор роли |
| rights | Права |
| name | Название роли |
| info | Примечание |
FUNCTIONS — Функции пользователей
Лицензия: Online (3:5)
Получает список всех доступных функций.
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<functions/>
| Атрибут ответа (function) | Описание |
|---|---|
| id | Идентификатор функции |
| funccode | Код функции |
| funcname | Название функции |
| info | Примечание |
USERFUNCTIONS — Функции пользователя
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| userid | Да | Идентификатор пользователя |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<userfunctions userid="1"/>
GETROOMLIST — Список номеров
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| hotel | Нет | Идентификатор отеля |
| startdate | Нет | Начало периода |
| finishdate | Нет | Конец периода |
| idroom | Нет | Идентификатор номера (фильтр) |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getroomlist hotel="1" startdate="45000" finishdate="45002"/>
| Атрибут ответа (room) | Описание |
|---|---|
| id | Идентификатор номера |
| code | Номер комнаты |
| name | Примечание |
| beds | Количество мест |
| roomkind | Идентификатор типа номера |
| BUILDING | Идентификатор корпуса |
| FLOOR | Этаж |
| extid | Внешний идентификатор |
| CloudId | Идентификатор в облаке |
| roomkind_code | Код типа номера |
| roomkind_name | Наименование типа номера |
| date_from | Дата начала действия номера |
| date_to | Дата окончания действия номера |
| STATE_ID | Идентификатор состояния |
| ROOM_STATE_KIND | Тип состояния |
GETROOMLISTEX — Список номеров на даты (расширенный)
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| hotel | Да | Идентификатор отеля |
| begindate | Да | Начало периода |
| enddate | Да | Конец периода |
| currdate | Нет | Текущая смена |
| floors | Нет | Этажи (через запятую) |
| roomkinds | Нет | Типы номеров (через запятую) |
| buildings | Нет | Корпуса (через запятую) |
| features | Нет | Особенности (через запятую) |
| states | Нет | Состояния номера |
| status | Нет | Статус номера |
| guest | Нет | Имя гостя (частичное) |
| debtor | Нет | Название организации (частичное) |
| number | Нет | Номер комнаты |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetRoomListEx hotel="1" begindate="45000" enddate="45002" currdate="45001"/>
| Атрибут ответа (room) | Описание |
|---|---|
| id | Идентификатор номера |
| number | Наименование номера |
| floor | Этаж |
| building | Здание |
| roomkind | Тип номера |
| claimstatus | Статус поселения |
| state | Статус номера (0=чистый, 1=грязный) |
| statecolor | Цвет статуса |
| qplaces | Количество мест |
| qplacesex | Количество доп.мест |
VACANCYBYROOMKIND — Свободные номера по типам
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
| hotel | Нет | Идентификатор отеля |
| startdate | Да | Начало периода |
| finishdate | Да | Конец периода |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<vacancybyroomkind langcode="RU" hotel="1" startdate="45000" finishdate="45002"/>
VACANCYLISTEX — Свободные номера (расширенная)
Лицензия: Online (3:5)
Возвращает информацию о занятых, общем количестве и номерах на ремонте.
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| hotel | Да | Идентификатор отеля |
| startdate | Да | Начало периода |
| finishdate | Да | Конец периода |
| use_typesale | Нет | Использовать настройку продажи по местам |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<VacancyListEx langcode="RU" hotel="1" startdate="45000" finishdate="45002"/>
| Атрибут ответа (record) | Описание |
|---|---|
| date | Дата |
| busyrooms | Количество занятых номеров |
| totalrooms | Общее количество номеров |
| repairrooms | Количество номеров на ремонте |
| is_sale_places | Продажа местами |
GETROOMKINDAVAILABILITY — Свободные номера за интервал дат
Лицензия: Online (3:5)
Возвращает минимальное количество свободных номеров за весь период.
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
| startdate | Да | Начало периода |
| finishdate | Да | Конец периода |
| use_typesale | Нет | Использовать настройку продажи по местам |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetRoomKindAvailability langcode="RU" startdate="45000" finishdate="45002"/>
| Атрибут ответа (roomkind) | Описание |
|---|---|
| id | Идентификатор типа номера |
| code | Код типа номера |
| name | Наименование типа номера |
| amountvacancyrooms | Минимальное количество свободных номеров за период |
| is_sale_places | Продажа местами |
VACANCYBYROOMKINDWITHQUOTE — Квоты по типам номеров
Лицензия: Online (3:5)
Возвращает квоты организации по типам номеров.
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
| startdate | Да | Начало периода |
| finishdate | Да | Конец периода |
| debtor | Да | Идентификатор организации |
| contract | Нет | Идентификатор договора |
| hotel | Нет | Идентификатор отеля |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<vacancybyroomkindwithquote langcode="RU" startdate="45000" finishdate="45005" debtor="1" hotel="1"/>
| Атрибут ответа (record) | Описание |
|---|---|
| date | Дата |
| amountvacancyrooms | Количество номеров по квоте |
GETBUILDINGS — Список корпусов
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetBuildings langcode="RU"/>
| Атрибут ответа (building) | Описание |
|---|---|
| id | Идентификатор корпуса |
| code | Код корпуса |
| name | Название корпуса |
| hotel | Идентификатор отеля |
GETFLOORS — Список этажей
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetFloors langcode="RU"/>
| Атрибут ответа (floor) | Описание |
|---|---|
| hotel | Идентификатор отеля |
| floor | Номер этажа |
GETROOMFEATURES — Особенности номеров
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetRoomFeatures langcode="RU"/>
| Атрибут ответа (roomkind) | Описание |
|---|---|
| ID | Идентификатор номера |
| HOTEL | Идентификатор отеля |
| FEATURE | Идентификатор особенности |
| FEATURE_NAME | Название особенности |
GETFEATURES — Справочник особенностей номеров
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetFeatures langcode="RU"/>
| Атрибут ответа (feature) | Описание |
|---|---|
| ID | Идентификатор особенности |
| NAME | Название особенности |
GETFACTOR1 — Категории размещения
Лицензия: Online (3:5)
Возвращает справочник типов размещения (основное место, доп.место и т.д.)
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetFactor1 langcode="RU"/>
GETFACTOR2 — Возрастные категории
Лицензия: Online (3:5)
Возвращает справочник возрастных категорий (взрослый, ребёнок, младенец).
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetFactor2 langcode="RU"/>
GETOPERATIONS — Список услуг
Лицензия: Online (3:5)
Возвращает список услуг со стоимостью больше нуля.
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
| hotel | Да | Идентификатор отеля (можно через запятую: 0,1) |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getoperations langcode="RU" hotel="0,1"/>
| Атрибут ответа (operation) | Описание |
|---|---|
| id | Идентификатор операции |
| code | Код операции |
| name | Наименование операции |
| cost | Стоимость операции |
| hotel | Идентификатор отеля |
| GROUPID | Идентификатор группы |
| CATEGORY | Категория |
| EXTERNAL_ID | Внешний идентификатор |
GETSOURCES — Список источников информации
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getsources langcode="RU"/>
| Атрибут ответа (source) | Описание |
|---|---|
| id | Идентификатор источника |
| code | Код источника |
| name | Наименование источника |
GETCUSTOMFIELDS — Список пользовательских полей
Лицензия: Online (3:5)
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getcustomfields/>
GETLANGUAGES — Список локализаций
Лицензия: Online (3:5)
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getlanguages/>
| Атрибут ответа (language) | Описание |
|---|---|
| id | Идентификатор локализации |
| code | Код локализации (RU, EN и др.) |
| name | Наименование на языке |
| name_rus | Наименование на русском |
| name_eng | Наименование на английском |
DEFAULT_VALUES — Настройки по умолчанию
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| hotel | Нет | Идентификатор отеля |
| name | Нет | Название настройки (фильтр) |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<default_values hotel="1"/>
CHANGESLIST — Список изменений
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| startdate | Да | Начало периода |
| finishdate | Да | Конец периода |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<changeslist startdate="45000" finishdate="45002"/>
RESERVLIST — Список бронирований
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| hotel | Да | Идентификатор отеля |
| startdate | Нет | Начало периода |
| finishdate | Нет | Конец периода |
| debtor | Нет | Идентификатор организации |
| agent | Нет | Идентификатор агента |
| resid | Нет | Идентификатор брони |
| owner | Нет | Владелец брони |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<reservlist hotel="1" startdate="45000" finishdate="45010" debtor="0"/>
RESERVATION action="GETINFO" — Информация о бронировании
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| action | Да | Значение: GETINFO |
| id | Да | Идентификатор брони |
| claim | Нет | Идентификатор заезда |
| folio | Нет | Идентификатор фолио |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<reservation action="GETINFO" id="27893"/>
Возвращает полную структуру бронирования с inquiry, claim и guest элементами.
RESERVATION action="GETRATES" — Получение тарифов для брони
Лицензия: Online (3:5)
Возвращает список доступных тарифов для заданных параметров бронирования.
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<reservation action="GETRATES" hotel="1">
<inquiry roomkind="1" arrival="45000" departure="45002" quant="1" adult="2"/>
</reservation>
GROUP_SERVICES — Дополнительные услуги по брони
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
| RESID | Да | Идентификатор брони |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<group_services langcode="RU" RESID="12345"/>
| Атрибут ответа (groupservices) | Описание |
|---|---|
| id | Идентификатор услуги |
| claim | Идентификатор заезда |
| operation | Идентификатор операции |
| name | Название услуги |
| shiftdate | Дата смены |
| quant | Количество |
| cost | Стоимость |
| info | Примечание |
GUESTLOGIN — Аутентификация гостя
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| login | Да | Email гостя |
| password | Да | Пароль гостя |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<guestlogin login="guest@mail.ru" password="password123"/>
| Атрибут ответа | Описание |
|---|---|
| id | Идентификатор гостя |
| name | Фамилия |
| name1 | Имя |
| name2 | Отчество |
| fullname | Полное имя |
| phones | Телефон |
GUESTEXISTS — Проверка существования гостя
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| login | Да | Email гостя |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<guestexists login="guest@mail.ru"/>
GETGUESTRESERV — Бронирования гостя
Лицензия: Online (3:5)
Возвращает список бронирований для авторизованного гостя.
FOLIOCONTENTS — Содержимое фолио
Лицензия: Online (3:5)
Возвращает содержимое фолио клиента.
ADDFOLIOPAYMENT — Добавление платежа в фолио
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| folio | Да | Идентификатор фолио |
| guestid | Да | Идентификатор гостя |
| operationid | Да | Идентификатор операции |
| price | Да | Цена |
| userid | Да | Идентификатор пользователя |
| amount | Да | Сумма |
| hotel | Да | Идентификатор отеля |
| info | Нет | Примечание |
| systemname | Нет | Название системы |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<addfoliopayment folio="1234" guestid="100" operationid="75" price="1000" userid="1" amount="1" hotel="1"/>
GROUPSERVICE — Добавление/изменение доп.услуг гостя
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| ID | Нет | Идентификатор (0 для новой) |
| ResID | Да | Идентификатор брони |
| Claim | Нет | Идентификатор заезда |
| Operation | Да | Идентификатор операции |
| Quant | Нет | Количество |
| Cost | Нет | Стоимость |
| Info | Нет | Примечание |
| Enabled | Нет | Активность (0/1) |
SENDMESSAGE — Сообщение от гостя
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| ReceiverType | Да | Тип получателя |
| ReceiverID | Да | Идентификатор получателя |
| SenderType | Да | Тип отправителя |
| SenderID | Да | Идентификатор отправителя |
| Caption | Нет | Тема сообщения |
| Message | Да | Текст сообщения |
MAILLIST — Список сообщений
Лицензия: Online (3:5)
Возвращает список сообщений для гостя.
MAILCOUNT — Количество сообщений
Лицензия: Online (3:5)
Возвращает количество сообщений для гостя.
DEBTORLOGIN — Аутентификация организации
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| login | Да | Логин организации |
| password | Да | Пароль организации |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<debtorlogin login="company" password="password"/>
GETDEBTORCONTRACTS — Договоры организации
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| debtor | Да | Идентификатор организации |
| hotel | Нет | Идентификатор отеля |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<getdebtorcontracts debtor="1"/>
| Атрибут ответа (contract) | Описание |
|---|---|
| id | Идентификатор договора |
| debtor | Идентификатор организации |
| isdefault | Договор по умолчанию |
| number | Номер договора |
| COMMISIONID | Идентификатор комиссии |
| DISCOUNTID | Идентификатор скидки |
GETHOTELSORGS — Организации отеля
Лицензия: Online (3:5)
Возвращает список организаций, связанных с отелем.
GETPACKAGEKINDS — Типы пакетов/тарифов
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
Запрос:
<?xml version="1.0" encoding="utf-8"?>
<GetPackageKinds langcode="RU"/>
SUBSCRIBE — Подписка на обновления
Лицензия: Online (3:5)
Подписывает внешнюю систему на получение уведомлений об изменениях.
UNSUBSCRIBE — Отмена подписки
Лицензия: Online (3:5)
Отменяет подписку на обновления.
CONFIRMSUBSCRIBE — Подтверждение получения обновлений
Лицензия: Online (3:5)
Подтверждает получение уведомлений.
GETGUESTLIST — Список гостей (для внешних систем)
Лицензия: Online (3:5)
Возвращает список гостей для интеграции с внешними системами (Сбербанк и др.)
GETRESERVATIONLIST — Список бронирований (для внешних систем)
Лицензия: Online (3:5)
Возвращает список бронирований для интеграции с HotelAdvisors и аналогичными системами.
FILE_UPLOAD — Загрузка файла
Лицензия: Online (3:5)
Загружает файл на сервер.
FILE_DOWNLOAD — Скачивание файла
Лицензия: Online (3:5)
Скачивает файл с сервера.
Методы для работы с питанием (MEALS)
MEALS_GET_LIST — Список питания
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| GUEST_FULLNAME | Нет | Имя гостя |
| DEBTOR_FULLNAME | Нет | Название организации |
| FOLIO | Нет | Идентификатор фолио |
| BOOKING_CODE | Нет | Код бронирования |
| langcode | Нет | Код языка |
| RESOURCE | Нет | Ресурс |
| START_ITEM | Нет | Начальная позиция |
| COUNT_ITEMS | Нет | Количество записей |
MEALS_GET_BY_IDENT — Питание по идентификатору
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| IDENT | Да | Идентификатор |
| DATETIME | Да | Дата и время |
| LANG | Нет | Код языка |
| IDENT_PHYSTYPE | Нет | Тип идентификатора |
| RESOURCE | Нет | Ресурс |
MEALS_POST — Проведение питания
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| ID | Да | Идентификатор записи |
| SHIFT | Да | Смена |
| POSTQUANT | Да | Количество для проведения |
| USER | Нет | Пользователь |
| langcode | Нет | Код языка |
MEALS_GET_LOG — Журнал питания
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| langcode | Нет | Код языка |
| RESOURCE | Нет | Ресурс |
| POST_KIND | Нет | Тип (0=все, 1=на месте, 2=на вынос, 3=сух.паёк) |
| from_datetime | Нет | Начало периода |
| to_datetime | Нет | Конец периода |
| USER_ID | Нет | Идентификатор сотрудника |
| GUEST_FULLNAME | Нет | Имя гостя |
Методы для работы с начислениями (FAP)
FAP_GET_BY_IDENT — Начисления по идентификатору
Лицензия: Online (3:5)
| Параметр запроса | Обяз. | Описание |
|---|---|---|
| IDENT | Да | Идентификатор |
| DATETIME | Да | Дата и время |
| LANG | Нет | Код языка |
FAP_POST — Проведение начислений
Лицензия: Online (3:5)
Проводит начисления по идентификатору.
FAP_GET_POST_LOG — Журнал начислений
Лицензия: Online (3:5)
Возвращает журнал проведённых начислений.
SQL-методы
Важно: Эти методы предоставляют прямой доступ к базе данных. Использование не рекомендуется и не поддерживается Shelter.
SQLSTART — Начало транзакции
Лицензия: Online (3:5)
Начинает SQL-транзакцию и возвращает её идентификатор.
SQLOPEN — Выполнение SELECT-запроса
Лицензия: Online (3:5)
Выполняет SELECT-запрос в контексте транзакции.
SQLEXEC — Выполнение запроса на изменение
Лицензия: Online (3:5)
Выполняет INSERT/UPDATE/DELETE запрос.
SQLSTOP — Завершение транзакции (COMMIT)
Лицензия: Online (3:5)
Фиксирует изменения транзакции.
SQLROLLBACK — Откат транзакции
Лицензия: Online (3:5)
Откатывает изменения транзакции.