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

Версия статьи от 4-12-2018.

Поддерживаемые версии ПК «Мастер-Тур»: Начиная с 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", "countries": [ { "id": 1, "name": "Каринтия", "lname": "Carinthia", "countryId": 90 }, { "id": 42, "name": "Хаммамед", "lname": "Hammamet", "countryId": 97 }, { "id": 40, "name": "Сусс", "lname": "Sousse", "countryId": 97 } ] }

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

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

• Формат запроса:
  •  ?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": "null", "countryId": 0 } ] }

Выгрузка списка категорий отелей (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 } ] }

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

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

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

Пример

Вызов метода GetRooms http://localhost:9000/TourSearchOwin/searchApi?action=GetRooms Возвращаемый результат метода GetRooms (в формате JSON) { "version": "1.08", "rooms": [ { "id": 129, "code": "DBL", "name": "DBL", "mainplaces": 2, "extraplaces": 1 }, { "id": 175, "code": "DBL+CHD", "name": "DBL+CHD", "mainplaces": null, "extraplaces": null }, { "id": 132, "code": "DBL+EXB", "name": "DBL+EXB", "mainplaces": 2, "extraplaces": 4 }, { "id": 2, "code": "Double1", "name": "Double2", "mainplaces": 2, "extraplaces": 3 }, { "id": 133, "code": "SNGL", "name": "SNGL", "mainplaces": null, "extraplaces": null }, { "id": 54, "code": "SNGL+2 Child ", "name": "Sngl+2 Child", "mainplaces": 1, "extraplaces": 0 }, { "id": 173, "code": "TPL", "name": "TPL", "mainplaces": null, "extraplaces": null } ] }

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

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

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

Пример

Вызов метода GetRoomTypes http://localhost:9000/TourSearchOwin/searchApi?action=GetRoomTypes Возвращаемый результат метода GetRoomTypes (в формате JSON) { "version": "1.08", "roomTypes": [ { "id": 4129, "code": "Cottage Premier Deluxe", "name": "Cottage Premier Deluxe" }, { "id": 39, "code": "Deluxe", "name": "Deluxe" }, { "id": 2711, "code": "Luxe", "name": "Luxe" }, { "id": 4470, "code": "Standard Room", "name": "Standard Room" } ] }

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

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

• Формат запроса:
  •  ?action=GetHtPlaces
• Принимаемые параметры:
  • id – идентификатор типа размещения (опциональный, передача в запрос нескольких id не обрабатывается, в этом случае возвращаются все результаты. Если указан, то запрашивается только одна запись)
• Возвращаемый результат:
  • id – идентификатор типа размещения
  • code – код типа размещения
  • name – название типа размещения
  • adultmainplaces – количество основных мест для взрослых
  • adultextraplaces – количество дополнительных мест для взрослых
  • childtmainplaces – количество основных мест для детей
  • childextraplaces – количество дополнительных мест для детей
  • mainplaces – общее количество основных мест для взрослых и детей
  • extraplaces – общее количество дополнительных мест для взрослых и детей
  • childAges – коллекция возможных возрастов детей в размещении (указывается полный возраст, то есть 12 - это 12,99)
    • from – нижняя граница возраста первого ребенка
    • to – верхняя граница возраста первого ребенка
    • from – нижняя граница возраста второго ребенка
    • to – верхняя граница возраста второго ребенка

Пример

Вызов метода GetHtPlaces http://localhost:9000/TourSearchOwin/searchApi?action=GetHtPlaces Возвращаемый результат метода GetHtPlaces (в формате JSON) { "version": "1.08", "hotelPlaces": [ { "id": 1239, "code": "1 ADL", "name": "1 ADL", "adultmainplaces": 1, "adultextraplaces": 0, "childtmainplaces": 0, "childextraplaces": 0, "mainplaces": 1, "extraplaces": 0, "childAges": [ { "from": null, "to": null }, { "from": null, "to": null } ] }, { "id": 1372, "code": "2 ad + child (0-0.99)", "name": "2 ad + child (0-0.99)", "adultmainplaces": 2, "adultextraplaces": 0, "childtmainplaces": 0, "childextraplaces": 1, "mainplaces": 2, "extraplaces": 1, "childAges": [ { "from": 0, "to": 1 }, { "from": null, "to": null } ] }, { "id": 1157, "code": "2 ad + child (2-4.99)", "name": "2 ad + child (2-4.99)", "adultmainplaces": 2, "adultextraplaces": 0, "childtmainplaces": 0, "childextraplaces": 1, "mainplaces": 2, "extraplaces": 1, "childAges": [ { "from": 2, "to": 4 }, { "from": null, "to": null } ] }, { "id": 1238, "code": "2 ADL", "name": "2 ADL", "adultmainplaces": 2, "adultextraplaces": 0, "childtmainplaces": 0, "childextraplaces": 0, "mainplaces": 2, "extraplaces": 0, "childAges": [ { "from": null, "to": null }, { "from": null, "to": null } ] } ] }

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

Метод возвращает список видов питания (примеры: HB, BB, без питания и т.д.).

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

Пример

Вызов метода GetMeals http://localhost:9000/TourSearchOwin/searchApi?action=GetMeals Возвращаемый результат метода GetMeals (в формате JSON) { "version": "1.08", "meals": [ { "id": 1, "name": "Пансион" "code": "HB", "globalCode": "HB" }, { "id": 2, "name": "Полупансион" "code": "FB", "globalCode": null }, { "id": 4, "name": "Завтрак буфет" "code": "BB", "globalCode": null }, { "id": 11, "name": "Шведский стол" "code": "UAI", "globalCode": "AI" } ] }

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

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

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

Пример

Вызов метода GetCurrencies http://localhost:9000/TourSearchOwin/searchApi?action=GetCurrencies Возвращаемый результат метода GetCurrencies (в формате JSON) { "version": "1.08", "currencies": [ { "id": 1, "name": "USD" }, { "id": 2, "name": "EUR" }, { "id": 3, "name": "RUR" }, { "id": 9, "name": "UAH" } ] }

Выгрузка курсов валют (GetCurrencyRates)

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

• Формат запроса:
  •  ?action=GetCurrencyRates
• Принимаемые параметры:
  • нет принимаемых параметров
• Возвращаемый результат:
  • baseCurrencyId – идентификатор национальной валюты
  • currencyId – идентификатор валюты, курс которой приводится
  • rate – курс валюты (отношение currencyId к baseCurrencyId)

Пример

Вызов метода GetCurrencyRates http://localhost:9000/TourSearchOwin/searchApi?action=GetCurrencyRates Возвращаемый результат метода GetCurrencyRates (в формате JSON) { "version": "1.08", "currencyRates": [ { "baseCurrencyId": 2, "currencyId": 1, "rate": 65.256054 }, { "baseCurrencyId": 2, "currencyId": 3, "rate": 71.168955 } ] }

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

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

• Формат запроса:
  •  ?action=GetTours&count=int&countryId=int&departCityId=int&dateFrom=date&dateTo=date&adults=int&kids=int&nightsMin=int&nightsMax=int&currencyId=int

• Принимаемые параметры ( * – обязательный):
  • offerId – уникальный идентификатор ранее найденного предложения. В случае, если данный параметр задан, все остальные параметры не обязательны и не принимаются в расчет, метод возвращает одну запись.
  • count * – максимальное количество предложений в выдаче.
  • countryId * – идентификатор страны.
  • departCityId * – идентификатор города вылета.
  • dateFrom * – начальная дата в диапазоне дат вылета в формате dd.MM.yyyy (пример: 31.12.2016).
  • dateTo * – конечная дата в диапазоне дат вылета в формате dd.MM.yyyy (пример: 31.12.2016).
  • adults * – количество взрослых.
  • kids * – количество детей.
  • kidsAges – количество полных лет каждому ребенку, передается в виде строки, перечисление через запятую (пример: 3,6).
  • nightsMin * – минимальное количество дней в туре.
  • nightsMax * – максимальное количество дней в туре.
  • resorts – идентификаторы городов, перечисление через запятую.
  • hotelCategories – идентификаторы категорий отелей, перечисление через запятую.
  • hotels – идентификаторы отелей, перечисление через запятую.
  • meals – идентификаторы видов питания, перечисление через запятую.
  • currencyId * – валюта, в которой будут выданы цены, а также валюта для входящих параметров priceMin и priceMax (если они есть).
  • priceMin – Цена тура от.
  • priceMax – Цена тура до.
  • hotelIsNotInStop – при значении 1 в результатах не должно быть отелей в стопе (отели со статусом «под запрос» допустимы). При значении 0 в результат должны попадать как отели в стопе, так и отели с наличием мест и с местами по запросу.
  • ticketsIncluded * – при значении 1 в результатах должны быть только туры с включенной стоимостью перелета («только отель» недопустимы). При значении 0 в результат должны попадать как туры без перелета, так и туры с перелетом.
  • hasTickets – при значении 1 в результатах должны быть туры только с реальным наличием билетов в перелете (не должно быть туров со стопом на перелете, перелеты со статусом «под запрос» недопустимы). При значении 0 в результат должны попадать как туры без билетов на рейс, так и туры с наличием билетов и с билетами по запросу.
  • excludeUsualTours – при значении 1 из результатов должны быть исключены туры, являющиеся обычными турами (не являющиеся многоотельными). При значении 0 или отсутствии данного параметра такие туры должны быть включены в результат.
  • excludeCombined – при значении 1 из результатов должны быть исключены туры, являющиеся многоотельными. При значении 0 или отсутствии данного параметра такие туры должны быть включены в результат.
  • showToursWithoutHotels – при значении 1 в результатах поиска вместе с обычными турами должны подбираться туры без проживания (без услуги отель в составе тура). При значении 0 или отсутствии данного параметра такие туры должны быть исключены из результата поиска. Параметр обрабатывается, начиная с релиза 15.2.

• Возвращаемый результат ( * – обязательный):
  • offerId * – уникальный идентификатор предложения, по которому в дальнейшем можно провести актуализацию тура.
  • tourName * – название программы тура.
  • hotelId * – идентификатор отеля.
  • hotelUrl – ссылка на страницу с описанием отеля.
  • resortId * – идентификатор города, в котором расположен отель.
  • hotelCategoryId * – идентификатор категории отеля.
  • mealId * – идентификатор вида питания.
  • htPlaceName * – название типа размещения в номере (примеры: 2 ADL + 1 CH (2-12), 2 ADL + INF).
  • roomTypeName – название категории номера (примеры: standard, deluxe, family, deluxe super ocean view).
  • tourDate * – дата начала тура в формате dd.MM.yyyy (пример: 31.12.2016).
  • tourEndDate – дата окончания тура (дата прилета) в формате dd.MM.yyyy (пример: 31.12.2016).
  • nights * – продолжительность тура в днях.
  • price * – цена тура в валюте, которая была указана во входном параметре currencyId.
  • hotelIsInStop * – наличие мест в отеле, допустимы значения: 0 – есть места, 1 – нет мест, 2 – запрос.
  • ticketsIncluded * – включена ли стоимость билетов в стоимость тура, допустимы значения: 0 – не включена (тур только отель), 1 – включена (пакетный тур).
  • hasEconomTicketsDpt * – наличие билетов эконом класса на место отдыха, допустимы значения: 0 – нет мест, 1 есть места, 2 – запрос. При значении атрибута ticketsIncluded = 0 значение данного параметра будет проигнорировано. Группы перелетов задаются в настройке flightTariffGroups.
  • hasEconomTicketsRtn * – наличие обратных билетов эконом класса, допустимы значения: 0 – нет мест, 1 есть места, 2 – запрос. При значении атрибута ticketsIncluded = 0 значение данного параметра будет проигнорировано. Группы перелетов задаются в настройке flightTariffGroups.
  • hasBusinessTicketsDpt * – наличие билетов бизнес класса на место отдыха, допустимы значения: 0 – нет мест, 1 есть места, 2 – запрос. При значении атрибута ticketsIncluded = 0 значение да