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

Версия статьи от 17-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 – признак показывать ли валюту в поиске

Пример