Мастер-Тур(15):API для разработки онлайн поиска и бронирования

Версия статьи от 24-07-2018.

Поддерживаемые версии ПК «Мастер-Тур»: Начиная с 15 версии

Введение

Данный web-сервис разработан для разработки собственного сайта туроператору на основе API.

Установка

Для работы с web-сервисом необходимо установить службу поиска.
После установки web-сервис будет доступен по адресу http://значение настройки "serviceAddress" в TourSearchOwin/"название метода" (пример: http://localhost:9000/TourSearchOwin/Settings)

Список методов

Последовательность вызова методов сервиса

Авторизация (Token)

Метод производит получение авторизационного токена (описание стандарта).

• Формат запроса:
  • POST .../TourSearchOwin/Token?
• Принимаемые параметры POST запроса ( * – обязательный):
  • grant_type * – password
  • username * – логин представителя партнера
  • password * – пароль представителя партнера

• Возвращаемый результат:
  • access_token – токен
  • token_type – тип токена
  • expires_in – код
  • userKey – ключ пользователя
  • .issued – дата получения
  • .expires – дата действия до

Пример

Вызов метода Token POST http://localhost:9000/TourSearchOwin/Token HTTP/1.1 Content-Type: application/x-www-form-urlencoded grant_type=password&username=test&password=1 Возвращаемый результат метода TransportPlan (в формате JSON) { "access_token": "AQAAANCMnd8BFdERjHoAwE_Cl-sBAAAAdsCC8X7m9E-2bg0-uS0VfgAAAAAAAAADZgAAwAAAA- EqAAAAAASAAACgAAAAEAAAAO4S-VrqBhQuhqliqrAKKfIgAQAAn-gfgP-rYjk-Krr1Ck2A-IGCw6FBhamUOzFxgTtk1hR- GLMryFIH8VK5GmHdHubZWj4S7XcazGL1Kn5-VlbiYdW2ZVWpYlk638aV-XS2kpZ9YrKgViiM_x8RH5TPo4- 9LhE7V-SjiB_CP_qs58DRKcyohq3Tz9QaiFgH1Ko7O2XKjTBG7SHyQPDPYjaqg9kDxmzq0UcIT6Fm4YkDxmm9- CW7u3cEFWcpiqKOc2VvZFKPPHc07uDOO4w9FXPhpXZwOqrJBxzhbr73RuhzPs_e-hgxKaIlsMaK5b0v5ReAMy1kuY0ebXA",", "token_type": "bearer", "expires_in": 1209599, "userKey": "333", ".issued": "Thu, 05 Apr 2018 12:05:31 GMT", ".expires": "Thu, 19 Apr 2018 12:05:31 GMT" }

Выгрузка настроек службы поиска (Settings)

Метод производит выгрузку настроек службы поиска.

• Формат запроса:
  • GET .../TourSearchOwin/Settings?
• Принимаемые параметры:
  • нет принимаемых параметров
• Возвращаемый результат:
  • ChildAgesSetting – регулируется настройкой максимальный возраст ребенка (массив возрастов, при которых турист будет считаться ребенком
  • DurationSetting – регулируется настройкой максимальная продолжительность тура (массив продолжительностей, доступных в фильтрах для поиска)
  • RoundServiceSetting – признак округления цены (количество знаков после запятой)
  • CacheReady – статус готовности службы поиска к работе (true/false)
  • EnableFiterTree – устаревшая настройка, будет убрана (по умолчанию всегда false)
  • EnableActualFilters – включены ли актуальные фильтры (true/false)
  • CorrectLicense – проверка лицензии (true/false)
  • CorrectLicenseMessage – сообщение, если проверка лицензии не прошла
  • IsCorrectUser – проверка наличия пользователя в таблице Userlist, под которым запущена служба поиска (true/false)
  • IsShowCitizenAuthTourist – настройка запрашивать гражданство при регистрации частного лица (true/false)
  • IsShowFewCountPlaces – настройка отображения числового значения оставшихся мест, когда достигнуто значение «Мало» (true/false)
  • IsShowBusTransferPlaces – использовать фильтр наличие мест на автобусный переезд в поиске (true/false)
  • UseBusSeatChecks – план рассадки автобусного переезда (0 – не отображать, 1 – отображать без проверки, 2 – отображать с проверкой)
  • UseTransferSeatChecks – план рассадки трансфера (0 – не отображать, 1 – отображать без проверки, 2 – отображать с проверкой)
  • IsShowFiltersByCity – отображать фильтр по городам на главной странице поиска (true/false)
  • CheckRealCourses – включена ли проверка курсов реальных валют при поиске (true/false)
  • CommonImagesFolderPath – путь к папке для хранения изображений
  • UseApplyFiltersButton – отображать кнопку «Применить фильтры» (true/false)
  • AutoSearchFiltersTimeout – задержка между выбором дополнительных фильтров и выводом результатов (в секундах)
  • UseFastSearchAlgoritm – использовать быстрый алгоритм поиска (true/false)
  • MaxSearchDatesCountClient – максимальное количество дат, которое будет обрабатываться в клиенте поиска
  • MaxDurationsCountClient – максимальное количество продолжительностей, которое будет обрабатываться в клиенте поиска

Пример

Вызов метода Settings GET http://localhost:9000/TourSearchOwin/Settings Возвращаемый результат метода Settings (в формате JSON) { "ChildAgesSetting": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ], "DurationSetting": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ], "RoundServiceSetting": 2, "CacheReady": true, "EnableFiterTree": false, "EnableActualFilters": true, "CorrectLicense": true, "CorrectLicenseMessage": "0deb1f882da1ec6301c961780507a180", "IsCorrectUser": true, "IsShowCitizenAuthTourist": true, "IsShowFewCountPlaces": true, "IsShowBusTransferPlaces": true, "UseBusSeatChecks": 1, "UseTransferSeatChecks": 2, "IsShowFiltersByCity": true, "CheckRealCourses": true, "CommonImagesFolderPath": "\\\\server\\Icons", "UseApplyFiltersButton": false, "AutoSearchFiltersTimeout": 1, "UseFastSearchAlgoritm": true, "MaxSearchDatesCountClient": 10, "MaxDurationsCountClient": 14 }

Выгрузка списка валют (Currency)

Метод возвращает список используемых валют.

• Формат запроса:
  • GET .../TourSearchOwin/Currency
• Принимаемые параметры:
  • нет принимаемых параметров
• Возвращаемый результат:
  • Code – код валюты
  • Name – наименование валюты
  • IsMain – признак валюты «Главная»
  • IsNational – признак валюты «Национальная»
  • IsoCode – ISO код валюты
  • Key – идентификатор валюты
  • IsShowInSearch – признак показывать ли валюту в поиске

Пример

Вызов метода Currency GET http://localhost:9000/TourSearchOwin/Currency Возвращаемый результат метода Currency (в формате JSON) [ { "Code": "EU", "Name": "Euro", "IsMain": false, "IsNational": false, "IsoCode": "EUR", "Key": 2, "IsShowInSearch": true }, { "Code": "рб", "Name": "Рубль", "IsMain": false, "IsNational": true, "IsoCode": "RUR", "Key": 14, "IsShowInSearch": true }, { "Code": "$", "Name": "US Dollar", "IsMain": true, "IsNational": false, "IsoCode": "USD", "Key": 1, "IsShowInSearch": true } ]

Выгрузка квотируемых услуг системы (QuotedServices)

Метод производит выгрузку услуг с признаком «Квотируемая»

• Формат запроса:
  • GET .../TourSearchOwin/QuotedServices
• Принимаемые параметры:
  • нет принимаемых параметров
• Возвращаемый результат:
  • Key – идентификатор услуги
  • Code – код услуги
  • Name – наименование услуги (русский)
  • NameLat – наименование услуги (английский)
  • IsDuration – наличие продолжительности у услуги
  • IsCity – наличие города у услуги
  • IsSubCode1 – признак наличия SubCode1 у услуги (вид проживания у отеля, тариф у авиаперелета)
  • IsSubCode2 – признак наличия SubCode2 у услуги (тип питания у отеля)
  • Quoted – признак квотируемости услуги
  • CheckGeoPoint – наличие геоточек у услуги
  • IsRoute – признак маршрутной услуги
  • IsPartnerBasedOn – признак сопоставления партнера услуги в зависимости от отеля
  • Control – идентификатор статуса услуги

Пример

Вызов метода QuotedServices GET http://localhost:9000/TourSearchOwin/QuotedServices Возвращаемый результат метода QuotedServices (в формате JSON) [ { "Key": 1, "Code": "А_П", "Name": "Авиаперелет", "NameLat": "Flight", "IsDuration": false, "IsCity": true, "IsSubCode1": true, "IsSubCode2": false, "Quoted": true, "CheckGeoPoint": true, "IsRoute": true, "IsPartnerBasedOn": false, "Control": 1 }, { "Key": 3, "Code": "HOTEL", "Name": "Отель/Круиз", "NameLat": "Hotel/Cruise", "IsDuration": true, "IsCity": true, "IsSubCode1": true, "IsSubCode2": true, "Quoted": true, "CheckGeoPoint": true, "IsRoute": true, "IsPartnerBasedOn": false, "Control": 1 } ]

Выгрузка городов отправления (departureCities)

Метод производит выгрузку всех доступных городов отправления для поискового запроса.

• Формат запроса:
  • GET .../TourSearchOwin/departureCities?
• Принимаемые параметры:
  • нет принимаемых параметров
• Возвращаемый результат:
  • Key – идентификатор города
  • Name – название города

Пример

Вызов метода departureCities GET http://localhost:9000/TourSearchOwin/departureCities Возвращаемый результат метода departureCities (в формате JSON) [ { "Key": -1, "Name": "Без перелета" }, { "Key": 312, "Name": "Астрахань" }, { "Key": 1, "Name": "Москва" } ]

Выгрузка списка стран (Destination)

Метод производит выгрузку всех доступных направлений туроператора.

• Формат запроса:
  • GET .../TourSearchOwin/Destination?
• Принимаемые параметры ( * – обязательный):
  • term * – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
  • departureCities * – идентификатор города отправления (из контроллера .../TourSearchOwin/departureCities?)
• Возвращаемый результат:
  • Name – название страны
  • Key – идентификатор страны
  • DestinationType – тип результата (всегда возвращается в JSON = 1, в xml = country)

Пример

Вызов метода Destination GET http://localhost:9000/TourSearchOwin/Destination?pageNumber=1&term=&showAll=false&departureCities=1 Возвращаемый результат метода Destination (в формате JSON) [ { "Name": "Болгария", "Key": 359, "DestinationType": 1 }, { "Name": "Индия", "Key": 26, "DestinationType": 1 }, { "Name": "Финляндия", "Key": 64, "DestinationType": 1 } ]

Выгрузка списка городов (ActualizeCities)

Метод возвращает список всех доступных городов по определенному городу отправления и стране прибытия.

• Формат запроса:
  • GET .../TourSearchOwin/ActualizeCities?
• Принимаемые параметры ( * – обязательный):
  • cityKeys * – идентификатор города отправления (полученный из метода .../TourSearchOwin/departureCities?)
  • Key * – идентификатор страны прибытия (полученный из метода .../TourSearchOwin/Destination?)
  • Name * – название страны прибытия (полученный из метода .../TourSearchOwin/Destination?)
  • term * – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
• Возвращаемый результат:
  • Key – идентификатор города
  • Name – название города

Пример

Вызов метода ActualizeCities GET http://localhost:9000/TourSearchOwin/ActualizeCities?cityKeys=1&Key=90&Name=Австрия&term= Возвращаемый результат метода ActualizeCities (в формате JSON) [ { "Key": -1, "Name": "Все" }, { "Key": 35, "Name": "Вена" }, { "Key": 440, "Name": "Зельден" } ]

Выгрузка типов туров (ActualizeTourType)

Метод возвращает список типов туров по определенному городу отправления, стране и городу прибытия.

• Формат запроса:
  • GET .../TourSearchOwin/ActualizeTourType?
• Принимаемые параметры ( * – обязательный):
  • departureCityKeys * – идентификатор города отправления (полученный из метода .../TourSearchOwin/departureCities?)
  • Key * – идентификатор страны прибытия (полученный из метода .../TourSearchOwin/Destination?)
  • Name * – название страны прибытия (полученный из метода .../TourSearchOwin/Destination?)
  • Type * – тип результата (всегда возвращается в JSON = 1, в xml = country)
  • destinationCity * – идентификатор города прибытия (полученный из метода .../TourSearchOwin/ActualizeCities?), по умолчанию передается -1, то есть все города в рамках данной страны
  • terms * – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
• Возвращаемый результат:
  • Key – идентификатор типа тура
  • Name – название типа тура
  • ParentId – идентификатор группы, к которой относится данный типа тура (если тип тура не относится к группе, то возвращается null)

Пример

Вызов метода ActualizeTourType GET http://localhost:9000/TourSearchOwin/ActualizeTourType?departureCityKeys=1&Key=90&Name=Австрия&Type=1&destinationCity=-1&terms= Возвращаемый результат метода ActualizeTourType (в формате JSON) [ { "Key": -1, "Name": "Все", "ParentId": null }, { "Key": 2, "Name": "Стандартный тур", "ParentId": null }, { "Key": 16, "Name": "Экскурсионный тур", "ParentId": 35 } ]

Выгрузка актуальных дат заездов (TourDate)

Метод производит выгрузку доступных дат заездов для поискового запроса.

• Формат запроса:
  • GET .../TourSearchOwin/TourDate?
• Принимаемые параметры ( * – обязательный):
  • departureCity * – идентификатор города отправления (полученный из метода .../TourSearchOwin/departureCities?)
  • destinationCity * – идентификатор города прибытия (полученный из метода .../TourSearchOwin/ActualizeCities?), по умолчанию передается -1, то есть все города в рамках данной страны
  • Key * – идентификатор страны прибытия (полученный из метода .../TourSearchOwin/Destination?)
  • Name * – название страны прибытия (полученный из метода .../TourSearchOwin/Destination?)
  • Type * – тип результата (всегда возвращается в JSON = 1, в xml = country)
  • tourTypes * – идентификатор типа тура (полученный из метода .../TourSearchOwin/ActualizeTourType?), по умолчанию передается -1, то есть все типы тура в рамках данной страны
  • term * – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
• Возвращаемый результат:
  • массив дат

Пример

Вызов метода TourDate GET http://localhost:9000/TourSearchOwin/TourDate?departureCity=1&destinationCity=-1&Key=90&Name=Австрия&Type=1&tourTypes=-1&term= Возвращаемый результат метода TourDate (в формате JSON) [ "21.02.2018", "22.02.2018", "23.02.2018", "24.02.2018", "25.02.2018", "26.02.2018", "27.02.2018", "28.02.2018" ]

Выгрузка актуальных продолжительностей (Duration)

Метод производит выгрузку доступных продолжительностей для поискового запроса.

• Формат запроса:
  • GET .../TourSearchOwin/Duration?
• Принимаемые параметры ( * – обязательный):
  • departureCity * – идентификатор города отправления (полученный из метода .../TourSearchOwin/departureCities?)
  • destinationCity * – идентификатор города прибытия (полученный из метода .../TourSearchOwin/ActualizeCities?), по умолчанию передается -1, то есть все города в рамках данной страны
  • Key * – идентификатор страны прибытия (полученный из метода .../TourSearchOwin/Destination?)
  • Name * – название страны прибытия (полученный из метода .../TourSearchOwin/Destination?)
  • Type * – тип результата (всегда возвращается в JSON = 1, в xml = country)
  • tourDate * – массив дат заезда (полученные из метода .../TourSearchOwin/TourDate?). Если параметры передаются через url, то каждое значение необходимо передавать отдельным параметром.
  • tourTypes * – идентификатор типа тура (полученный из метода .../TourSearchOwin/ActualizeTourType?), по умолчанию передается -1, то есть все типы тура в рамках данной страны
  • term * – фильтрация результатов по контекстному поиску (по умолчанию параметр пустой)
• Возвращаемый результат:
  • массив продолжительностей

Пример

Вызов метода Duration GET http://localhost:9000/TourSearchOwin/Duration?departureCity=1&destinationCity=-1&Key=90 &Name=Австрия&Type=1&tourDate=25.02.2018&tourDate=26.02.2018&tourTypes=-1&term= Возвращаемый результат метода Duration (в формате JSON) [ 7, 8, 10, 12, 15, 18 ]

Поиск туров (Tour)

Метод поиска туров использует множество параметров для поиска и фильтрации туров. Метод возвращает наиболее дешевые предложения, найденные по предоставленным параметрам и сгруппированные по отелям в порядке возрастания цены.

• Формат запроса:
  • GET .../TourSearchOwin/Tour?
• Принимаемые параметры ( * – обязательный):
  • DepartureCityKeys * – идентификатор города отправления (полученный из метода