Мастер-Тур(15):API для разработки онлайн поиска и бронирования — различия между версиями
| [досмотренная версия] | [досмотренная версия] |
Biryukov (обсуждение | вклад) (→Выгрузка актуальных продолжительностей (Duration)) |
Biryukov (обсуждение | вклад) (→Установка) |
||
| (не показано 235 промежуточных версий 11 участников) | |||
| Строка 7: | Строка 7: | ||
==Введение== | ==Введение== | ||
| − | Данный web-сервис | + | Данный web-сервис служит для разработки собственного сайта туроператору на основе API. |
==Установка== | ==Установка== | ||
Для работы с web-сервисом необходимо на отдающей стороне установить [[Мастер-Тур(15):Установка#Установка службы поиска|службу поиска]].<br /> | Для работы с web-сервисом необходимо на отдающей стороне установить [[Мастер-Тур(15):Установка#Установка службы поиска|службу поиска]].<br /> | ||
После установки web-сервис будет доступен по адресу ''<nowiki>http://значение настройки "serviceAddress" в TourSearchOwin/"название метода"</nowiki>'' (пример: ''http://localhost:9000/TourSearchOwin/Settings'') | После установки web-сервис будет доступен по адресу ''<nowiki>http://значение настройки "serviceAddress" в TourSearchOwin/"название метода"</nowiki>'' (пример: ''http://localhost:9000/TourSearchOwin/Settings'') | ||
| + | |||
| + | ==Swagger== | ||
| + | Работу методов можно проверить с помощью Swagger по пути: ''http://localhost:9000/TourSearchOwin/SwaggerUI'' | ||
==Список методов== | ==Список методов== | ||
| Строка 17: | Строка 20: | ||
Последовательность вызова методов сервиса<br /> | Последовательность вызова методов сервиса<br /> | ||
[[Файл:mb_273.png|1000px|Последовательность вызова методов сервиса]] | [[Файл:mb_273.png|1000px|Последовательность вызова методов сервиса]] | ||
| + | |||
| + | ===Информация о состоянии службы поиска (statusCache)=== | ||
| + | Метод выводит информацию о состоянии службы поиска при ее загрузке. | ||
| + | * Формат запроса: | ||
| + | ** GET .../TourSearchOwin/statusCache? | ||
| + | * Принимаемые параметры: | ||
| + | ** нет принимаемых параметров | ||
| + | * Возвращаемый результат: | ||
| + | ** '''Initialized''' – информация о том, загружена ли служба или нет ('''false''' – инициализация кешей не завершена, '''true''' – инициализация кешей завершена) | ||
| + | ** '''Status''' – состояние службы. Возможные значения: ''Запущена инициализация кэшей'', ''Инициализация кэшей завершена'' | ||
| + | ** '''CacheName''' – информация о том, какой именно кеш сейчас считается (название) | ||
| + | ** '''Iteration''' – порядковый номер считаемого справочника кеша | ||
| + | ** '''CacheCount''' – общее количество кешей | ||
| + | ** '''ProcessMessage''' – детализация. Информацию можно разделить на 3 блока: | ||
| + | *** Загрузка всех справочных данных, кроме расчета маршрутов и актуальных фильтров. В этом случае сообщение будет ''Загрузка кэшей из БД'' | ||
| + | *** Расчет маршрутов. ''CacheName'' – ''HotelScheme'', сообщение будет ''tours load: 956 / 1234'' | ||
| + | *** Расчет актуальных фильтров. ''CacheName'' – ''ActualFilters'', сообщение будет ''Actual filter processed: 783012 / 3865687"'' | ||
| + | |||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | ||
| + | <div class="mw-collapsible-content"> | ||
| + | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | ||
| + | Вызов метода Settings | ||
| + | <syntaxhighlight lang="java" enclose="div"> | ||
| + | GET http://localhost:9000/TourSearchOwin/statusCache | ||
| + | </syntaxhighlight> | ||
| + | Возвращаемый результат метода statusCache (в формате JSON) | ||
| + | <syntaxhighlight lang="java" enclose="div"> | ||
| + | { | ||
| + | "Initialized": false, | ||
| + | "Status": "Запущена инициализация кэшей", | ||
| + | "CacheName": "ToursSearchView", | ||
| + | "Iteration": 10, | ||
| + | "CacheCount": 112, | ||
| + | "ProcessMessage": "Загрузка кэшей из БД" | ||
| + | } | ||
| + | { | ||
| + | "Initialized": false, | ||
| + | "Status": "Запущена инициализация кэшей", | ||
| + | "CacheName": "HotelScheme", | ||
| + | "Iteration": 109, | ||
| + | "CacheCount": 112, | ||
| + | "ProcessMessage": "tours load: 956 / 1234" | ||
| + | } | ||
| + | { | ||
| + | "Initialized": false, | ||
| + | "Status": "Запущена инициализация кэшей", | ||
| + | "CacheName": "ActualFilters", | ||
| + | "Iteration": 112, | ||
| + | "CacheCount": 112, | ||
| + | "ProcessMessage": "Actual filter processed: 783012 / 3865687" | ||
| + | } | ||
| + | { | ||
| + | "Initialized": true, | ||
| + | "Status": "Инициализация кэшей завершена", | ||
| + | "CacheName": null, | ||
| + | "Iteration": 0, | ||
| + | "CacheCount": 0, | ||
| + | "ProcessMessage": null | ||
| + | } | ||
| + | </syntaxhighlight> | ||
| + | </TD></TR></TABLE> | ||
| + | </div></div><br /> | ||
===Авторизация (Token)=== | ===Авторизация (Token)=== | ||
| Строка 75: | Строка 140: | ||
** нет принимаемых параметров | ** нет принимаемых параметров | ||
* Возвращаемый результат: | * Возвращаемый результат: | ||
| − | ** '''ChildAgesSetting''' – регулируется настройкой [[Мастер-Тур(15):Программа туров. | + | ** '''ChildAgesSetting''' – регулируется настройкой [[Мастер-Тур(15):Программа туров. Настройки|максимальный возраст ребенка]] (массив возрастов, при которых турист будет считаться ребенком |
| − | ** '''DurationSetting''' – регулируется настройкой [[Мастер-Тур(15):Программа туров. | + | ** '''DurationSetting''' – регулируется настройкой [[Мастер-Тур(15):Программа туров. Настройки|максимальная продолжительность тура]] (массив продолжительностей, доступных в фильтрах для поиска) |
** '''RoundServiceSetting''' – признак округления цены (количество знаков после запятой) | ** '''RoundServiceSetting''' – признак округления цены (количество знаков после запятой) | ||
** '''CacheReady''' – статус готовности службы поиска к работе (true/false) | ** '''CacheReady''' – статус готовности службы поиска к работе (true/false) | ||
| Строка 97: | Строка 162: | ||
** '''MaxSearchDatesCountClient''' – максимальное количество дат, которое будет обрабатываться в клиенте поиска | ** '''MaxSearchDatesCountClient''' – максимальное количество дат, которое будет обрабатываться в клиенте поиска | ||
** '''MaxDurationsCountClient''' – максимальное количество продолжительностей, которое будет обрабатываться в клиенте поиска | ** '''MaxDurationsCountClient''' – максимальное количество продолжительностей, которое будет обрабатываться в клиенте поиска | ||
| − | + | ** '''UseHotelCategoryGlobalCodeInDopFilter''' – использовать глобальные коды категорий отелей в поиске | |
| + | ** '''UsePansionGlobalCodeInDopFilter''' – использовать глобальные коды питаний в поиске | ||
| + | ** '''CheckTouristDataInBasket''' – проверять корректность данных туристов | ||
| + | ** '''SimpleRegistration''' – упрощенная регистрация частного лица | ||
| + | ** '''ShowHotelImagesInSearch''' – показывать описание и изображения отелей в поиске | ||
| + | ** '''CacheReadyMessage''' – сообщение о готовности службы поиска или службы расчета актуальных фильтров. Варианты возвращаемых значений: | ||
| + | *** ''<add key="enableActualFilters" value="true" />'' - CacheReady: true = CacheReadyMessage: "Кеш инициализирован"; CacheReady: false = CacheReadyMessage: "Кеш еще не инициализирован" | ||
| + | *** ''<add key="enableActualFilters" value="false" />'' - Служба актуальных фильтров недоступна (выключена, неверно указана ссылка на нее и т.п.) CacheReadyMessage: "Служба актуальных фильтров недоступна"; Служба актуальных фильтров доступна но не готова - CacheReadyMessage: "Кеш службы актуальных фильтров не инициализирован"; Служба актуальных фильтров готова, а основная служба не готова - CacheReadyMessage: "Кеш ещё не инициализирован"; Служба актуальных фильтров готова, и основная служба готова - CacheReadyMessage: "Кеш ещё инициализирован". | ||
| + | ** '''nodeId''' – уникальный идентификатор узла в кластере балансировки нагрузки [[Мастер-Тур(15):Балансировщик нагрузки HaProxy|HaProxy]] | ||
| + | ** '''FullPaymentPeriod''' – полная оплата с даты бронирования (может быть null) | ||
| + | ** '''FullPaymentCheckin''' – полная оплата до даты заезда (может быть null) | ||
| + | ** '''PrePaymentPeriod''' – предоплата с даты бронирования (может быть null) | ||
| + | ** '''PrePaymentCheckin''' – предоплата до даты заезда (может быть null) | ||
| + | ** '''PrePaymentCu"''' – значение предоплаты в y.e. (может быть null) | ||
| + | ** '''PrePaymentPercent''' – значение предоплаты в процентах (может быть null) | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | ||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
| Строка 168: | Строка 247: | ||
"MaxSearchDatesCountClient": 10, | "MaxSearchDatesCountClient": 10, | ||
"MaxDurationsCountClient": 14 | "MaxDurationsCountClient": 14 | ||
| + | "UseHotelCategoryGlobalCodeInDopFilter": false | ||
| + | "UsePansionGlobalCodeInDopFilter": false | ||
| + | "CheckTouristDataInBasket": true | ||
| + | "SimpleRegistration": false | ||
| + | "ShowHotelImagesInSearch": true | ||
| + | "CacheReadyMessage": "Кеш инициализирован" | ||
| + | "nodeId": 2147483647, | ||
| + | "FullPaymentPeriod": null, | ||
| + | "FullPaymentCheckin": 5, | ||
| + | "PrePaymentPeriod": null, | ||
| + | "PrePaymentCheckin": 10, | ||
| + | "PrePaymentPercent": 50.0, | ||
| + | "PrePaymentCu": null | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Строка 173: | Строка 265: | ||
</div></div><br /> | </div></div><br /> | ||
| − | ===Выгрузка списка валют (Currency)=== | + | ===Выгрузка списка валют в онлайне (Currency)=== |
Метод возвращает список используемых валют. | Метод возвращает список используемых валют. | ||
* Формат запроса: | * Формат запроса: | ||
| Строка 185: | Строка 277: | ||
** '''IsNational''' – признак валюты «Национальная» | ** '''IsNational''' – признак валюты «Национальная» | ||
** '''IsoCode''' – ISO код валюты | ** '''IsoCode''' – ISO код валюты | ||
| + | ** '''IsShowInSearch''' – признак показывать ли валюту в поиске | ||
| + | ** '''Symbol''' – символ валюты (обрабатывается с 15.7) | ||
** '''Key''' – идентификатор валюты | ** '''Key''' – идентификатор валюты | ||
| − | + | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | ||
| Строка 204: | Строка 298: | ||
"IsNational": false, | "IsNational": false, | ||
"IsoCode": "EUR", | "IsoCode": "EUR", | ||
| − | " | + | "IsShowInSearch": true, |
| − | " | + | "Symbol": "€", |
| + | "Key": 2 | ||
}, | }, | ||
{ | { | ||
| Строка 213: | Строка 308: | ||
"IsNational": true, | "IsNational": true, | ||
"IsoCode": "RUR", | "IsoCode": "RUR", | ||
| − | " | + | "IsShowInSearch": true, |
| − | " | + | "Symbol": "₽", |
| + | "Key": 14 | ||
}, | }, | ||
{ | { | ||
| Строка 222: | Строка 318: | ||
"IsNational": false, | "IsNational": false, | ||
"IsoCode": "USD", | "IsoCode": "USD", | ||
| − | " | + | "IsShowInSearch": true, |
| − | " | + | "Symbol": "$", |
| + | "Key": 1 | ||
} | } | ||
] | ] | ||
| Строка 230: | Строка 327: | ||
</div></div><br /> | </div></div><br /> | ||
| − | ===Выгрузка | + | |
| − | Метод | + | ===Выгрузка курсов валют (CurrencyRates) начиная с 15.7=== |
| + | Полный аналог метода [[Мастер-Тур(15):API для отдачи цен в поисковые системы#Выгрузка курсов валют (GetCurrencyRates)|Выгрузка курсов валют (GetCurrencyRates)]]<br /> | ||
| + | Метод возвращает список курсов валют, актуальных на дату запроса. Курсы отображаются только для тех валют, которые отмечены в справочнике признаком ''Отображать в онлайне'' | ||
* Формат запроса: | * Формат запроса: | ||
| − | ** GET .../TourSearchOwin/ | + | ** GET .../TourSearchOwin/CurrencyRates |
* Принимаемые параметры: | * Принимаемые параметры: | ||
| − | ** | + | ** '''dateFrom''' – начальная дата, от которой вывести список курсов валют, в формате DD.MM.YYYY, необязательный параметр (если не указан, берется за текущий день) |
| + | ** '''dateTo''' – конечная дата, до которой вывести список курсов валют, в формате DD.MM.YYYY, необязательный параметр (если не указан, берется за текущий день) | ||
| + | ** '''otherBaseCurrencyId''' – идентификатор любой валюты, эмулирующей работу национальной валюты, необязательный параметр. Если заполнен, то в результатах выдачи параметр ''baseCurrencyId'' будет заменяться на валюту из параметра ''otherBaseCurrencyId'' (обрабатывается с релиза 15.9). | ||
| + | |||
* Возвращаемый результат: | * Возвращаемый результат: | ||
| − | ** ''' | + | ** '''baseCurrencyId''' – идентификатор национальной валюты, либо произвольной валюты, указанной в настройке ''basketCurrency'' в конфигурационном файле (обрабатывается с релиза 15.6) |
| − | + | ** '''currencyId''' – идентификатор валюты, курс которой приводится | |
| − | + | ** '''rate''' – курс валюты (отношение '''currencyId''' к '''baseCurrencyId''') | |
| − | ** ''' | + | ** '''date''' – дата, на которую был зарегистрирован выводимый курс валюты |
| − | + | ||
| − | + | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | |
| − | + | <div class="mw-collapsible-content"> | |
| − | ** ''' | + | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> |
| − | + | Вызов метода CurrencyRates | |
| − | + | <syntaxhighlight lang="java" enclose="div"> | |
| − | ** ''' | + | http://localhost:9000/TourSearchOwin/CurrencyRates?dateFrom=18.09.2024&dateTo=19.09.2024 |
| − | |||
| − | |||
| − | |||
| − | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | ||
| − | <div class="mw-collapsible-content"> | ||
| − | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | ||
| − | Вызов метода | ||
| − | <syntaxhighlight lang="java" enclose="div"> | ||
| − | |||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | Возвращаемый результат метода | + | Возвращаемый результат метода CurrencyRates (в формате JSON) |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
[ | [ | ||
| − | + | { | |
| − | + | "BaseCurrencyId": 14, | |
| − | + | "CurrencyId": 1, | |
| − | + | "Rate": 91.429200, | |
| − | + | "Date": "18.09.2024" | |
| − | + | }, | |
| − | + | { | |
| − | + | "BaseCurrencyId": 14, | |
| − | + | "CurrencyId": 2, | |
| − | + | "Rate": 101.505700, | |
| − | + | "Date": "18.09.2024" | |
| − | + | }, | |
| − | + | { | |
| − | + | "BaseCurrencyId": 14, | |
| − | + | "CurrencyId": 1, | |
| − | + | "Rate": 91.671200, | |
| − | + | "Date": "19.09.2024" | |
| − | + | }, | |
| − | + | { | |
| − | + | "BaseCurrencyId": 14, | |
| − | + | "CurrencyId": 2, | |
| − | + | "Rate": 102.039000, | |
| − | + | "Date": "19.09.2024" | |
| − | + | } | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
] | ] | ||
| + | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</TD></TR></TABLE> | </TD></TR></TABLE> | ||
</div></div><br /> | </div></div><br /> | ||
| − | ===Выгрузка | + | ===Выгрузка списка всех валют (getAllCurrencies)=== |
| − | Метод | + | Метод возвращает список всех валют. |
* Формат запроса: | * Формат запроса: | ||
| − | ** GET .../TourSearchOwin/ | + | ** GET .../TourSearchOwin/AllCurencies/getAllCurrencies |
* Принимаемые параметры: | * Принимаемые параметры: | ||
** нет принимаемых параметров | ** нет принимаемых параметров | ||
* Возвращаемый результат: | * Возвращаемый результат: | ||
| − | ** ''' | + | ** '''Code''' – код валюты |
| − | ** '''Name''' – | + | ** '''Name''' – наименование валюты |
| + | ** '''IsMain''' – признак валюты «Главная» | ||
| + | ** '''IsNational''' – признак валюты «Национальная» | ||
| + | ** '''IsoCode''' – ISO код валюты | ||
| + | ** '''IsShowInSearch''' – признак показывать ли валюту в поиске | ||
| + | ** '''Symbol''' – символ валюты (обрабатывается с 15.7) | ||
| + | ** '''Key''' – идентификатор валюты | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | ||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | ||
| − | Вызов метода | + | Вызов метода getAllCurrencies |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
| − | GET http://localhost:9000/TourSearchOwin/ | + | GET http://localhost:9000/TourSearchOwin/AllCurencies/getAllCurrencies |
</syntaxhighlight> | </syntaxhighlight> | ||
| − | Возвращаемый результат метода | + | Возвращаемый результат метода getAllCurrencies (в формате JSON) |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
[ | [ | ||
{ | { | ||
| − | " | + | "Code": "EU", |
| − | "Name": " | + | "Name": "Euro", |
| + | "IsMain": false, | ||
| + | "IsNational": false, | ||
| + | "IsoCode": "EUR", | ||
| + | "IsShowInSearch": true, | ||
| + | "Symbol": "€", | ||
| + | "Key": 2 | ||
}, | }, | ||
{ | { | ||
| − | " | + | "Code": "рб", |
| − | "Name": " | + | "Name": "Рубль", |
| + | "IsMain": false, | ||
| + | "IsNational": true, | ||
| + | "IsoCode": "RUR", | ||
| + | "IsShowInSearch": true, | ||
| + | "Symbol": "₽", | ||
| + | "Key": 14 | ||
}, | }, | ||
{ | { | ||
| − | "Key": 1, | + | "Code": "$", |
| − | + | "Name": "US Dollar", | |
| + | "IsMain": true, | ||
| + | "IsNational": false, | ||
| + | "IsoCode": "USD", | ||
| + | "IsShowInSearch": true, | ||
| + | "Symbol": "$", | ||
| + | "Key": 1 | ||
| + | }, | ||
| + | { | ||
| + | "Code": "гр", | ||
| + | "Name": "Гривна", | ||
| + | "IsMain": false, | ||
| + | "IsNational": false, | ||
| + | "IsoCode": "UAH", | ||
| + | "IsShowInSearch": true, | ||
| + | "Symbol": "₴", | ||
| + | "Key": 6 | ||
} | } | ||
] | ] | ||
| Строка 333: | Строка 455: | ||
</div></div><br /> | </div></div><br /> | ||
| − | === | + | |
| − | Метод | + | ===Получение сконвертированных цен (convertFilterPrice)=== |
| + | Метод возвращает сконвертированные цен для допфильтра ''Цена'' (используется в canary) | ||
* Формат запроса: | * Формат запроса: | ||
| − | ** GET .../TourSearchOwin/ | + | ** GET .../TourSearchOwin/AllCurencies/convertFilterPrice |
* Принимаемые параметры ( '''*''' – обязательный): | * Принимаемые параметры ( '''*''' – обязательный): | ||
| − | ** ''' | + | ** '''SourceRateKey *''' – ключ исходной валюты конвертации |
| − | ** ''' | + | ** '''TargetRateKey *''' – ключ валюты, в которую будет произведена конвертация |
| + | ** '''MinPrice *''' – значение минимальной цены, которое будет участвовать в конвертации | ||
| + | ** '''MaxPrice *''' – значение максимальной цены, которое будет участвовать в конвертации | ||
* Возвращаемый результат: | * Возвращаемый результат: | ||
| − | ** ''' | + | ** '''m_Item1''' – сконвертированная минимальная цена |
| − | ** ''' | + | ** '''m_Item12''' – сконвертированная максимальная цена |
| − | |||
<div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Пример | ||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | ||
| − | Вызов метода | + | Вызов метода convertFilterPrice |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
| − | GET http://localhost:9000/TourSearchOwin/ | + | GET http://localhost:9000/TourSearchOwin/AllCurencies/convertFilterPrice?SourceRateKey=2&TargetRateKey=1& |