Мастер-Тур(15):API для отдачи цен в поисковые системы

Версия статьи от 15-07-2020.

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

Введение

Данный web-сервис разработан для отдачи цен во внешние поисковые системы и выполняет следующие задачи:

• выгружает справочники (города вылета, страны, города, отели и т.д.)
• осуществляет поиск цен с указанныеми параметрами
• актуализирует выбранный вариант тура по его идентификатору

Выдача результатов осуществляется в формате JSON

Установка

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

Загрузка справочников

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

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

• Формат запроса:
  •  ?action=GetCountries
• Принимаемые параметры:
  • id – идентификатор страны (опциональный, передача в запрос нескольких id не обрабатывается, в этом случае возвращаются все результаты. Если указан, то запрашивается только одна запись)
• Возвращаемый результат:
  • id – идентификатор страны
  • name – название страны (рус)
  • lname – название страны (анг)

Пример

Вызов метода GetCountries http://localhost:9000/TourSearchOwin/searchApi?action=GetCountries Возвращаемый результат метода GetCountries (в формате JSON) { "version": "1.08", "countries": [ { "id": 97, "name": "Тунис", "lname": "Tunisia" }, { "id": 90, "name": "Австрия", "lname": "Австрия" }, { "id": 30, "name": "Франция", "lname": "France" } ] }

Выгрузка списка городов вылета (GetDepartCities)

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

• Формат запроса:
  •  ?action=GetDepartCities
• Принимаемые параметры:
  • id – идентификатор города вылета (опциональный, передача в запрос нескольких id не обрабатывается, в этом случае возвращаются все результаты. Если указан, то запрашивается только одна запись)
• Возвращаемый результат:
  • id – идентификатор города
  • name – название города (рус)
  • lname – название города (анг)
  • countriesTo – идентификаторы стран, которые присутствуют в данном городе вылета
  • countryId – идентификатор страны города вылета
  • countryName – название страны города вылета
  • countryCode – код страны города вылета

Пример

Вызов метода GetDepartCities http://localhost:9000/TourSearchOwin/searchApi?action=GetDepartCities Возвращаемый результат метода GetDepartCities (в формате JSON) { "version": "1.08", "departCities": [ { "id": -1, "name": "Без перелета", "lname": "No flights", "countriesTo": [ 97, 90 ], "countryId": -1, "countryName": "", "countryCode": "" }, { "id": 1, "name": "Москва", "lname": "Moscow", "countriesTo": [ 90, 30 ], "countryId": 460, "countryName": "Россия", "countryCode": "RUS" } ] }

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

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

• Формат запроса:
  •  ?action=GetResorts
• Принимаемые параметры:
  • id – идентификатор города (опциональный, передача в запрос нескольких id не обрабатывается, в этом случае возвращаются все результаты. Если указан, то запрашивается только одна запись)
• Возвращаемый результат:
  • id – идентификатор города
  • name – название города (рус)
  • lname – название города (анг)
  • countryId – идентификатор страны, в котором расположен город

Пример

Вызов метода GetResorts http://localhost:9000/TourSearchOwin/searchApi?action=GetResorts Возвращаемый результат метода GetResorts (в формате JSON) { "version": "1.08", "resorts": [ { "id": 1, "name": "Каринтия", "lname": "Carinthia", "countryId": 90 }, { "id": 42, "name": "Хаммамед", "lname": "Hammamet", "countryId": 97 }, { "id": 40, "name": "Сусс", "lname": "Sousse", "countryId": 97 } ] }

Выгрузка типов тура (GetTourTypes) начиная с релиза 15.4

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

• Формат запроса:
  •  ?action=GetTourTypes
• Принимаемые параметры:
  • id – идентификатор типа тура (опциональный, передача в запрос нескольких id не обрабатывается, в этом случае возвращаются все результаты. Если указан, то запрашивается только одна запись)
• Либо
  • departureCityIds * – идентификатор города(ов) отправления (из метода GetDepartCities)
  • countryId * – идентификатор страны прибытия (из метода GetCountries)
  • resortIds * – идентификатор города(ов) прибытия (из метода GetResorts), при значении -1 будут переданы все города в рамках данной страны
• Возвращаемый результат:
  • id – идентификатор типа тура
  • name – название типа тура

Пример

Вызов метода GetTourTypes http://localhost:9000/TourSearchOwin/searchApi?action=GetTourTypes&departureCityIds=1&countryId=90&resortIds=-1 Возвращаемый результат метода GetTourTypes (в формате JSON) { "version": "1.08", "TourTypes": [ { "id": 1, "name": "Стандартный тур" }, { "id": 5, "name": "Экскурсионный тур", "lname": "Hammamet" }, { "id": 40, "name": "Пляжный отдых" } ] }

Выгрузка актуальных дат заездов (GetDates) начиная с релиза 15.4

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

• Формат запроса:
  •  ?action=GetDates
• Принимаемые параметры:
  • departureCityIds * – идентификатор города(ов) отправления (из метода GetDepartCities)
  • countryId * – идентификатор страны прибытия (из метода GetCountries)
  • resortIds * – идентификатор города(ов) прибытия (из метода GetResorts), при значении -1 будут переданы все города в рамках данной страны
  • tourTypeIds * – идентификатор типа(ов) тура (из метода GetTourTypes), при значении -1 будут переданы все типы тура в рамках данной страны
• Возвращаемый результат:
  • массив актуальных дат заезда в формате dd.MM.yyyy

Пример

Вызов метода GetDates http://localhost:9000/TourSearchOwin/searchApi?action=GetDates&departureCityIds=1&countryId=90&resortIds=-1&tourTypeIds=22 Возвращаемый результат метода GetDates (в формате JSON) { "version": "1.08", "dates": [ "01.08.2019", "02.08.2019", "03.08.2019", "04.08.2019", "05.08.2019", "06.08.2019", "07.08.2019", "08.08.2019", "09.08.2019", "10.08.2019" ] }

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

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

• Формат запроса:
  •  ?action=GetDurations
• Принимаемые параметры:
  • departureCityIds * – идентификатор города(ов) отправления (из метода GetDepartCities)
  • countryId * – идентификатор страны прибытия (из метода GetCountries)
  • resortIds * – идентификатор города(ов) прибытия (из метода GetResorts), при значении -1 будут переданы все города в рамках данной страны
  • tourTypeIds * – идентификатор типа(ов) тура (из метода GetTourTypes), при значении -1 будут переданы все типы тура в рамках данной страны
  • tourDates * – массив дат заездов в формате dd.MM.yyyy (из метода GetDates)
• Возвращаемый результат:
  • durations – массив актуальных продолжительностей (в днях)
  • durationType – тип продолжительности: 0 – в днях тура, 1 – в ночах тура, 2 – в ночах проживания в отеле.

Пример

Вызов метода GetDurations http://localhost:9000/TourSearchOwin/searchApi?action=GetDurations&departureCityIds=1&countryId=90&resortIds=-1&tourTypeIds=22&tourDates=22.05.2019,28.05.2019 Возвращаемый результат метода GetDurations (в формате JSON) { "version": "1.08", "durations": [ 8, 9, 10, 11, 12, 13, 14 ], "durationType": 0 }

Выгрузка программ туров (GetTourPrograms) начиная с релиза 15.4

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

• Формат запроса:
  •  ?action=GetTourPrograms
• Принимаемые параметры:
  • id * – идентификатор программы тура (обязательный, передача в запрос нескольких id не обрабатывается, в этом случае возвращается ошибка. Если указан, то запрашивается только одна запись)
• Либо
  • departureCityIds * – идентификатор города(ов) отправления (из метода GetDepartCities)
  • countryId * – идентификатор страны прибытия (из метода GetCountries)
  • resortIds * – идентификатор города(ов) прибытия (из метода GetResorts), при значении -1 будут переданы все города в рамках данной страны
  • tourTypeIds * – идентификатор типа(ов) тура (из метода GetTourTypes), при значении -1 будут переданы все типы тура в рамках данной страны
  • fromDateTime – дата (в формате dd.MM.yyyy HH:mm:ss), начиная с которой будут выгружаться изменения (то есть будут получены только те доступные программы туров, которые изменялись, начиная с указанной даты)
• Возвращаемый результат:
  • id – ключ программы туров
  • name – название программы туров
  • updateDate – дата последнего изменения программы туров (или связанных с ней компонентов)
  • beginDate – дата начала заездов по программе туров (в формате dd.MM.yyyy)
  • endDate – дата окончания заездов по программе туров (в формате dd.MM.yyyy)
  • tourTypeIds – типы туров для данной программы туров
  • routes – массив возможных маршрутов в данной программе туров
    • departureCountryKey – страна начала поездки (для каждой страны начала поездки в одной программе тура будет отдельный маршрут)
    • departureCityKey – город начала поездки (для каждого города начала поездки в одной программе тура будет отдельный маршрут)
    • destinationCountryKeys – страны по туру (если в туре несколько услуг класса отель и они в разных странах, то будут возвращаться все страны отелей)
    • destinationCityKeys – города по туру (если в туре отели в нескольких городах, то будут возвращаться все города отелей)

Пример

Вызов метода GetTourPrograms http://localhost:9000/TourSearchOwin/searchApi?action=GetTourPrograms&departureCityIds=1&countryId=90&resortIds=-1&tourTypeIds=22&fromDateTime=22.05.2019 12:00:00 Возвращаемый результат метода GetTourPrograms (в формате JSON) { "version": "1.08", "TourPrograms": [{ "id": 100004493, "name": "Автобусный тур", "updateDate": "2019-05-20T17:17:02.087", "beginDate": "01.06.2019", "endDate": "01.08.2019", "tourTypeIds": [2, 22], "routes": [{ "departureCountryId": 460, "departureCityId": 1, "destinationCountryIds": [90], "destinationCityIds": [35] }] }, { "id": 100005542, "name": "Общая проверка системы", "updateDate": "2019-05-15T15:54:10.81", "beginDate": "01.03.2018", "endDate": "15.08.2019", "tourTypeIds": [22], "routes": [{ "departureCountryId": 460, "departureCityId": 1, "destinationCountryIds": [90], "destinationCityIds": [35, 440, 562] }] }] }

Выгрузка списка курортов (GetAreas) начиная с релиза 15.3

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

• Формат запроса:
  •  ?action=GetAreas
• Принимаемые параметры:
  • id – идентификатор курорта (опциональный, передача в запрос нескольких id не обрабатывается, в этом случае возвращаются все результаты. Если указан, то запрашивается только одна запись)
• Возвращаемый результат:
  • id – идентификатор курорта
  • name – название курорта (рус)
  • lname – название курорта (анг)
  • countryId – идентификатор страны, в котором расположен курорт

Пример

Вызов метода GetAreas http://localhost:9000/TourSearchOwin/searchApi?action=GetAreas Возвращаемый результат метода GetAreas (в формате JSON) { "version": "1.08", "areas": [ { "id": 232, "name": "Малина", "lname": "Малина", "countryId": 90 }, { "id": 233, "name": "Облако", "lname": "Облако", "countryId": 90 }, { "id": 1, "name": "Каринтия", "lname": "en_Каринтия", "countryId": 90 }, { "id": -1, "name": "Без курорта", "lname": "", "countryId": -1 } ] }

Выгрузка списка категорий отелей (GetHotelCategories)

Метод возвращает список категорий отелей (примеры: 3*, 4*, Apts и т.д.).

• Формат запроса:
  •  ?action=GetHotelCategories
• Принимаемые параметры:
  • id – идентификатор категории отеля (опциональный, передача в запрос нескольких id не обрабатывается, в этом случае возвращаются все результаты. Если указан, то запрашивается только одна запись)
• Возвращаемый результат:
  • id – идентификатор категории отеля
  • name – название категории отеля
  • globalCode – глобальный код категории отеля

Пример

Вызов метода GetHotelCategories http://localhost:9000/TourSearchOwin/searchApi?action=GetHotelCategories Возвращаемый результат метода GetHotelCategories (в формате JSON) { "version": "1.08", "hotelCategories": [ { "id": 59, "name": "5*" "globalCode": "5*" }, { "id": 58, "name": "4*" "globalCode": null }, { "id": 57, "name": "3*" "globalCode": null } ] }

Выгрузка списка отелей (GetHotels)

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

• Формат запроса:
  •  ?action=GetHotels
• Принимаемые параметры:
  • id – идентификатор отеля (опциональный, передача в запрос нескольких id не обрабатывается, в этом случае возвращаются все результаты. Если указан, то запрашивается только одна запись)
• Возвращаемый результат:
  • id – идентификатор отеля
  • name – название отеля
  • hotelCategoryId – идентификатор категории отеля
  • hotelCategoryName – название категории отеля
  • resortId – идентификатор города, в котором расположен отель
  • resortName – название города, в котором расположен отель
  • areaId – идентификатор курорта, в котором расположен отель
  • areaName – название курорта, в котором расположен отель
  • address – адрес отеля
  • phone – телефон отеля
  • email – e-mail отеля
  • fax – факс отеля
  • http – адрес в интернете отеля

Пример

Вызов метода GetHotels http://localhost:9000/TourSearchOwin/searchApi?action=GetHotels Возвращаемый результат метода GetHotels (в формате JSON) { "version": "1.08", "hotels": [ { "id": 672, "name": "'Opal", "hotelCategoryId": 59, "hotelCategoryName": "4*+", "resortId": 35, "resortName": "Вена", "areaId": -1, "areaName": "Без курорта", "address": "53 av, Sova str.", "phone": "010(999)653-26-35", "email": "service@opal.net", "fax": null, "http": null }, { "id": 106, "name": "OPERA LAFAYETTE", "hotelCategoryId": 23, "hotelCategoryName": "5*", "resortId": 35, "resortName": "Вена", "areaId": -1, "areaName": "Без курорта", "address": null, "phone": null, "email": null, "fax": null, "http": null }, { "id": 709, "name": "Am Brilliantengrund", "hotelCategoryId": 23, "hotelCategoryName": "5*", "resortId": 35, "resortName": "Вена", "areaId": -1, "areaName": "Без курорта", "address": null, "phone": null, "email": null, "fax": null, "http": null }, { "id": 2362, "name": "Gastehaus Franz Riml", "hotelCategoryId": 59, "hotelCategoryName": "4*+", "resortId": 35, "resortName": "Вена", "areaId": -1, "areaName": "Без курорта", "address": null, "phone": null, "email": null, "fax": null, "http": null } ] }

Выгрузка описания и изображений отеля (GetHotelInfo) начиная с релиза 15.5

Метод возвращает описания и изображения запрашиваемого отеля.

• Формат запроса:
  •  ?action=GetHotelInfo
• Принимаемые параметры:
  • hotelKey * – идентификатор отеля
  • needImages – возвращать ли изображения отеля в ответе: 0 – не возвращать, 1 – возвращать.
  • imageSize – варианты размера возвращаемых изображений. Обрабатывается только если передан параметр needImages = 1 и в этом случае является обязательным параметром. Возможные значения: 0 – small, 1 – medium, 2 – big.

• Возвращаемый результат:
  • Images – массив изображений отеля
    • Key – ключ изображения
    • Description – описание изображения отеля
    • Priority – приоритет изображения
    • Image – изображение в byte array
  • Country – страна отеля
  • City – город отеля
  • Name – название отеля
  • HotelCategoryName – название категории отеля
  • Address – адрес отеля
  • Phone – телефон отеля
  • Email – e-mail отеля
  • Http – адрес в интернете отеля
  • Description – описание
  • InfrastructureHotel – инфраструктура отеля
  • RecreationSport – развлечение и спорт
  • Beach – пляж
  • Healing – лечение
  • Excursion – экскурсии
  • AdditionalService – дополнительные услуги
  • ForChildren – для детей
  • AddCost – доплаты

Пример

Вызов метода GetHotelInfo http://localhost:9000/TourSearchOwin/searchApi?action=GetHotelInfo&hotelKey=8659&needImages=1&imageSize=2 Возвращаемый результат метода GetHotelInfo (в формате JSON) { "version": "1.08", "hotelInfoAndPhoto": { "Images": [ { "Key": 2618, "Description": "Общий вид отеля", "Priority": 1, "Image": "iVBORw0KGgoAAAANSUhEUgAAARUAAAC0CAYAAAC62bgdSR0IArs4c6QAAAARnQU1BAA....." }, { "Key": 2786, "Description": "Вид на бассейн", "Priority": 2, "Image": "/9j/4AAQSkZJRgABAQEBLAEsAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw.....=" } ], "Country": "Австрия", "City": "Вена", "Name": "ContinentalSun", "HotelCategoryName": "HV", "Address": "Ул. Пушкина, 100, Вена, Австрия", "Phone": "+79991234567", "Email": "sun@sun.com", "Http": "www.sun.ru", "Description": "<p>Описание<\/p>", "InfrastructureHotel": "<p>Инфраструктура отеля<\/p>", "RecreationSport": "<p>Развлечение и спорт<\/p>", "Beach": "<p>Пляж<\/p>", "Healing": "<p>Лечение<\/p>", "Excursion": "<p>Экскурсии<\/p>", "AdditionalService": "<p>Дополнительные услуги<\/p>", "ForChildren": "<p>Для детей<\/p>", "AddCost": "<p>Доплата<\/p>" } }

Выгрузка списка типов номеров (GetRooms) начиная с релиза 15.3

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

• Формат запроса:
  •  ?action=GetRooms
• Принимаемые параметры:
  • id – идентификатор типа номера (опциональный, передача в запрос нескольких id не обрабатывается, в этом случае возвращаются все результаты. Если указан, то запрашивается только одна запись)
• Возвращаемый результат:
  • id – идентификатор типа номера
  • code – код типа номера
  • name – название типа номера
  • mainplaces – количество основных мест
  • extraplaces – количество дополнительных мест