Интеграция со сторонними системами АПИ
Версия от 19:24, 24 апреля 2015; Кирилл Фимченко (обсуждение | вклад) (→Параметры используемые в запросах)
!!!СТАТЬЯ В РАЗРАБОТКЕ!!!
Содержание
- 1 API Авиабилетов
- 2 API Поиска отелей
- 3 API бронирования, аннуляции, войдирования авиабилетов
- 4 API бронирования, отмены отелей
- 5 Выгрузки статистики продаж через API
- 6 Выгрузка информации о заказах
- 7 Фиксация оплаты внешним запросом
- 8 API универсального платежного шлюза
- 9 API Синхронизации пользователей и субагентов
- 10 API Кроссавторизации
- 11 Передача параметров в форму поиска
- 12 Проверка в сторонней системе возможности тикетинга
- 13 Загрузка счетов из сторонней системы
API Авиабилетов
Для авторизации в системе, в запросе необходимо указать APIKey и ClientID. Эти данные можно узнать в разделе Администрирование - Веб-сервис. Авторизация. Там же можно включить/выключить нотификацию для действий сделанных через АПИ.
API Поиска авиабилетов
Это сервис внутри Nemo, который позволяет получить результаты поиска.
Для подключения к веб-службе поиска авиабилетов необходимо открыть доступ нужному пользователю. Это можно сделать в разделе «Администрирование» ⇨ «Веб-служба. Авторизация».
Подробнее можно узнать в специальной статье Веб-служба поиска авиабилетов
API Бронирования авиабилетов
Сервис позволяет забронировать/войдировать авиабилет с использованием API, описание подключения, запроса, ответов находится в этой статье Веб-служба бронирования
API Выписки авиабилетов
Агентский АПИ выписки позволяет определить валидирующего перевозчика и значение комиссии от авиакомпании для брони, а также запустить процедуру выписки билета. Веб-служба выписки
API Оплаты
Сервис внутри Nemo, который предназначен для выполнения различных операций, относящихся к оплате заказов. Агентские АПИ оплаты
API Дополнительных запросов авиабилетов
К дополнительных запросам относятся проверка на доступность, запрос на обновление заказа, чтение тарифных правил. Дополнительные запросы АПИ авиабилетов
Используемые параметры
Параметры, используемые в запросах
| Имя элемента | Обязательный | Тип | Описание |
|---|---|---|---|
| BookFlight | да | сложный | Контейнер для тела запроса бронирования |
| FlightId | да | число | Id перелёта для которого будет производится бронирование(поиск тарифных правил, проверка доступности) |
| CurrencyCode | нет | строка | Трёх буквенный код валюты (обязателен для комиссии в валюте) |
| Agency | да | сложный | Информация об агентстве |
| Name | да | строка | Название агентства |
| Telephone | нет | сложный | Контактный телефон агентства |
| Type | да | строка | Тип номера, возможные значения: M - мобильный, H - домашний, B - рабочий, A - агентство |
| PhoneNumber | да | строка | Номер телефона |
| CountryAccessCode | нет | строка | Код страны |
| AreaCityCode | нет | строка | Код региона/города |
| Address | да | сложный | Адрес агентства |
| City | да | строка | Город, в котором расположено агентство |
| StreetAddress | нет | сложный | Адрес агентства в городе (улица, дом, корпус, офис и т.д.) |
| PostalCode | нет | строка | Почтовый код, индекс. |
| CountryCode | нет | строка | Код страны (RU, UA, US и т.д.) |
| Travellers | да | сложный | Контейнер для информации о пассажирах (для которых будет производится поиск перелёта, бронирование) |
| Traveller | да | сложный | Информация о пассажире |
| Type | да | строка | Тип пассажира возможные значения: ADT - взрослые, CNN - дети со взрослыми, UNN - дети без сопровождения взрослых, INF - младенцы,INS - младенцы с местом |
| IsContact | нет | булевский | Индикатор показывающий является ли данное лицо контактным, возможные значение: true - пассажир является контактным лицом, false - не является. Контактное лицо может быть только одно, если среди пассажиров есть взрослые, то только кто-то из них может быть контактным лицом. Если не указано, то по умолчанию false. |
| LinkedTo | нет | целое число | Номер взрослого, к которому привязан младенец/ребёнок |
| Num | да | число | Номер пассажира. |
| PreferedPlace | нет | сложный | Информация о предпочитаемом месте. Если указаны номер ряда и номер места, то параметры Smoking и Location игнорируются и могут быть не указаны. |
| SmokingAllowed | нет | булевский | true - место для курящих, false - место для некурящих. По умолчанию false. |
| Location | нет | строка | Расположение места, возможные значения: W - у окна (Window); M - где-то в середине ряда (Middle); NPW - возле прохода (NearPassengerWay); NS - нет предпочтения (NotSpecified). |
| RowNumber | нет | строка | Номер ряда |
| PlaceNumber | нет | строка | Номер места |
| SegNumber | да | строка | Номер сегмента |
| DocumentInfo | да | сложный | Паспортные данные |
| DocType | да | строка | Тип документа, обязательный. |
| DocNum | да | строка | Номер документа |
| CountryCode | да | строка | Страна выдачи, двух буквенный код(RU, US и т.д.) |
| DocElapsedTime | да | строка | Срок истечения срока действия паспорта в фирмате dd.mm.yyyy (например 31.12.2012) |
| VisaInfo | нет | сложный | Информация о визе |
| Num | да | строка | Номер визы |
| IssueDate | да | строка | Дата выдачи визы в формате dd.mm.yyyy |
| IssueCountry | да | строка | Страна выдачи визы |
| IssuePlace | да | строка | Место выдачи визы |
| BirthCountry | нет | строка | Страна рождения (IATA код страны) |
| BirthCity | нет | строка | Город рождения (название) |
| ArrAddress | нет | сложный | Адрес прибытия, для въезжающих в США (не граждан США) информация является обязательной. Если она не заполняется при оформлении брони, то её всё равно придётся заполнять при посадке на самолёт. |
| CountryCode | да | строка | IATA код страны |
| State | да | строка | Штат или область въезда |
| PostalCode | да | строка | Почтовый код |
| City | да | строка | Город |
| StreetAddress | да | строка | Адрес: улица, номер дома, квартиры и тп |
| DocStringFormats | нет | сложный | Список форматов строк паспортных данных, которые будут отправлены в дополнение к стандартным. |
| DocStringFormat | да | строка | Формат данных, возможные значения: DOCS - строка формата DOCS, FOID - строка формата FOID. Установка данных в формате DOCS как правило необходима для последующей выписки в BSP среде. Установка FOID - всреде ТКП. |
| PersonalInfo | да | сложный | Персональные данные пассажира |
| DateOfBirth | да | строка | Дата рождения в формате dd.mm.yyyy (например 31.12.2000) |
| Nationality | да | строка | Национальность/гражданство, двух буквенный код страны (RU, UA, US и т.д.) |
| Gender | да | строка | Пол пассажира, обязательный, возможные значения: M - мужской(Male); F - женский(Female). |
| FirstName | да | строка | Имя пассажира |
| LastName | да | строка | Фамилия пассажира |
| BMiddleName | да | строка | Отчество пассажира |
| Meal | нет | строка | Код типа питания, возможные значения: NONE - отсутствует (по умолчанию); AVML - Азиатская вегетарианская кухня; BLML - Блюда щадящей диеты; CHML - Детское питание; CHPC - Детский холодный завтрак; СНСС - Детский горячий завтрак; CHHC - Детский ланч, ветчина и сыр; PBJS - Детский ланч, ореховое масло; CHMC - Детский обед макароны с сыром; DBML - Диабетическое питание; FPML - Фрукты; GFML - Питание без клейковины; HFML - Питание богатое клетчаткой; HNML - Индусская кухня; BBML - Питание для младенцев; KSML - Кошерная кухня; SMKB - Кошерный завтрак; SMKL - Кошерный ланч; SMKD - Кошерный обед; LPML - Малобелковое питание; LCML - Низкокалорийное питание; LFML - Низкохолестериновое питание; PRML - Низкопуриновое питание; LSML - Малосоленое питание; MOML - Мюсли; NLML - Безмолочные продукты; ORML - Восточная кухня; RVML - Сырые овощи; SFML - Морепродукты; SPML - Особое питание; VLML - Вегетарианское, молоко и яйца; VGML - Строго вегетарианское питание; VJML - Джайнизское вегетарианское; VOML - Восточное вегетарианское питание. |
| LoyaltyCard | нет | сложный | Карточка часто летающего пассажира |
| OpCode | да | строка | IATA код компании авиаперевозчика |
| Number | да | строка | Номер карточки |
| ContactInfo | нет | сложный | Контактная информация для пассажира |
| EmailID | нет | строка | Контактный email |
| Telephone | нет | сложный | Контактный телефон пассажира, описание аналогично описанию телефона агентства |
| CancelBook | да | сложный | Контейнер для тела запроса отмены брони |
| BookID | да | число | Номер брони, которая будет отменяться (для которой будет производится выписка, отмена выписки) |
| GetAirRules | да | сложный | Контейнер для тела запроса поиска тарифных правил |
| AirAvail | да | сложный | Контейнер для тела запроса проверки доступности перелёта |
| Ticketing | да | сложный | Контейнер для тела запроса выписки брони |
| ValCompany | нет | строка | Валидирующий перевозчик, на бланке которого выписывается билет |
| Comission | нет | сложный | Комиссия |
| Amount | нет | число с плавающей точкой | Значение комиссии в валюте, если указано, то комиссия в процентах игнорируется |
| Percent | нет | число | Комиссия в процентах |
| VoidTicket | да | сложный | Контейнер для тела запроса отмены выписки брони |
| Search | да | сложный | Контейнер для тела запроса поиска |
| ODPairs | да | сложный | Контейнер для информации о перелёте |
| Type | да | строка | Тип перелёта, возможные значения: OW - в одну сторону, RT - туда-обратно, CR - сложный маршрут |
| Direct | нет | булевский | Индикатор, указывающий какие перелёты искать, только прямые или с пересадками, возможные значения: false - с пересадками, true - только прямые. Если не указан, значение по умолчанию false. |
| AroundDates | нет | число | Включает поиск по окружным датам, количество дней +/- от даты заезда/возвращения. Применим только для типов перелёта в одну сторону(OW) и туда-обратно(RT). Возможные значения: 0, 1, 2, 3 |
| ODPair | да | сложный | Контейнер для информации о сегменте перелёта. Может повторяться 1-6 раз. Поиск по расписанию использует только первый сегмент, поиск сложных перелётов и перелётов туда и обратно не поддерживается |
| DepDate | да | строка | Дата вылета, Формат ГГГГ-MM-DDTЧЧ:ММ:СС |
| DepAirp | да | строка | Трёх буквенный код города отправления или конкретного аэропорта в городе отправления. |
| ArrAirp | да | строка | Трёх буквенный код города прибытия или конкретного аэропорта в городе прибытия. |
| Count | да | число | Число пассажиров данного типа. Общее количество пассажиров всех типов должно быть не более 9. |
| Restrictions | нет | сложный | Контейнер дополнительной информации для поиска. |
| ClassPref | нет | строка | Предпочитаемый класс перелёта, возможные значения: All - все, Economy - эконом, Business - бизнес, First - первый. Если не указан, то по умолчанию All. |
| OnlyAvail | нет | булевский | Искать только доступные, возможные значения: true - только доступные, false - все. Если не указан, то по умолчанию false. |
| AirVPrefs | нет | сложный | Обёртка для списка авиакомпаний, по которым будет или не будет проводиться поиск. |
| AirVPref | да | сложный | Информация об авиакомпании. |
| Include | нет | булевский | Индикатор, показывающий включить или исключить в результатах поиска перелёты данной авиакомпании: true - включить, false - исключить. Если не указан, то по умолчанию false. |
| IncludePrivateFare | нет | булевский | Включать приватные цены в результат или нет, возможные значения: true - включать, false - не включать. Если не указан, то по умолчанию false. |
| ServiceTypes | нет | сложный хмл | Контейнер массива используемых веб-сервисов при поиске. |
| ServiceType | нет | строка | Тип веб-сервиса(поставщика). При указании нескольких элементов ServiceType поиск будет проведён для каждого сервиса. Возможные значения: Sirena2000 - поиск в Сирене; SirenaSchedule - поиск в Сирене по расписанию; SabreLFS - поиск в Сэйбр LFS; SabreBFM - поиск в Сэйбр BFM; SabreSchedule - поиск Сэйбр по расписанию; Galileo - поиск в Галилео; AmadeusMPTBS - поиск в Амадеус. |
Параметры, используемые в ответах
| Имя элемента | Обязательный | Тип | Описание |
|---|---|---|---|
| BookFlightResult | да | сложный | Контейнер для тела ответа бронирования |
| ID | да | число | Номер бронирования в системе Nemo. |
| Status | да | строка | Статус брони, возможные значения: booked - забронировано, canceled - бронь отменена, ticket - выписана; UNDEFINED - статус не определён. |
| Code | да | строка | Номер бронирования в системе поставщика (в sabre, sirena и т.д.)/код тарифного правила |
| QueryPlace | нет | сложный | Очередь, в которую помещено бронирование |
| Number | да | число | Номер очереди |
| Flight | да | сложный | Перелёт, по которому была сделана бронь (Результаты проверки доступности для перелёта) |
| Agency | да | сложный | Информация об агентстве |
| ItinReceipts | нет | сложный | Маршрут квитанция. Содержит строку в кодировки Encoding (как правило в base64), представляющую маршрут квитанцию в формате Format. |
| Encoding | да | строка | Кодировка |
| Format | да | строка | Формат |
| Travellers | да | сложный | Контейнер для информации о пассажирах |
| Traveller | да | сложный | Информация о пассажире |
| Ticket | нет | сложный | Билет пассажира. |
| TickectNum | да | строка | Номер билета |
| Seats | нет | сложный | Контейнер мест пассажира. |
| Seat | да | сложный | Место в самолёте |
| Number | да | строка | Номер места(ряд+номер в ряду) |
| Characteristic | нет | строка | Характеристика места в соответствии со стандартом EDIFACT. См справочник “Таблица характеристик мест”. |
| SmokingPreference | нет | строка | Статус курения на этом месте, если Y - место для курящих, если N - место для некурящих. |
| SegmentNumber | да | число | Номер сегмента |
| PersonalInfo | да | сложный | Личные данные |
| LoyaltyCard | нет | сложный | Карточка часто летающего пассажира |
| ContactInfo | нет | сложный | Контактная информация для пассажира |
| FareStored | нет | срока: Yes/No | Указывает установлена ли / гарантируется ли цена у поставщика. Если параметр отсутствует в ответе, то по умолчанию значение “Yes”. |
| CancelBookResult | да | сложный | Контейнер для тела ответа отмены брони |
| BookID | да | число | Номер брони, которая отменялась (Номер выписанной брони, выписка которой отменялась) |
| Result | да | сложный | Результат отмены (войдирования) |
| Success | да | булевский | Индикатор, показывающий успешно или нет прошла отмена, возможные значения: true - успешно отменена (войдирование); false - не отменена |
| GetAirRulesResult | да | сложный | Контейнер для тела ответа поиска тарифных правил |
| FlightId | да | число | Номер перелёта, для которого найдены тарифные правила (будет проводилась проверка доступности) |
| Rules | да | сложный | Контейнер для правил |
| Rule | да | сложный | Правило |
| Tarrif | да | строка | Код тарифа, для которого правило применяется |
| Name | да | строка | Имя правила |
| RuleText | да | строка | Текст правила |
| AirAvailResult | да | сложный | Контейнер для тела ответа помещения брони в очередь |
| IsAvail | да | булевский | Индикатор, показывающий доступность перелёта, возможные значения: true - доступен; false - недоступен |
| VoidTicketResult | да | сложный | Контейнер для тела ответа отмены выписки брони |
| SearchResult | нет | сложный | Контейнер тела ответа для результатов поиска. |
| Flights | да | сложный | Контейнер для перелётов |
| Flight | нет | сложный | Представляет информацию о перелёте. Отсутствует если перелётов не найдено (используется в поисковом ответе) |
| WebService | да | строка | Веб-сервис (поставщик) от которого был получен перелёт. |
| ValCompany | нет | строка | IATA код авиакомпании. Валидирующий перевозчик, на бланках которого должен выписываться билет. |
| Segments | да | сложный | Контейнер для сегментов перелёта |
| Segment | да | сложный | Представляет информацию о сегменте |
| SegNum | да | число | Номер сегмента в перелёте |
| DepAirp | да | строка | IATA код аэропорта отправления |
| DepTerminal | нет | строка | Код терминала отправления |
| ArrAirp | да | строка | IATA код аэропорта прибытия |
| ArrTerminal | нет | строка | Код терминала прибытия |
| OpAirline | да | строка | Код авиакомпании, выполняющей рейс |
| MarkAirline | да | строка | Код авиакомпании, продающей билет |
| FlightNumber | да | число | Номер рейса |
| AircraftType | да | строка | Код типа самолёта |
| DepDateTime | да | строка | Дата и время отправления, формат ГГГГ-MM-ДДTЧЧ:ММ:СС |
| ArrDateTime | да | строка | Дата и время прибытия, формат ГГГГ-MM-ДДTЧЧ:ММ:СС |
| StopNum | да | число | Число остановок |
| Meal | да | строка | Тип питания, возможные значения: UNDEFINED - неизвестно; N - Нет питания; P - Алкогольные напитки в продаже; B - Завтрак; O - Холодная еда; C - Бесплатные алкогольные напитки; K - Континтальный завтрак; D - Обед; F - Еда в продаже; G - Еда/напитки в продаже; H - Горячая еда; L - Ланч; M - Еда; R - Освежающие еда/напитки бесплатно; V - Освежающие еда/напитки за отдельную плату; S - Закуска |
| BookingCodes | да | сложный | Контейнер для классов перелёта |
| BookingCode | да | строка | Код класса перелёта. Если производится поиск по расписанию, то может встречаться несколько раз. |
| FlightTime | нет | число | Время перелёта в минутах |
| TimeZone | нет | сложный | Информация о временных зона прибытия и отправления |
| Departure | да | число | Часовой пояс отправления, UTC (смещение относительно Гринвича) |
| Arrival | да | число | Часовой пояс прибытия, UTC (смещение относительно Гринвича) |
| ETicket | да | булевский | Индикатор электронного билета, возможные значения: true - билет является электронным, false - билет не является электронным. |
| Baggage | нет | сложный | Информация о багаже |
| Measure | да | строка | Мера веса. K - килограммы, PC - сумки/клади |
| Value | да | строка | Количество багажа |
| PricingInfo | нет | сложный | Контейнер для информации о ценах. Отсутствует в случае, если производится поиск по расписанию. |
| Refundable | да | булевский | Индикатор показывающий является ли билет возвратным или нет, возможные значения: true - возвратный (нет штрафов за возврат), false - невозвратный (могут быть штрафы за возврат) |
| PassengerFare | да | сложный | Информация о ценах для конкретного типа пассажиров. |
| Quantity | да | число | Число пассажиров данного типа |
| BaseFare | да | сложный | Цена в базовой валюте(за одного пассажира) |
| EquiveFare | нет | сложный | Цена в эквивалентной валюте(за одного пассажира), при поиске цены не возвращается |
| TotalFare | нет | сложный | Полная стоимость для пассажиров данного типа включая таксы (за одного пассажира), при поиске цены не возвращается |
| Currency | да | строка | Трёх буквенный код валюты. |
| Amount | да | число с плавающей точкой | Значение стоимости. |
| Taxes | нет | сложный | Контейнер для такс, при поиске цены не возвращается |
| Tax | да | сложный | Одна такса |
| CurCode | да | строка | Трёх буквенный код валюты для таксы |
| TaxCode | да | строка | Код таксы |
| Amount | да | число с плавающей точкой | Значение таксы |
| Tariffs | да | сложный | Контейнер для тарифов |
| Tariff | да | сложный | Контейнер для одного тарифа |
| Code | да | строка | Код тарифа |
| SegNum | да | число | Номер сегмента для которого применяется тариф, если тариф применяется для всех сегментов, то возвращается 0. |
| FareCalc | нет | строка | Строка расчёта цены |
| LastTicketDateTime | да | строка | Дата и время таймлимита по выписке в формате ГГГГ-MM-ДДTЧЧ:ММ:СС. Если бронирование не будет аннулировано или выписано до этого времени, то могут быть применены штрафы. |
API Поиска отелей
Агентский API Отелей - система, которая предоставляет возможность поиска и бронирования отелей а так же получение информации о времени и размерах штрафов, уникальной информации об отеле, получение статической информации.
Сервис предназначен для получения списка отелей, удовлетворяющих условиям запроса. В условия запроса входят: идентификатор города, где будет вестись поиск; дата заезда и дата выезда; информация о количестве людей и способе их размещения в комнатах. Так же указываются дополнительные необязательные поля фильтров.
Подробнее можно узнать в нашей специальной статье АПИ Поиска отелей
API бронирования, аннуляции, войдирования авиабилетов
API бронирования, отмены отелей
Штрафы за аннуляцию
Всегда в явном виде нужно указывать пользователю информацию о штрафах за аннуляцию до бронирования.
Штрафы получаются по каждой услуге отдельным запросом. Нужно указать тип услуги, идентификатор результата поиска и выбранную категорию.
Внимание. Для отелей из Hotelbeds (Supplier=HOTELBEDS) штрафы до бронирования получить невозможно.
WSDL (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=Penalty
Запрос
1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
2 xmlns:ver="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DPenalty">
3 <soapenv:Header/>
4 <soapenv:Body>
5 <ver:penalty>
6 <RequestBin>
7 <Request>
8 <Penalty>
9 <Item>
10 <Type>HOTELS</Type>
11 <CacheId>1867246</CacheId>
12 <CategoryId>1</CategoryId>
13 </Item>
14 </Penalty>
15 </Request>
16 <Source>
17 <ClientId></ClientId>
18 <APIKey></APIKey>
19 <Language>ru</Language>
20 <Currency>RUB</Currency>
21 </Source>
22 </RequestBin>
23 </ver:penalty>
24 </soapenv:Body>
25 </soapenv:Envelope>
Элемент Item
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Type | Обязательный. Тип объекта. | HOTELS |
| CacheId | Обязательный. Идентификатор результата поиска в системе Nemo. | Целое число |
| CategoryId | Обязательный. Идентификатор категории. | Целое число |
Элемент Source
| Элемент | Описание | Допустимые значения |
|---|---|---|
| ClientID | Обязательный. ID клиента в системе Nemo.
Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация". |
Целое число. |
| APIKey | Обязательный. APIKey - секретный ключ доступа к API Nemo.
Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация". |
Латинские буквы и цифры. Всего 32 символа. |
Ответ
1 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DPenalty">
2 <SOAP-ENV:Body>
3 <ns1:penaltyResponse>
4 <ResponseBin>
5 <Response>
6 <Penalty>
7 <ItemDateBegin>2013-10-15 00:00:00</ItemDateBegin>
8 <CancelCharges>
9 <Charge>
10 <DateFrom>2013-10-12 00:00:00</DateFrom>
11 <DateTo>2013-10-15 23:59:59</DateTo>
12 <Money Currency="RUB">74733.84</Money>
13 </Charge>
14 <Charge>
15 <DateFrom>2013-09-23 00:00:00</DateFrom>
16 <DateTo>2013-10-11 00:00:00</DateTo>
17 <Money Currency="RUB">67260.46</Money>
18 </Charge>
19 <Charge>
20 <DateFrom>2013-08-01 17:59:00</DateFrom>
21 <DateTo>2013-09-22 00:00:00</DateTo>
22 <Money Currency="RUB">12455.64</Money>
23 </Charge>
24 </CancelCharges>
25 <ModifyCharges/>
26 </Penalty>
27 </Response>
28 </ResponseBin>
29 </ns1:penaltyResponse>
30 </SOAP-ENV:Body>
31 </SOAP-ENV:Envelope>
Элемент Penalty
| Элемент | Описание | Допустимые значения |
|---|---|---|
| ItemDateBegin | Обязательный. Дата начала услуги (дата заселения в отель). | Формат гггг-мм-дд чч:мм:сс |
| CancelCharges | Необязательный. Содержит информацию о штрафах за аннуляцию. | Элемент Charge |
| ModifyCharges | Необязательный. Содержит информацию о штрафах за модификацию. | Элемент Charge |
Штрафы разбиваются по временным интервалам. На каждом интервале указывается значение штрафа.
Элемент Charge
| Элемент | Описание | Допустимые значения |
|---|---|---|
| DateFrom | Обязательный. Дата/время начала интервала. | Формат гггг-мм-дд чч:мм:сс |
| DateTo | Необязательный. Дата/время окончания интервала. | Формат гггг-мм-дд чч:мм:сс |
| Money | Обязательный. Сумма штрафа. | Вещественное число.
Атрибут: Currency - код валюты. |
Бронирование
Запрос
Схема запроса позволяет указывать несколько услуг для бронирования сразу. Это было сделано с заделом на возможность расширения функциональности в будущем при сохранении совместимости.
Сейчас же необходимо указывать только 1 услугу-отель (элемент Item) в запросе на бронирование.
Для успешного запроса нужно указать:
- Услугу. В запросе не требуется перечислять все параметры из результатов поиска, достаточно указать уникальный ID результата.
- Информация о клиентах. Все клиенты перечисляются в отдельной ветке и нумеруются по порядку. Указатели (элементы с номером клиента), также добавляются в описание услуги.
- Заказчик. Указатель на одну персону.
WSDL (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=Booking
1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
2 xmlns:ver="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DBooking">
3 <soapenv:Header/>
4 <soapenv:Body>
5 <ver:booking>
6 <RequestBin>
7 <Request>
8 <Booking>
9 <Items>
10 <!--Zero or more repetitions:-->
11 <Item>
12 <!--You have a CHOICE of the next 3 items at this level-->
13 <HotelBookData>
14 <CacheId>1872666</CacheId>
15 <CategoryId>1</CategoryId>
16 <Rooms>
17 <!--Zero or more repetitions:-->
18 <Room Id="2">
19 <Persons>
20 <!--Zero or more repetitions:-->
21 <Person Number="1"/>
22 <Person Number="2"/>
23 </Persons>
24 </Room>
25 <Room Id="1">
26 <Persons>
27 <!--Zero or more repetitions:-->
28 <Person Number="3"/>
29 </Persons>
30 </Room>
31 </Rooms>
32 </HotelBookData>
33 <Customer>
34 <Person Number="1"/>
35 </Customer>
36 </Item>
37 </Items>
38 <Persons>
39 <!--Zero or more repetitions:-->
40 <Person Number="1" Type="ADT">
41 <!--Optional:-->
42 <Lastname>IVANOV</Lastname>
43 <!--Optional:-->
44 <Name>IVAN</Name>
45 <!--Optional:-->
46 <Middlename>IVANOVICH</Middlename>
47 <!--Optional:-->
48 <DateOfBirth>1987-12-12</DateOfBirth>
49 <!--Optional:-->
50 <Phone>+79871231212</Phone>
51 <!--Optional:-->
52 <Email>m.rudenko@mute-lab.com</Email>
53 <!--Optional:-->
54 <Gender>MR</Gender>
55 <!--Optional:-->
56 <Document Type="P">
57 <Series>1811</Series>
58 <Number>912219</Number>
59 <!--Optional:-->
60 <IssueDate>2012-12-12</IssueDate>
61 <!--Optional:-->
62 <ExpiryDate>2014-12-12</ExpiryDate>
63 </Document>
64 </Person>
65 <Person Number="2" Type="CHD">
66 <!--Optional:-->
67 <Lastname>PETROV</Lastname>
68 <!--Optional:-->
69 <Name>IVAN</Name>
70 <!--Optional:-->
71 <Middlename>MIKHAILOVICH</Middlename>
72 <!--Optional:-->
73 <DateOfBirth>2008-12-12</DateOfBirth>
74 <!--Optional:-->
75 <Phone>+79871231212</Phone>
76 <!--Optional:-->
77 <Email>m.rudenko@mute-lab.com</Email>
78 <!--Optional:-->
79 <Gender>MR</Gender>
80 <!--Optional:-->
81 <Document Type="P">
82 <Series>1866</Series>
83 <Number>913319</Number>
84 <!--Optional:-->
85 <IssueDate>2012-12-12</IssueDate>
86 <!--Optional:-->
87 <ExpiryDate>2014-12-12</ExpiryDate>
88 </Document>
89 </Person>
90 <Person Number="3" Type="ADT">
91 <!--Optional:-->
92 <Lastname>SIDOROV</Lastname>
93 <!--Optional:-->
94 <Name>IVAN</Name>
95 <!--Optional:-->
96 <Middlename>SERGEEVICH</Middlename>
97 <!--Optional:-->
98 <DateOfBirth>1987-12-12</DateOfBirth>
99 <!--Optional:-->
100 <Phone>+79871231212</Phone>
101 <!--Optional:-->
102 <Email>m.rudenko@mute-lab.com</Email>
103 <!--Optional:-->
104 <Gender>MR</Gender>
105 <!--Optional:-->
106 <Document Type="P">
107 <Series>1866</Series>
108 <Number>913319</Number>
109 <!--Optional:-->
110 <IssueDate>2012-12-12</IssueDate>
111 <!--Optional:-->
112 <ExpiryDate>2014-12-12</ExpiryDate>
113 </Document>
114 </Person>
115 </Persons>
116 </Booking>
117 </Request>
118 <Source>
119 <ClientId></ClientId>
120 <APIKey></APIKey>
121 <Language>ru</Language>
122 <Currency>RUB</Currency>
123 </Source>
124 </RequestBin>
125 </ver:booking>
126 </soapenv:Body>
127 </soapenv:Envelope>
Элемент Booking
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Items | Обязательный. Массив элементов Item. | Элемент Item |
| Customer | Обязательный. Элемент установки заказчика. | |
| Persons | Обязательный. Массив клиентов. |
Данные об услугах записываются в элементы <Item>.
Элемент Item
| Элемент | Описание | Допустимые значения |
|---|---|---|
| HotelBookData | Обязательный. В зависимости от типа объекта бронирования. В данный момент возможно указать только данные для отеля. | |
| Persons | Необязательный. Привязка клиентов к услуге. Если не указаны, будут привязаны все из указанных в главном элементе Booking. | [<Person Number="1" />] |
Бронирование отеля. Для бронирования отеля необходимы следующие параметры:
- ID результата поиска - один отель
- ID выбранной категории этого отеля
- Распределение клиентов по комнатам.
Элемент HotelBookData
| Элемент | Описание | Допустимые значения |
|---|---|---|
| CacheId | Обязательный. Идентификатор результата поиска для данного отеля в системе Nemo. | Целое число |
| CategoryId | Обязательный. Идентификатор категории. | Целое число |
| Rooms | Обязательный. Распределение клиентов по комнатам. | Список элементов Room |
| Room | Атрибут Id
Ид комнаты из результата поиска Элемент Persons |
Целое число |
| Persons | Обязательный.
Список людей |
Список элементов Person |
| Person | Обязательный.
Атрибут Number Номер пассажира из Booking ->Persons->Person->Number |
Целое число |
Информация о клиентах. Для успешного завершения бронирования нужно указать как минимум одного клиента. Максимальное число клиентов в текущей версии не ограничено.
Набор обязательных данных может меняться в зависимости от типов услуг в бронировании. Рекомендуемый набор обязательных параметров: Lastname, Name, DateOfBirth. Остальные обязательные параметры будут устанавливаться индивидуально при подключении к сервису.
Элемент Person
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Атрибут Number | Обязательный. Номер клиента, необходим для правильной привязки к услугам. | Целое число |
| Type | Обязательный.
Тип пассажира. |
Строка.
Возможные значения: ADT CLD INF |
| Lastname | Фамилия. | Строка в произвольном формате. |
| Name | Имя. | Строка в произвольном формате. |
| Middlename | Отчество. | Строка в произвольном формате. |
| DateOfBirth | Дата рождения. | Формат гггг-мм-дд. |
| Phone | Телефон.
Рекомендуемый формат: +79871234567 |
Строка |
| Электронный адрес. | Строка | |
| Gender | Пол. | MR - мужчина,
MS - женщина. |
| Document | Документ | Элемент Document |
Для некоторых услуг может потребоваться информация о документах.
Элемент Document
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Атрибут Type | Обязательный. Тип документа. | P - загранпаспорт
C - внутренний гражданский паспорт B - свидетельство о рождении |
| Series | Необязательный. Серия документа. Можно указать слитно с номером в Number. | Строка в произвольном формате |
| Number | Обязательный. Номер документа. | Строка в произвольном формате |
| IssueDate | Необязательный. Дата выдачи документа. | Формат гггг-мм-дд |
| ExpiryDate | Необязательный. Дата истечения срока действия документа. | Формат гггг-мм-дд |
Элемент Source
| Элемент | Описание | Допустимые значения |
|---|---|---|
| ClientID | Обязательный. ID клиента в системе Nemo.
Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация". |
Целое число. |
| APIKey | Обязательный. APIKey - секретный ключ доступа к API Nemo.
Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация". |
Латинские буквы и цифры. Всего 32 символа. |
Ответ
После выполнения запроса сразу поступит информация о бронировании. В первую очередь нужно внимательно проверить статусы <Status> всех услуг в бронировании. Если бронировалась услуга со статусом в результатах поиска RQ (по запросу), то статус скорее всего будет не равен «booked». Через некоторое время проверять реальный статус бука отправляя запрос на чтение данных о бронировании.
1 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
2 xmlns:ns1="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DBooking"
3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
4 <SOAP-ENV:Body>
5 <ns1:bookingResponse>
6 <ResponseBin>
7 <Response>
8 <Booking>
9 <Items>
10 <Item Id="386610">
11 <Hotel Id="1872666">
12 <Supplier>GTA</Supplier>
13 <CityId>22046</CityId>
14 <DateBegin>2013-10-15</DateBegin>
15 <DateEnd>2013-10-18</DateEnd>
16 <CacheId>1872666</CacheId>
17 <Name>ADLON KEMPINSKI</Name>
18 <Categories>
19 <Category Id="1">
20 <Rooms>
21 <Room Count="1" Id="1" ServiceId="1"/>
22 <Room Count="1" Id="2" ServiceId="2"/>
23 </Rooms>
24 <TotalPrice Currency="RUB">74733.84</TotalPrice>
25 </Category>
26 </Categories>
27 <Services>
28 <Service Id="1" Status="OK">
29 <Desc>Standard Twin</Desc>
30 <Meal>Full Breakfast</Meal>
31 <Price Currency="RUB">37366.92</Price>
32 </Service>
33 <Service Id="2" Status="OK">
34 <Desc>Standard Twin</Desc>
35 <Meal>Full Breakfast</Meal>
36 <Price Currency="RUB">37366.92</Price>
37 </Service>
38 </Services>
39 <Rooms>
40 <Room Id="1" Type="TWIN"/>
41 <Room Id="2" Type="SNGL"/>
42 </Rooms>
43 </Hotel>
44 <Type>HOTELS</Type>
45 <Status>waiting</Status>
46 <Prices>
47 <Price Currency="RUB">74733.84</Price>
48 <Charges Currency="RUB">0</Charges>
49 <Commission Currency="RUB">0</Commission>
50 <Penalty Currency="RUB">0</Penalty>
51 <TotalPrice Currency="RUB">74733.84</TotalPrice>
52 </Prices>
53 <Dates>
54 <BookingDate>2013-08-01 19:49:56</BookingDate>
55 <UpdateDate>2013-08-01 19:49:57</UpdateDate>
56 <CancelDate xsi:nil="true"/>
57 <PenaltyDate>2013-07-31 19:10:37</PenaltyDate>
58 <AutoCancelDate>2013-08-01 19:51:56</AutoCancelDate>
59 <ConfirmationLimit/>
60 </Dates>
61 <Statuses>
62 <PaymentStatus>1</PaymentStatus>
63 <DocumentStatus>1</DocumentStatus>
64 <DeliveryStatus>1</DeliveryStatus>
65 <InvoiceStatus>1</InvoiceStatus>
66 <ProblemStatus>1</ProblemStatus>
67 </Statuses>
68 <Customer>
69 <Person Number="1"/>
70 </Customer>
71 <Persons>
72 <Person Number="1"/>
73 <Person Number="2"/>
74 <Person Number="3"/>
75 </Persons>
76 </Item>
77 </Items>
78 <Persons>
79 <Person Number="1">
80 <Lastname>IVANOV</Lastname>
81 <Name>IVAN</Name>
82 <Middlename>IVANOVICH</Middlename>
83 <DateOfBirth xsi:nil="true"/>
84 <Phone>+79871231212</Phone>
85 <Email>m.rudenko@mute-lab.com</Email>
86 <Gender xsi:nil="true"/>
87 <Document Type="P">
88 <Series>1811</Series>
89 <Number>912219</Number>
90 <IssueDate>2012-12-12 00:00:00</IssueDate>
91 <ExpiryDate>2014-12-12 00:00:00</ExpiryDate>
92 </Document>
93 </Person>
94 <Person Number="2">
95 <Lastname>PETROV</Lastname>
96 <Name>IVAN</Name>
97 <Middlename>MIKHAILOVICH</Middlename>
98 <DateOfBirth xsi:nil="true"/>
99 <Phone>+79871231212</Phone>
100 <Email>m.rudenko@mute-lab.com</Email>
101 <Gender xsi:nil="true"/>
102 <Document Type="P">
103 <Series>1866</Series>
104 <Number>913319</Number>
105 <IssueDate>2012-12-12 00:00:00</IssueDate>
106 <ExpiryDate>2014-12-12 00:00:00</ExpiryDate>
107 </Document>
108 </Person>
109 <Person Number="3">
110 <Lastname>SIDOROV</Lastname>
111 <Name>IVAN</Name>
112 <Middlename>SERGEEVICH</Middlename>
113 <DateOfBirth xsi:nil="true"/>
114 <Phone>+79871231212</Phone>
115 <Email>m.rudenko@mute-lab.com</Email>
116 <Gender xsi:nil="true"/>
117 <Document Type="P">
118 <Series>1866</Series>
119 <Number>913319</Number>
120 <IssueDate>2012-12-12 00:00:00</IssueDate>
121 <ExpiryDate>2014-12-12 00:00:00</ExpiryDate>
122 </Document>
123 </Person>
124 </Persons>
125 </Booking>
126 </Response>
127 </ResponseBin>
128 </ns1:bookingResponse>
129 </SOAP-ENV:Body>
130 </SOAP-ENV:Envelope>
Структура ответа очень похожа на запрос. Выделяются те же основные элементы.
Элемент Booking
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Items | Обязательный. Содержит элемент(ы) Item. | Элемент Item |
| Persons | Обязательный. Здесь перечислены все клиенты заказа. | Элемент Person |
В элементах Item раскрывается подробнейшая информация об одной услуге в бронировании.
Элемент Item
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Атрибут Id | Обязательный.
Номер заказа в системе Nemo. |
Целое число |
| Type | Обязательный.
Тип объекта бронирования. |
HOTELS |
| Status | Обязательный. Статус объекта бронирования . | booked - забронирован
cancelled - аннулирован pending confirmation - в процессе подтверждения pending – произошла попытка бронирования, которое не было завершено waiting – ожидается результат запроса на бронирование |
| Prices | Обязательный. Данные о ценах. | см. Элемент Prices |
| Dates | Обязательный. Данные о датах. | см. Элемент Dates |
| Statuses | Обязательный. Различные дополнительные статусы заказанной услуги. | см. Элемент Statuses |
| Persons | Обязательный. Содержит клиентов привязанных к услуге. | элементы Person |
| Hotel | Необязательный. Элемент с данными об отеле. | см. элемент Hotel (результат поиска отеля) |
Информация о цене услуги вынесена в отдельную ветку:
Элемент Prices
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Price | Обязательный. Базовая цена услуги. | Вещественное число.
Атрибут Currency - код валюты. |
| Charges | Необязательный. Сумма дополнительных сборов. | Вещественное число.
Атрибут Currency - код валюты. |
| Commission | Необязательный. Сумма комиссий (вычитается из общей стоимости). | Вещественное число.
Атрибут Currency - код валюты. |
| Penalty | Необязательный. Сумма штрафов. | Вещественное число.
Атрибут Currency - код валюты. |
| TotalPrice | Обязательный. Итоговая стоимость.
= Price + Charges + Commission |
Вещественное число.
Атрибут Currency - код валюты. |
Информация о датах услуги также вынесена в отдельную ветку:
Элемент Dates
| Элемент | Описание | Допустимые значения |
|---|---|---|
| BookingDate | Обязательный. Дата бронирования. | Формат гггг-мм-дд чч:мм:сс |
| UpdateDate | Необязательный. Дата обновления. | Формат гггг-мм-дд чч:мм:сс |
| CancelDate | Необязательный. Дата аннуляции. | Формат гггг-мм-дд чч:мм:сс |
| PenaltyDate | Необязательный. Дата наступления штрафов. | Формат гггг-мм-дд чч:мм:сс |
| AutoCancelDate | Необязательный. Дата автоаннулирования. | Формат гггг-мм-дд чч:мм:сс |
Дополнительные статусы:
Элемент Statuses
| Элемент | Описание | Допустимые значения |
|---|---|---|
| PaymentStatus | Необязательный.
Статус оплаты. |
Целое число
1 - неоплачено 2 - частично оплачено 3 - оплачено |
| DocumentStatus | Необязательный.
Статус ваучера. |
Целое число
1 - документ не сформирован 2 - документ сформирован |
| DeliveryStatus | Необязательный.
Статус доставки. |
Целое число
1 - не доставлен 2 - доставлен |
| InvoiceStatus | Необязательный.
Статус счета. |
Целое число
1 - счет выставлен. 2 - счет не выставлен. |
Информация о клиентах заказа полностью повторяет структуру запроса.
Подтверждение бронирования
Запрос
Подтверждение бронирования заказа.
WSDL (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=ConfirmBooking
1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ver="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DConfirmBooking">
2 <soapenv:Header/>
3 <soapenv:Body>
4 <ver:confirm>
5 <RequestBin>
6 <Request>
7 <BookingId>179547</BookingId>
8 </Request>
9 <Source>
10 <ClientId></ClientId>
11 <APIKey></APIKey>
12 <Language>ru</Language>
13 <Currency>RUB</Currency>
14 </Source>
15 </RequestBin>
16 </ver:confirm>
17 </soapenv:Body>
18 </soapenv:Envelope>
Элемент Request
| Элемент | Описание | Допустимые значения |
|---|---|---|
| BookingID | Обязательный. Идентификатор заказа в системе Nemo. | Целое число |
Элемент Source
| Элемент | Описание | Допустимые значения |
|---|---|---|
| ClientID | Обязательный. ID клиента в системе Nemo.
Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация". |
Целое число. |
| APIKey | Обязательный. APIKey - секретный ключ доступа к API Nemo.
Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация". |
Латинские буквы и цифры. Всего 32 символа. |
Ответ
1 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DConfirmBooking">
2 <SOAP-ENV:Body>
3 <ns1:confirmResponse>
4 <ResponseBin>
5 <Response>
6 <Books>
7 <Book>
8 <Id>179547</Id>
9 <Status>booked</Status>
10 </Book>
11 </Books>
12 </Response>
13 </ResponseBin>
14 </ns1:confirmResponse>
15 </SOAP-ENV:Body>
16 </SOAP-ENV:Envelope>
Выгрузка актуальных данных по заказу(ам)
Используется для экспорта бронирований и для обновления данных в локальной клиентской базе.
WSDL (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=Export
Запрос
1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
2 xmlns:ver="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DExport">
3 <soapenv:Header/>
4 <soapenv:Body>
5 <ver:export>
6 <RequestBin>
7 <Request>
8 <Export>
9 <Items>
10 <!--Zero or more repetitions:-->
11 <Item Id="386621"/>
12 </Items>
13 </Export>
14 </Request>
15 <Source>
16 <ClientId></ClientId>
17 <APIKey></APIKey>
18 <Language>ru</Language>
19 <Currency>RUB</Currency>
20 </Source>
21 </RequestBin>
22 </ver:export>
23 </soapenv:Body>
24 </soapenv:Envelope>
Элемент Item
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Атрибут Id | Обязательный. Идентификатор заказа в системе Nemo. | Целое число |
Элемент Source
| Элемент | Описание | Допустимые значения |
|---|---|---|
| ClientID | Обязательный. ID клиента в системе Nemo.
Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация". |
Целое число. |
| APIKey | Обязательный. APIKey - секретный ключ доступа к API Nemo.
Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация". |
Латинские буквы и цифры. Всего 32 символа. |
Ответ
Ответ содержит элементы результатов бронирований. См. описание выше.
1 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
2 xmlns:ns1="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DExport"
3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
4 <SOAP-ENV:Body>
5 <ns1:exportResponse>
6 <ResponseBin>
7 <Response>
8 <Export>
9 <Items>
10 <Item Id="386621">
11 <Hotel Id="1872666">
12 <Supplier>GTA</Supplier>
13 <CityId>22046</CityId>
14 <DateBegin>2013-10-15</DateBegin>
15 <DateEnd>2013-10-18</DateEnd>
16 <CacheId>1872666</CacheId>
17 <Name>ADLON KEMPINSKI</Name>
18 <Categories>
19 <Category Id="1">
20 <Rooms>
21 <Room Count="1" Id="1" ServiceId="1"/>
22 <Room Count="1" Id="2" ServiceId="2"/>
23 </Rooms>
24 <TotalPrice Currency="RUB">74733.84</TotalPrice>
25 </Category>
26 </Categories>
27 <Services>
28 <Service Id="1" Status="OK">
29 <Desc>Standard Twin</Desc>
30 <Meal>Full Breakfast</Meal>
31 <Price Currency="RUB">37366.92</Price>
32 </Service>
33 <Service Id="2" Status="OK">
34 <Desc>Standard Twin</Desc>
35 <Meal>Full Breakfast</Meal>
36 <Price Currency="RUB">37366.92</Price>
37 </Service>
38 </Services>
39 <Rooms>
40 <Room Id="1" Type="TWIN"/>
41 <Room Id="2" Type="SNGL"/>
42 </Rooms>
43 </Hotel>
44 <Type>HOTELS</Type>
45 <Status>waiting</Status>
46 <Prices>
47 <Price Currency="RUB">74733.84</Price>
48 <Charges Currency="RUB">0</Charges>
49 <Commission Currency="RUB">0</Commission>
50 <Penalty Currency="RUB">0</Penalty>
51 <TotalPrice Currency="RUB">74733.84</TotalPrice>
52 </Prices>
53 <Dates>
54 <BookingDate>2013-08-01 20:21:47</BookingDate>
55 <UpdateDate>2013-08-01 20:35:01</UpdateDate>
56 <CancelDate xsi:nil="true"/>
57 <PenaltyDate>2013-07-31 19:10:37</PenaltyDate>
58 <AutoCancelDate>2013-08-01 20:23:47</AutoCancelDate>
59 <ConfirmationLimit/>
60 </Dates>
61 <Statuses>
62 <PaymentStatus>1</PaymentStatus>
63 <DocumentStatus>1</DocumentStatus>
64 <DeliveryStatus>1</DeliveryStatus>
65 <InvoiceStatus>1</InvoiceStatus>
66 <ProblemStatus>1</ProblemStatus>
67 </Statuses>
68 <Customer>
69 <Person Number="1"/>
70 </Customer>
71 <Persons>
72 <Person Number="1"/>
73 <Person Number="2"/>
74 <Person Number="3"/>
75 </Persons>
76 </Item>
77 </Items>
78 <Persons>
79 <Person Number="1">
80 <Lastname>IVANOV</Lastname>
81 <Name>IVAN</Name>
82 <Middlename>IVANOVICH</Middlename>
83 <DateOfBirth xsi:nil="true"/>
84 <Phone>+79871231212</Phone>
85 <Email>m.rudenko@mute-lab.com</Email>
86 <Gender xsi:nil="true"/>
87 <Document Type="P">
88 <Series>1811</Series>
89 <Number>912219</Number>
90 <IssueDate>2012-12-12 00:00:00</IssueDate>
91 <ExpiryDate>2014-12-12 00:00:00</ExpiryDate>
92 </Document>
93 </Person>
94 <Person Number="2">
95 <Lastname>PETROV</Lastname>
96 <Name>IVAN</Name>
97 <Middlename>MIKHAILOVICH</Middlename>
98 <DateOfBirth xsi:nil="true"/>
99 <Phone>+79871231212</Phone>
100 <Email>m.rudenko@mute-lab.com</Email>
101 <Gender xsi:nil="true"/>
102 <Document Type="P">
103 <Series>1866</Series>
104 <Number>913319</Number>
105 <IssueDate>2012-12-12 00:00:00</IssueDate>
106 <ExpiryDate>2014-12-12 00:00:00</ExpiryDate>
107 </Document>
108 </Person>
109 <Person Number="3">
110 <Lastname>SIDOROV</Lastname>
111 <Name>IVAN</Name>
112 <Middlename>SERGEEVICH</Middlename>
113 <DateOfBirth xsi:nil="true"/>
114 <Phone>+79871231212</Phone>
115 <Email>m.rudenko@mute-lab.com</Email>
116 <Gender xsi:nil="true"/>
117 <Document Type="P">
118 <Series>1866</Series>
119 <Number>913319</Number>
120 <IssueDate>2012-12-12 00:00:00</IssueDate>
121 <ExpiryDate>2014-12-12 00:00:00</ExpiryDate>
122 </Document>
123 </Person>
124 </Persons>
125 </Export>
126 </Response>
127 </ResponseBin>
128 </ns1:exportResponse>
129 </SOAP-ENV:Body>
130 </SOAP-ENV:Envelope>
Формат ответа аналогичен результату бронирования.
Аннуляция заказа
WSDL (тестовый сервер): http://tst.nemo-ibe.com/wsdev/wsdl.php?for=CancelBooking
Запрос
1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
2 xmlns:ver="http://tst.nemo-ibe.com/wsdev/?version%3D1.0%26for%3DCancelBooking">
3 <soapenv:Header/>
4 <soapenv:Body>
5 <ver:cancel>
6 <RequestBin>
7 <Request>
8 <CancelBooking>
9 <Item Id="386621"/>
10 </CancelBooking>
11 </Request>
12 <Source>
13 <ClientId></ClientId>
14 <APIKey></APIKey>
15 <Language>ru</Language>
16 <Currency>RUB</Currency>
17 </Source>
18 </RequestBin>
19 </ver:cancel>
20 </soapenv:Body>
21 </soapenv:Envelope>
Элемент Item
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Атрибут Id | Обязательный. Идентификатор заказа в системе Nemo. | Целое число |
Элемент Source
| Элемент | Описание | Допустимые значения |
|---|---|---|
| ClientID | Обязательный. ID клиента в системе Nemo.
Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация". |
Целое число. |
| APIKey | Обязательный. APIKey - секретный ключ доступа к API Nemo.
Можно посмотреть/добавить в "Администрирование" ⇨ "Веб-служба. Авторизация". |
Латинские буквы и цифры. Всего 32 символа. |
Ответ
см. результаты бронирования.
Выгрузки статистики продаж через API
Метапоисковая система (метапоисковая машина, метапоисковик) — это поисковая система, которая в отличие от классических поисковых машин не имеет собственной базы данных и собственного поискового индекса, а формирует поисковую выдачу за счет смешивания и переранжирования результатов поиска других поисковых систем.
Необходимо убедиться, что API запросы на поиск отправляются на доменное имя, указанное для агентства (субагента) в разделе Администрирование -> Настройки агентства
Запрос
Пример запроса
http://host/index.php?go=settings/download_metasearch_stat&date1=2012-05-01&date2=2012-06-01&partner=aviasales&password=secret
Параметры запроса
| Параметр запроса | Описание |
|---|---|
| date1 | YYYY-MM-DD дата. |
| date2 | YYYY-MM-DD дата. |
| partner | Идентификатор партнёра - алиас источника переходов модуля метрики. |
| password | Пароль партнёра - пароль источника переходов модуля метрики. |
Ответ
1 <bookings>
2 <booking>
3 <nemo_id>123123</nemo_id>
4 <id>JHKHVR</id>
5 <created_at>2012-05-02 00:02:01</created_at>
6 <marker>1232:1222.t</marker>
7 <price>1199</price>
8 <profit>200</profit>
9 <currency>RUB</currency>
10 <state>PAID</state>
11 <validatingCarrier>UN</validatingCarrier>
12 <segment>
13 <flight>
14 <operatingCarrier>UN</operatingCarrier>
15 <number>3</number>
16 <departure>DME</departure>
17 <departureDate>2012-09-25</departureDate>
18 <departureTime>09:55</departureTime>
19 <arrival>LED</arrival>
20 <arrivalDate>2012-09-25</arrivalDate>
21 <arrivalTime>11:10</arrivalTime>
22 <equipment>735</equipment>
23 <cabin>Y</cabin>
24 </flight>
25 </segment>
26 <adults>1</adults>
27 <children>0</children>
28 <infants>0</infants>
29 </booking>
30 ...more bookings...
31 </bookings>
Описание параметров
/bookings - корневой элемент содержащий информацию о бронированиях.
//booking - информации об одном бронировании.
nemo_id - ид заказа в системе Немо.
id - уникальный идентификатор бронирования в системе поставщика (локатор).
created_at - YYYY-MM-DD HH:MM время и дата бронирования в таймзоне UTC; если даты бронирования нет, то дата начала создания заказа.
marker - маркер переданные в GET параметре marker при переходе на бронирование.
price - цена билетов.
profit - прибыль партнёра от данного бронирования.
currency - валюта в которой указаны прибыль и цена билета.
state - состояние брони. Допустимые значения PROCESSING/PAID/CANCELLED.
segment - информация о перелётах.
validatingCarrier - информация о бронировании.
//flight - информация об одном перелёте.
operatingCarrier - код авиакомпании осуществляющей рейс.
number - номер рейса.
departure - IATA код аэропорта отправления.
departureDate - дата отправления, 'YYYY-MM-DD', местное время.
departureTime - время отправления, 'HH:MM', местное время.
arrival - IATA код аэропорта назначения.
arrivalDate - дата прибытия, 'YYYY-MM-DD', местное время.
arrivalTime - время прибытия, 'HH:MM', местное время.
equipment - IATA транспортного средства осуществляющего перевозку.
cabin - класс перелёта. "Y" - эконом , "C" - бизнес, "F" - первый.
adults - кол-во взрослых пассажиров.
children - кол-во детей.
infants - кол-во детей до 2 лет.
Время и дата бронирования created_at передается в таймзоне UTC+4.
Состояние брони state может принимать значения:
- PROCESSING - забронирован;
- PAID - выписан;
- CANCELLED - аннулирован (по любым причинам).
Прибыль партнёра profit от данного бронирования в формате 00.99 (через точку). Размер прибыли партнера устанавливается для конкретного источника трафика в Модуле метрики и считается как процент от стоимости оплаченного заказа, включая комиссию платежного шлюза и апсейловые продажи. В последующем расчет прибыли может измениться. При возврате авиабилетов сумма ранее засчитанная как прибыль партнера (метапоисковой системы) должна подставляться с минусом в данном периоде.
Количество детей до 2 лет infants относится только к младенцам без места. Количество младенцев с местом объединяются с количеством детей до 12 лет children.
Выгрузка информации о заказах
Выгрузка заказов — это экспорт данных заказа или заказов для различных компонентов системы Nemo.
Процесс выгрузки
Схематично процесс выгрузки заказов представлен на блок-схеме.
Статусы выгрузки заказа
Коды статусов выгрузки заказа соответствуют кодам состояния HTTP. Фактически указывается последний полученный код состояния HTTP, полученный при выгрузке данных по адресу, указанному в настройках выгрузки. Коды относятся к серверу, на который происходит выгрузка заказов.
| Код | Описание |
|---|---|
| 0 | Неизвестный ответ. Адрес для выгрузки не доступен. |
| 200 | OK — успешный запрос. |
| 301 | Запрошенный документ был окончательно перенесен на новый URI, указанный в поле Location заголовка. |
| 403 | Сервер понял запрос, но он отказывается его выполнять из-за ограничений в доступе для клиента к указанному ресурсу. |
| 404 | Сервер понял запрос, но не нашёл соответствующего ресурса по указанному URI. |
| 422 | Unprocessable Entity — сервер успешно принял запрос, может работать с указанным видом данных, в теле запроса XML-документ имеет верный синтаксис, но имеется какая-то логическая ошибка, из-за которой невозможно произвести операцию над ресурсом. |
| 500 | Любая внутренняя ошибка сервера. |
Выгрузка заказа для компонента «Авиабилеты»
Для компонента «Авиабилеты» доступна выгрузка заказов в форматах Nemo и/или Софи (при включенном модуле «Выгрузка заказов Софи»).
Формат Nemo
1 <?xml version="1.0" encoding="UTF-8"?>
2 <PNR>
3 <Common>
4 <id>277749</id>
5 <Type>FLIGHTS</Type>
6 <Service>SABRE</Service>
7 <Locator>SQLJNK</Locator>
8 <ExternalId>1234567</ExternalId> <!-- Внешний идентификатор -->
9 <Stamp>123456789</Stamp>
10 <UtmSource>100</UtmSource> <!-- Источник перехода -->
11 <BeginDateTime>2014.12.18-10:45</BeginDateTime>
12 <EndDateTime>2014.12.25-16:40</EndDateTime>
13 <TicketingDateTime>2014.12.09-15:02</TicketingDateTime>
14 <VoidDateTime/>
15 <TotalPrice>
16 <Amount>10773.8</Amount>
17 <CurrencyCode>RUB</CurrencyCode>
18 </TotalPrice>
19 <UserId>2964</UserId>
20 <EEUserId/>
21 <UserLogin>userLogin</UserLogin>
22 <GroupId>2963</GroupId>
23 <CompanyId>2963</CompanyId>
24 <UserStatus>Менеджер</UserStatus>
25 <DateCreate>2014.12.09-14:59</DateCreate>
26 <ExtServices> <!-- Дополнительные услуги -->
27 <ExtService>
28 <Type>AeroExpress</Type>
29 <Price>
30 <Amount>1440</Amount>
31 <CurrencyCode>RUB</CurrencyCode>
32 </Price>
33 </ExtService>
34 <ExtService>
35 <Type>AlphaInsurance</Type>
36 <Price>
37 <Amount>480</Amount>
38 <CurrencyCode>RUB</CurrencyCode>
39 </Price>
40 <Insurances>
41 <Insurance>
42 <Number>Z694.198TEST.2765282</Number>
43 <Fio>IVANOV IVAN</Fio>
44 </Insurance>
45 <Insurance>
46 <Number>Z694.198TEST.2765283</Number>
47 <Fio>PETROV PETR</Fio>
48 </Insurance>
49 </Insurances>
50 </ExtService>
51 </ExtServices>
52 </Common>
53 <Payment>
54 <Title>Testpay</Title>
55 <Method>Testpay</Method>
56 <BillingId>117607091</BillingId>
57 <Date>2014-12-09 15:00:39</Date>
58 <CreateDate>2014-12-09 15:00:34</CreateDate>
59 <Status>ticket</Status>
60 <PenaltyDate/>
61 <Timelimit>2014-12-10 14:59:55</Timelimit>
62 <PaymentCharge> <!-- Сбор платежного шлюза -->
63 <Amount>313.8</Amount>
64 <CurrencyCode>RUB</CurrencyCode>
65 </PaymentCharge>
66 <Charge> <!-- Общий сбор минус сбор платежного шлюза -->
67 <Amount>1920</Amount>
68 <CurrencyCode>RUB</CurrencyCode>
69 </Charge>
70 <BaseFare> <!-- Тариф -->
71 <Amount>1600</Amount>
72 <CurrencyCode>RUB</CurrencyCode>
73 </BaseFare>
74 <Book> <!-- Тариф плюс таксы -->
75 <Amount>8540</Amount>
76 <CurrencyCode>RUB</CurrencyCode>
77 </Book>
78 <Penalty>
79 <Amount>0</Amount>
80 <CurrencyCode>RUB</CurrencyCode>
81 </Penalty>
82 <Total>
83 <Amount>10773.8</Amount>
84 <CurrencyCode>RUB</CurrencyCode>
85 </Total>
86 <Commission>
87 <Amount>0</Amount>
88 <CurrencyCode>RUB</CurrencyCode>
89 </Commission>
90 <PaidValue>
91 <Amount>10773.8</Amount>
92 <CurrencyCode>RUB</CurrencyCode>
93 </PaidValue>
94 </Payment>
95 <Client>
96 <LastName/>
97 <Name>SIDOROV PETR</Name>
98 <MiddleName/>
99 <Number/>
100 <Birth/>
101 <Email>mail@host.com</Email>
102 <Phone>+74950000000</Phone>
103 </Client>
104 <PassengersCount>2</PassengersCount>
105 <Passengers>
106 <Passenger>
107 <passenger_type>ADT</passenger_type>
108 <lastname>IVANOV</lastname>
109 <name>IVAN</name>
110 <gender>F</gender>
111 <date_of_birth>12.12.1987</date_of_birth>
112 <doc_type>C</doc_type>
113 <passport_number>1234567890</passport_number>
114 <currency_of_passport>24.03.2023</currency_of_passport>
115 <middlename/>
116 <passenger_id>37667</passenger_id>
117 <nationality>RU</nationality>
118 <email>mail@host.com</email>
119 <Tickets>
120 <Active>0</Active>
121 <Seg/>
122 <Num>5553984070962</Num>
123 <Date>2014-12-09 16:01:00</Date>
124 </Tickets>
125 <Tickets>
126 <Active>1</Active>
127 <Seg/>
128 <Num>5553984070964</Num>
129 <Date>2014-12-09 16:03:00</Date>
130 </Tickets>
131 <PriceInfo>
132 <BaseFare>
133 <Amount>800</Amount>
134 <CurrencyCode>RUB</CurrencyCode>
135 </BaseFare>
136 <TotalFare>
137 <Amount>4270</Amount>
138 <CurrencyCode>RUB</CurrencyCode>
139 </TotalFare>
140 <Commission>
141 <Amount>0</Amount>
142 <CurrencyCode>RUB</CurrencyCode>
143 </Commission>
144 <AirlineCommission>
145 <Amount>0</Amount>
146 <CurrencyCode>RUB</CurrencyCode>
147 </AirlineCommission>
148 </PriceInfo>
149 </Passenger>
150 <Passenger>
151 <passenger_type>ADT</passenger_type>
152 <doc_type>C</doc_type>
153 <middlename/>
154 <passenger_id>37668</passenger_id>
155 <lastname>PETROV</lastname>
156 <name>PETR</name>
157 <gender>M</gender>
158 <date_of_birth>20.12.1984</date_of_birth>
159 <passport_number>1234567899</passport_number>
160 <currency_of_passport>20.12.2029</currency_of_passport>
161 <nationality>RU</nationality>
162 <email>mail@host.com</email>
163 <Tickets>
164 <Active>0</Active>
165 <Seg/>
166 <Num>5553984070963</Num>
167 <Date>2014-12-09 16:01:00</Date>
168 </Tickets>
169 <Tickets>
170 <Active>1</Active>
171 <Seg/>
172 <Num>5553984070965</Num>
173 <Date>2014-12-09 16:03:00</Date>
174 </Tickets>
175 <PriceInfo>
176 <BaseFare>
177 <Amount>800</Amount>
178 <CurrencyCode>RUB</CurrencyCode>
179 </BaseFare>
180 <TotalFare>
181 <Amount>4270</Amount>
182 <CurrencyCode>RUB</CurrencyCode>
183 </TotalFare>
184 <Commission>
185 <Amount>0</Amount>
186 <CurrencyCode>RUB</CurrencyCode>
187 </Commission>
188 <AirlineCommission>
189 <Amount>0</Amount>
190 <CurrencyCode>RUB</CurrencyCode>
191 </AirlineCommission>
192 </PriceInfo>
193 </Passenger>
194 </Passengers>
195 <FlightType>Внутренний</FlightType>
196 <OrderInfo>
197 <Info>
198 <Company>Аэрофлот - Российские авиалинии</Company>
199 <CompanyCode>SU</CompanyCode>
200 <OperatingCompanyCode>FV</OperatingCompanyCode>
201 <StartDate>2014.12.18</StartDate>
202 <StartTime>10:45</StartTime>
203 <StartDayOfWeek>Thursday</StartDayOfWeek>
204 <FlightNumber>6128 (FV6128)</FlightNumber>
205 <StartAirportCode>VKO</StartAirportCode>
206 <StartAirportName>Внуково, Москва</StartAirportName>
207 <StartCountry>Россия</StartCountry>
208 <StartCountryCode>RU</StartCountryCode>
209 <EndAirportCode>LED</EndAirportCode>
210 <EndAirportName>Санкт-Петербург, Пулково</EndAirportName>
211 <EndCountry>Россия</EndCountry>
212 <EndCountryCode>RU</EndCountryCode>
213 <Time>1:30</Time>
214 <Equip>
215 <Name>Airbus 319</Name>
216 <Type>319</Type>
217 </Equip>
218 <ClassType>economy</ClassType>
219 <ClassTypeCode>R</ClassTypeCode>
220 <Meal/>
221 </Info>
222 <Info>
223 <Company>Аэрофлот - Российские авиалинии</Company>
224 <CompanyCode>SU</CompanyCode>
225 <OperatingCompanyCode>FV</OperatingCompanyCode>
226 <StartDate>2014.12.25</StartDate>
227 <StartTime>15:10</StartTime>
228 <StartDayOfWeek>Thursday</StartDayOfWeek>
229 <FlightNumber>6153 (FV6153)</FlightNumber>
230 <StartAirportCode>LED</StartAirportCode>
231 <StartAirportName>Санкт-Петербург, Пулково</StartAirportName>
232 <StartCountry>Россия</StartCountry>
233 <StartCountryCode>RU</StartCountryCode>
234 <EndAirportCode>VKO</EndAirportCode>
235 <EndAirportName>Внуково, Москва</EndAirportName>
236 <EndCountry>Россия</EndCountry>
237 <EndCountryCode>RU</EndCountryCode>
238 <Time>1:30</Time>
239 <Equip>
240 <Name>Airbus 319</Name>
241 <Type>319</Type>
242 </Equip>
243 <ClassType>economy</ClassType>
244 <ClassTypeCode>R</ClassTypeCode>
245 <Meal/>
246 </Info>
247 </OrderInfo>
248 <Remarks>Debit</Remarks>
249 </PNR>
Ремарка <Remarks>Debit</Remarks> является не обязательной, означает что заказ был оплачен с помощью способа оплаты «Депозит»; если же заказ был оплачен с использованием депозитного кредита, и депозит ушел в минус даже на 1 руб., то будет <Remarks>Credit</Remarks>.
Элемент <TotalFare> возвращает стоимость уже оплаченного заказа. Если же заказ забронирован, но не оплачен, то значение будет 0 RUB.
Элемент <CreateDate> в зависимости от состояния брони возвращает время окончания бронирования, если бронирование было завершено, иначе возвращает время создания брони.
Формат поддерживает возможность передачи нескольких номеров электронных билетов на одного пассажира (в том числе войдированных и аннулированных).
Формат Софи
1 <?xml version="1.0" encoding="UTF-8"?>
2 <order_snapshot xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3 <header currency="RUB" time_gmt="2015-01-13 08:10:54" time="2015-01-13 12:10:54" ord_id="279307" corp_ord_id="MKQFBZ" site="2806"/>
4 <customer email="cepogilixe@lackmail.net" phone="XXXX9048" name="" corp_code="2806"/>
5 <products>
6 <product>
7 <!--@stamp - валидатор. Парсится из заказа(Сирена и Галилео). Если получить из ГДС не удалось, то передаётся валидатор, настроенный в реквизитах подключения к ГДС.-->
8 <air_ticket_prod prod_id="0" psg_type="A" title="Москва - Ленинград" taxes="1776" fare="400" origin="MOW" service_fee="100" form_owner="SU" validating_carrier="SU" destination="LED" comission="0.4" stamp="92354802">
9 <air_seg segment_id="0" carrier="SU" flight_number="6128" op_carrier="FV" departure_datetime="2015-01-16 10:45:00" arrival_datetime="2015-01-16 12:15:00" departure_airport="VKO" arrival_airport="LED" fare_basis="RPROWRF"/>
10 </air_ticket_prod>
11 </product>
12 <product>
13 <ral_ticket_prod rsrv_id="2496500" prod_id="200" origin="Киевский вокзал" destination="Внуково, Москва" departure_datetime="2015-01-16 06:45:00" cartype="standart" fare="360"/>
14 </product>
15 <product>
16 <service_prod prod_id="300" provider_type="INSURANCE" provider_id="AlphaInsurance" offer_type="alpha_insurance" ext_id="Z694.198TEST.2774397" price="100" count="1" psgr_id="0"/>
17 </product>
18 <product>
19 <payment_prod price="123"/>
20 </product>
21 </products>
22 <reservations>
23 <reservation rsrv_id="279307" crs="SABRE" rloc="MKQFBZ"/>
24 <reservation rsrv_id="2496500" crs="AeroExpress" rloc="218812"/>
25 </reservations>
26 <passengers>
27 <passenger doc_number="1234567890" psgr_id="0" doc_country="RU" psgr_type="A" doc_type="C" birth_date="1990-01-04" name="IVAN" gender="M" first_name="IVANOV"/>
28 </passengers>
29 <travel_docs>
30 <travel_doc>
31 <air_ticket_doc tkt_oper="TKT" tkt_number="5555871998698" tkt_date="2015-01-13 12:10:50" prod_id="0" psgr_id="0" issuingAgent="2807"/>
32 </travel_doc>
33 <travel_doc>
34 <aex_doc rsrv_id="2496500" prod_id="200" psgr_id="0" tkt_oper="TKT" tkt_date="2015-01-13 12:10:54" tkt_number="394612"/>
35 </travel_doc>
36 <travel_doc>
37 <insur_doc main_prod_id="0" prod_id="300" psgr_id="0" tkt_oper="TKT" tkt_date="2015-01-13 12:10:54" tkt_number="Z694.198TEST.2774397"/>
38 </travel_doc>
39 </travel_docs>
40 <payments>
41 <payment pay_id="117607839" pay_oper="PAY" pay_time="2015-01-13 12:09:52" psp_code="024" psp_name="Rapida" psp_pay_id="" pay_system="ES" amount="2859" fop="CA"/>
42 </payments>
43 </order_snapshot>
- service_fee — сбор агентский (только сервисный сбор, не включает в себя сбор за эквайринг).
- comission - комиссия АК
- stamp - код Валидатора в ПСС, берется из настроек Немо, если в настройках он не указан, то не передается.
- ord_id — идентификатор заказа в НЕМО
- corp_ord_id — PNR из ГДС
- site — идентификатор агентства в Немо
- payment pay_id — номер биллинга Немо.
- pay_system — код платежной системы
- SB — для сбербанка
- ES — для Рапиды
- UNT — для Юнителлера
- cardholder — держатель карты.
- expire_date — срок действия карты, у тех ПШ, что не приходит в ответе — пустой.
- card_number — номер карты, в формате: 415481XXXXXX1734
- approval_code — код подтверждения.
- payment_prod price — сбор за эквайринг.
- main_prod_id - ID основного продукта (авиабилета).
- tkt_number - номер полиса для пассажира;
- tkt_date - дата и время операции;
- tkt_oper - тип операции (TKT/REF).
- provider_type - тип поставщика (INSURANCE).
- provider_id - AlphaInsurance;
- offer_type - название полиса;
- price - цена полиса для пассажира;
- rloc - номер заказа у поставщика.
Выгрузка заказа для компонента «Отели»
Для компонента «Отели» доступна выгрузка заказов в формате Nemo.
Формат Nemo
1 <?xml version="1.0" encoding="UTF-8"?>
2 <PNR>
3 <Common>
4 <id>263462</id>
5 <Type>HOTELS</Type>
6 <Service>ACADEM</Service>
7 <Locator>3028655</Locator>
8 <BeginDateTime>2014.04.15-00:00</BeginDateTime>
9 <EndDateTime>2014.04.16-00:00</EndDateTime>
10 <TotalPrice>
11 <Amount>1950</Amount>
12 <CurrencyCode>RUB</CurrencyCode>
13 </TotalPrice>
14 <UserId>123</UserId>
15 <EEUserId />
16 <UserLogin>userLogin</UserLogin>
17 <GroupId>332</GroupId>
18 <UserStatus>Менеджер</UserStatus>
19 <DateCreate>2014.03.21-16:11</DateCreate>
20 </Common>
21 <Payment>
22 <Status>booked</Status>
23 <PenaltyDate>2014.04.13-00:00</PenaltyDate>
24 <Timelimit>2014-04-13 00:00:00</Timelimit>
25 <Charge>
26 <Amount>0</Amount>
27 <CurrencyCode>RUB</CurrencyCode>
28 </Charge>
29 <Book>
30 <Amount>1950</Amount>
31 <CurrencyCode>RUB</CurrencyCode>
32 </Book>
33 <Penalty>
34 <Amount>0</Amount>
35 <CurrencyCode>RUB</CurrencyCode>
36 </Penalty>
37 <Total>
38 <Amount>1950</Amount>
39 <CurrencyCode>RUB</CurrencyCode>
40 </Total>
41 <Commission>
42 <Amount>112</Amount>
43 <CurrencyCode>RUB</CurrencyCode>
44 </Commission>
45 <PaidValue>
46 <Amount>0</Amount>
47 <CurrencyCode>RUB</CurrencyCode>
48 </PaidValue>
49 </Payment>
50 <Client>
51 <LastName>Сидоров</LastName>
52 <Name>Владимир</Name>
53 <MiddleName>Константинович</MiddleName>
54 <Number>1806326598</Number>
55 <Birth>1987-05-20</Birth>
56 <Email>mail@host.com</Email>
57 <Phone>+79871234567</Phone>
58 </Client>
59 <Passengers>
60 <Passenger>
61 <nationality>RU</nationality>
62 <lastname>IVANOV</lastname>
63 <name>IVAN</name>
64 </Passenger>
65 </Passengers>
66 <Info>
67 <Name>Интурист</Name>
68 <City>
69 <Code>34</Code>
70 <Name>Великий Новгород</Name>
71 </City>
72 <Location />
73 <StarRating>3</StarRating>
74 <Days>2</Days>
75 <Nights>1</Nights>
76 <CheckInDate>2014.04.15</CheckInDate>
77 <CheckOutDate>2014.04.16</CheckOutDate>
78 <CheckInTime>14:00</CheckInTime>
79 <CheckOutTime>12:00</CheckOutTime>
80 <OnRequest>false</OnRequest>
81 </Info>
82 <Rooms>
83 <Room>
84 <Name>Двухместный стандарт (две кровати)</Name>
85 <Type>SNGL</Type>
86 <FareId>1</FareId>
87 </Room>
88 </Rooms>
89 <Fares>
90 <Fare>
91 <Id>1</Id>
92 <Price>
93 <Amount>1950</Amount>
94 <CurrencyCode>RUB</CurrencyCode>
95 </Price>
96 <Meals>Завтрак "Шведский стол",Отсутствует</Meals>
97 <Description>Одноместный</Description>
98 </Fare>
99 </Fares>
100 <CancelCharges>
101 <Charge>
102 <DateFrom>2014.04.13-00:00</DateFrom>
103 <DateTo>2014.04.15-00:00</DateTo>
104 <Amount>1488</Amount>
105 <CurrencyCode>RUB</CurrencyCode>
106 </Charge>
107 </CancelCharges>
108 <ModifyCharges />
109 <ModificationMethods>
110 <Method>MOD_PASS_NAMES</Method>
111 <Method>MOD_DATES</Method>
112 </ModificationMethods>
113 </PNR>
Выгрузка заказа для компонента «ЖД»
Для компонента «ЖД» доступна выгрузка заказов в формате Nemo.
Формат Nemo
1 <?xml version="1.0" encoding="UTF-8"?>
2 <PNR>
3 <Common>
4 <id>123456</id>
5 <Type>TRAINS</Type>
6 <Service>UFS</Service>
7 <Locator>64345987</Locator>
8 <BeginDateTime>2014.04.26-00:15</BeginDateTime>
9 <EndDateTime>2014.04.26-13:33</EndDateTime>
10 <TicketingDateTime>2014.06.06-15:10</TicketingDateTime>
11 <VoidDateTime>2014.06.07-14:19</VoidDateTime>
12 <TotalPrice>
13 <Amount>57505.8</Amount>
14 <CurrencyCode>RUB</CurrencyCode>
15 </TotalPrice>
16 <UserId>123</UserId>
17 <EEUserId />
18 <UserLogin>mikhalevtur</UserLogin>
19 <GroupId>122</GroupId>
20 <UserStatus>Менеджер</UserStatus>
21 <DateCreate>2014.04.24-15:03</DateCreate>
22 </Common>
23 <Payment>
24 <Title>Testpay</Title>
25 <Method>Testpay</Method>
26 <BillingId>117603370</BillingId>
27 <Date>2014-04-24 15:10:12</Date>
28 <CreateDate>2014-06-06 15:10:00</CreateDate>
29 <Status>cancelled</Status>
30 <PenaltyDate />
31 <Timelimit>2014-04-24 15:18:01</Timelimit>
32 <Charge>
33 <Amount>52278</Amount>
34 <CurrencyCode>RUB</CurrencyCode>
35 </Charge>
36 <Book>
37 <Amount>5227.8</Amount>
38 <CurrencyCode>RUB</CurrencyCode>
39 </Book>
40 <Penalty>
41 <Amount>0</Amount>
42 <CurrencyCode>RUB</CurrencyCode>
43 </Penalty>
44 <TotalAgencyChargeForRefund>
45 <Amount>100</Amount>
46 <CurrencyCode>RUB</CurrencyCode>
47 </TotalAgencyChargeForRefund>
48 <Total>
49 <Amount>57505.8</Amount>
50 <CurrencyCode>RUB</CurrencyCode>
51 </Total>
52 <PaidValue>
53 <Amount>0</Amount>
54 <CurrencyCode>RUB</CurrencyCode>
55 </PaidValue>
56 </Payment>
57 <Client>
58 <LastName>Сидоров</LastName>
59 <Name>Владимир</Name>
60 <MiddleName>Константинович</MiddleName>
61 <Number>1806326598</Number>
62 <Birth>1987-05-20</Birth>
63 <Email>mail@host.com</Email>
64 <Phone>+79871234567</Phone>
65 </Client>
66 <Passengers>
67 <Passenger>
68 <name>Владимир</name>
69 <middlename>Константинович</middlename>
70 <phone>
71 <country />
72 <city />
73 <number>+79271031610</number>
74 <expansion />
75 </phone>
76 <email>mlsdsar@gmail.com</email>
77 <nationality>RU</nationality>
78 <passenger_type>ADT</passenger_type>
79 <lastname>Сидоров</lastname>
80 <doc_type>C</doc_type>
81 <passport_number>1806326598</passport_number>
82 <passenger_id>1</passenger_id>
83 <gender>M</gender>
84 <date_of_birth>20.04.1984</date_of_birth>
85 <TotalPrice>28752.9</TotalPrice>
86 <FarePrice>2613.9</FarePrice>
87 <Charge>26139</Charge>
88 <RefundMoney>8649.3</RefundMoney>
89 <ChargeForRefund>100</ChargeForRefund>
90 <TicketNumber>74944708487545</TicketNumber>
91 <SeatNumber>033</SeatNumber>
92 <HasSeat>true</HasSeat>
93 </Passenger>
94 <Passenger>
95 <nationality>RU</nationality>
96 <middlename>Константинович</middlename>
97 <passenger_type>ADT</passenger_type>
98 <lastname>Сидоров</lastname>
99 <name>Иван</name>
100 <doc_type>C</doc_type>
101 <passport_number>1806326554</passport_number>
102 <passenger_id>2</passenger_id>
103 <gender>M</gender>
104 <date_of_birth>05.04.1984</date_of_birth>
105 <TotalPrice>28752.9</TotalPrice>
106 <FarePrice>2613.9</FarePrice>
107 <Charge>26139</Charge>
108 <TicketNumber />
109 <SeatNumber>034</SeatNumber>
110 <HasSeat>true</HasSeat>
111 </Passenger>
112 </Passengers>
113 <Info>
114 <trainNumber>098ХА</trainNumber>
115 <trainName />
116 <departureStation>МОСКВА КАЗ</departureStation>
117 <arrivalStation>КАЗАНЬ ПАС</arrivalStation>
118 <trainCategory>1</trainCategory>
119 <beginStation>Москва</beginStation>
120 <endStation>Казань</endStation>
121 <startDate>2014-04-26 00:15:00</startDate>
122 <endDate>2014-04-26 13:33:00</endDate>
123 <timeInRoad>47880</timeInRoad>
124 <carNumber>8</carNumber>
125 <carType>4</carType>
126 <choosenSeats>
127 <type>
128 <lower>1</lower>
129 </type>
130 <type>
131 <upper>1</upper>
132 </type>
133 <type>
134 <lower_side>0</lower_side>
135 </type>
136 <type>
137 <upper_side>0</upper_side>
138 </type>
139 <type>
140 <undefined>0</undefined>
141 </type>
142 </choosenSeats>
143 <choosenRange>
144 <start>0</start>
145 <end>0</end>
146 </choosenRange>
147 <serviceClass>В стоимость входит - постельное белье. Наличие установки кондиционирования воздуха не гарантировано.</serviceClass>
148 </Info>
149 </PNR>
Элемент PNR Элемент PNR — Passenger Name Record — запись, состоящая из группы отдельных элементов (полей), содержащих информацию об одном или более пассажирах, путешествующих вместе, и деталях путешествия.
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Common | Общая информация по заказу. | Элементы id, Type, Service, Locator, BeginDateTime, EndDateTime, TicketingDateTime, TotalPrice, UserId, EEUserId, UserLogin, GroupId, UserStatus, DateCreate. |
| Payment | Информация о стоимости, штрафах, статусе заказа. | Элементы Status, PenaltyDate, Timelimit, Charge, Book, Penalty, Total, PaidValue. |
| Client | Информация о заказчике. | Элементы Name, MiddleName, Number, Birth, Email, Phone. |
| Passengers | Записи о пассажирах. | Элементы Passenger. |
| Info | Типовая информация по заказу в контексте услуги. | Элементы trainNumber, trainName, departureStation, arrivalStation, trainCategory, beginStation, endStation, startDate, endDate, timeInRoad, carNumber, carType, choosenSeats, choosenRange, serviceClass. |
Элемент Common
| Элемент | Описание | Допустимые значения |
|---|---|---|
| id | Номер заказа в Немо. | Число. Пример: 268281. |
| Type | Тип услуги. | Строка: Пример: FLIGHTS. Допустимые значения:
|
| Service | Поставщик услуги. | Строка. Пример: UFS. |
| Locator | Идентификатор в системе поставщика. | Число. Пример: 65525140. |
| BeginDateTime | Дата и время отправления первого сегмента. | Дата и время. Пример: 2014.03.06-00:15. |
| EndDateTime | Дата и время прибытия последнего сегмента. | Дата и время. Пример: 2014.03.06-13:33. |
| TicketingDateTime | Дата и время выписки билета. | Дата и время. Пример: 2014.10.17-17:23 |
| VoidDateTime | Дата и время возврата билета. | Дата и время. Пример: 2014.10.17-17:23 |
| TotalPrice | Общая стоимость заказа. | Элементы Amount — номинал стоимости, CurrencyCode — валюта стоимости. |
| UserId | Идентификатор пользователя в системе Немо, оформившего заказ. | Число. Пример: 123. |
| UserLogin | Логин пользователя в системе Немо, оформившего заказ. | Строка. Пример: userLogin. |
| GroupId | Идентификатор группы пользователя в системе Немо, оформившего заказ. | Число. Пример: 122. |
| UserStatus | Тип пользователя в системе Немо. | Строка. Пример: Менеджер. |
| DateCreate | Дата и время резервирования в системе поставщика. | Дата и время. Пример: 2014.03.05-15:08 |
Элемент TotalPrice
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Amount | Номинал. | Число. Пример: 1884. |
| CurrencyCode | Валюта. | Строка (Код ISO 4217 alfa-3). Пример: RUB. |
Элемент Payment
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Title | Название платежного шлюза*. | Строка. Пример: Testpay. |
| Method | Тип формы оплаты*. | Строка. Пример: Testpay. |
| BillingId | Идентификатор транзакции Немо. | Строка. Пример: 117603370. |
| Date | Дата и время оплаты платежной транзакции Немо. | Строка. Пример: 2014-04-24 15:10:12. |
| CreateDate | Дата и время создания платежной транзакции Немо. | Строка. Пример: 2014-06-06 15:10:00. |
| Status | Статус заказа в системе Немо. | Строка. Пример: booked. Допустимые значения:
|
| PenaltyDate | Дата и время наступления штрафных санкций. | Дата и время. Пример: 2014-03-05 15:23:40. |
| Timelimit | Таймлимит на оплату и подтверждение заказа. | Дата и время. Пример: 2014-03-05 15:23:40. |
| Charge | Сбор агентства. | См. элемент Common.TotalPrice. |
| Book | Тариф. | См. элемент Common.TotalPrice. |
| Penalty | Штраф.
|
См. элемент Common.TotalPrice. |
| TotalAgencyChargeForRefund | Общий сбор агентства за возврат. | См. элемент Common.TotalPrice. |
| Total | Общая стоимость. | См. элемент Common.TotalPrice. |
| PaidValue | Оплачено. | См. элемент Common.TotalPrice. |
* — список возможный платежных шлюзов:
Acquiro, Chronopay, Copayco, CourierNew, Deposit, EasyPay, GatelineNew, ITransfer, Invoice, Offices, PayU, Payture, Platron, PrivatBank, Qiwi, Rapida, Receipt, Sberbank, Sirena, Sirena2, UnitellerNew, WebMoney.
Элемент Client
| Элемент | Описание | Допустимые значения |
|---|---|---|
| Name | Фамилия и имя заказчика. | Строка. Пример: Иванов Иван. |
| MiddleName | Отчество заказчика. | Строка. Пример: Иванович. |
| Number | Серия и номер документа. | Строка. Пример: 1806123456. |
| Birth | Дата рождения заказчика. | Дата. Пример: 1984-06-30. |
| Адрес электронной почты заказчика. | Строка. Пример: client@host.com. | |
| Phone | Номер телефона заказчика. | Строка. Пример: +74951234567 |
Элемент Passenger
| Элемент | Описание | Допустимые значения |
|---|---|---|
| lastname | Фамилия пассажира. | Строка. Пример: Сидоров. |
| name | Имя пассажира. | Строка. Пример: Владимир. |
| middlename | Отчество пассажира. | Строка. Пример: Константинович. |
| doc_type | Тип документа. | Строка. Пример: C. Допустимые значения:
|
| passport_number | Серия и номер документа. | Строка. Пример: 1806123456. |
| gender | Пол пассажира. | Строка. Пример: M. Допустимые значения:
|
| date_of_birth | Дата рождения пассажира. | Дата. Пример: 20.05.1987. |
| nationality | Гражданство пассажира. | Строка (ISO 3166-1 Alpha-2). Пример: RU. |
| passenger_type | Тип пассажира. | Строка. Пример: ADT. Допустимые значения:
|
| passenger_id | Порядковый номер пассажира в заказе. | Число. Пример: 2. |
| TotalPrice | Общая стоимость билета со сборами для данного пассажира. | Число. Пример: 1934. |
| FarePrice | Стоимость по тарифу тарифу. | Число. Пример: 1884. |
| Charge | Сбор агентства. | Число. Пример: 50. |
| RefundMoney | Сумма к возврату. Значение, полученное от поставщика, уменьшенное на сумму сбора агентства за возврат. | Число. Пример: 1643. |
| ChargeForRefund | Cбор агентства за возврат. | Число. Пример: 100. |
| TicketNumber | Номер билета. | Число. Пример: 73944708472624. |
| SeatNumber | Номер места. | число. Пример: 21. |
| TariffType | Наименование тарифа. | Строка. Пример: ПОЛНЫЙ. |
| HasSeat | Занимает ли пассажир отдельное место. | Допустимые значения:
|
* — Не включая верхний предел. Возраст ребенка определяется на день совершения поездки.
** — Нижний и верхний пределы определяются видом сообщения:
- от 5 до 10 лет — Внутригосударственное сообщение, а также международное сообщение со странами-участниками СНГ, Литовской, Латвийской, Эстонской Республиками, Республикой Абхазия.
- от 6 до 17 лет — Международное сообщение в дальнем зарубежье по глобальным ценам. Направление Россия-Финляндия.
- от 4 до 12 лет — Международное сообщение в дальнем зарубежье по глобальным ценам. Направление Восток-Запад.
*** — Верхний предел определяется видом сообщения:
- до 5 лет — Внутригосударственное сообщение, а также международное сообщение со странами-участниками СНГ, Литовской, Латвийской, Эстонской Республиками, Республикой Абхазия.
- до 6 лет — Международное сообщение в дальнем зарубежье по глобальным ценам. Направление Россия-Финляндия.
- до 4 лет — Международное сообщение в дальнем зарубежье по глобальным ценам. Направление Восток-Запад.
Элемент Passenger
| Элемент | Описание | Допустимые значения |
|---|---|---|
| trainNumber | Номер поезда. | Строка. Пример: 098ХА. |
| trainName | Имя фирменного поезда. Приходит от поставщика. | Строка. Пример: Россия. |
| departureStation | Станция отправления пассажира. | Строка. Пример: МОСКВА КАЗ. |
| arrivalStation | Станция прибытия пассажира. | Строка. Пример: КАЗАНЬ ПАС. |
| trainCategory | Тип поезда. | Число. Пример: 1. Допустимые значения:
|
| beginStation | Начальная станция в маршруте поезда. | Строка. Пример: Казань |
| endStation | Конечная станция в маршруте поезда. | Строка. Пример: Москва |
| startDate | Дата и время отправления со станции отправления пассажира. | Дата и время. Пример: 2014-03-06 00:15:00. |
| endDate | Дата и время прибытия со станции отправления пассажира. | Дата и время. Пример: 2014-03-06 13:33:00. |
| timeInRoad | Время в пути от станции отправления до станции прибытия пассажира. | Число (секунд). Пример: 47880. |
| carNumber | Номер вагона. | Число. Пример: 7. |
| carType | Тип вагона. | Число. Пример: 1. Допустимые значения:
|
| choosenSeats | Элемент описывает количество нижних, нижних боковых, верхних, верхних боковых мест. | Элементы type. |
| choosenRange | Выбранный диапазон мест в вагоне. | Элементы start, end. |
| serviceClass | Описание услуг. Приходит от поставщика. | Текст. Пример: В стоимость входит - постельное белье. Наличие установки кондиционирования воздуха не гарантировано. |
Элемент type
| Элемент | Описание | Допустимые значения |
|---|---|---|
| lower | Количество нижних мест. | Число. Пример: 1. |
| upper | Количество верхних мест. | Число. Пример: 0. |
| lower_side | Количество нижних боковых мест. | Число. Пример: 1. |
| upper_side | Количество верхних боковых мест. | Число. Пример: 1. |
| undefined | Количество мест неопределенного типа. | Число. Пример: 0. |
Элемент choosenRange
| Элемент | Описание | Допустимые значения |
|---|---|---|
| start | Начало выбранного диапазон мест в вагоне*. | Число. Пример: 4. |
| end | Конец выбранного диапазон мест в вагоне*. | Число. Пример: 17. |
* — Если диапазон не был зада пользователем на этапе выбора мест, то поля start и end будут содержать нули.
Пакетный экспорт заказов по категориям в формате Nemo
Сервис выгрузки заказов позволяет экспортировать интересующие выборки по заказам в формате XML. Например, можно выбрать все заказы по дате бронирования и получить информацию по ним в XML-виде.
Экспорт заказов под авторизованным пользователем (в личном кабинете)
.png)
Порядок пользования сервисом:
- Перейти в личный кабинет
- В адресной строке браузера к текущему адресу дописать параметр &exportxml. Должен получиться адрес вида:
http://DOMAIN/index.php?go=poffice/table&exportxml
- После обновления страницы под блоком фильтров должна появиться кнопка «Экспортировать в XML». При ее нажатии на странице появляется предложение сохранить в XML-файл выборку отфильтрованных заказов.
Выгружаются только заказы выбранного пользователя/компании с учетом примененных параметров фильтра.
Пользователь может произвести выгрузку только своих заказов.
Пакетный экспорт заказов по категориям в формате СОФИ
Для использования выгрузки заказов в формате СОФИ у агентства должен быть включен модуль "Выгрузка заказов Софи" и заданы настройки:
- "Тип выгрузки СОФИ" должен иметь значение "Выгрузка заказов СОФИ" или должна быть включена настройка "Выгрузка одновременно и Nemo, и Софи",
- Должен быть указан "Url скрипта для выгрузки в формате СОФИ",
- Должен быть указан "Код сайта в системе СОФИ".
Выгрузка конкретного заказа:
http://DOMAIN/booking__sofi_export_bookings&booking_id=123456 где booking_id — номер заказа в системе Немо.
Выгрузка заказов забронированных за определенный период:
http://DOMAIN/booking__sofi_export_bookings&date_begin=01.01.2014&date_end=01.01.2015 где [date_begin; date_end] — период бронирования заказа (забронированные заказы с датой бронирования совпадающей с началом/окончанием периода, заданного в запросе, попадают в экспорт), формат — дд.мм.гггг.
Фиксация оплаты внешним запросом
!!! не нашел, есть просто фиксация оплаты, но это вроде немного не то !!!
API универсального платежного шлюза
!!! сказано спросить у КШ, я спросил, у него нет информации !!!
API Синхронизации пользователей и субагентов
Назначение данного модуля — обеспечение взаимодействия между сторонней программой (например, системой автоматизации туроператора "САМО-тур") и Nemo в части синхронизации списка B2B-пользователей.
Модуль является компонентом, включаемым и отключаемым из административной части.
Авторизация B2B-пользователей
Все B2B-пользователи, загруженные через модуль взаимодействия со сторонней программой, будут иметь случайным образом сгенерированный криптостойкий пароль. Механизм авторизации работает следующим образом:
1.Система пытается авторизовать пользователя через собственную службу авторизации. 2.В случае неудачи, но присутствия в системе введенного логина, она должна попытаться авторизовать пользователя во внешней службе авторизации («САМО-тур»), при включенном компоненте взаимодействия с «САМО-тур». 3.В случае неудачного опознавания пользователя выводится соответствующее сообщение и процедура может быть повторена путем повторного ввода логина и пароля.
Регистрация неудачных попыток входа производится только в двух случаях:
- Компонент взаимодействия выключен.
- Компонент взаимодействия включен и провалены обе попытки авторизации (внутренней и внешней).
Для сторонней авторизации пользователей в системе Nemo внешняя программа должна иметь веб-службу, основанную на WSDL определенного формата. Ссылка на веб-службу прописывается в настройках системы Nemo на странице конфигурации интеграции с внешней системой.
Для импортированных пользователей в Nemo имеется поле «Идентификатор внешней системы», который отвечает за сопоставление с ID пользователя в сторонней системе. Для менеджеров агентств оно равно номеру партнера (агента) во внешней системе, для пользователей — номеру пользователя в «САМО-туре».
Для пользователей, имеющих какое-либо значение в поле «идентификатор во внешней системе», запрещен функционал смены пароля или его восстановления по электронной почте.
Пример запросов и ответов на авторизацию:
Request
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<getAuthorization xmlns="http://tempuri.org/">
<login>string</login>
<pass>string</pass>
</getAuthorization>
</soap12:Body>
</soap12:Envelope>
Response
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<getAuthorizationResponse xmlns="http://tempuri.org/">
<getAuthorizationResult>
<session_id>string</session_id>
<user_id>string</user_id>
<login>string</login>
<status>string</status>
</getAuthorizationResult>
</getAuthorizationResponse>
</soap12:Body>
</soap12:Envelope>
Сервис реализует функцию «getAuthorization», на вход которой передается конструкция «getAuthorizationRequest»:
- login (строка) - введенный пользователем логин
- pass (строка) - введенный пользователем пароль
Функция должна отдавать системе конструкцию getAuthorizationResponse:
- session_id (строка) - пустое значение
- user_id (строка) - идентификатор менеджера в системе «САМО-тур»
- login (строка) - логин пользователя (для контроля)
- status (строка) - может иметь значения:
1. adm - администратор 2. mgr - менеджер 3. usr - пользователь (возвращается всегда это значение)
Импорт и синхронизация учетных записей
Со стороны внешней системы должно быть приложение, отправляющее в формате XML данные по учетным записям B2B-клиентов (агентств и пользователей). Со стороны Nemo имеется скрипт, который принимает XML в формате, приведенном в описании документов, передаваемых в Nemo, с ключом авторизации, определенным в Nemo в административной части модуля.
Передаваемые элементы с описанием учетных записей и партнеров имеют аккаунт (Account ID) во внешней системе и атрибут action, который может быть в состоянии update или delete, т.е. обновления/добавления и удаления, соответственно.
В административной части модуля в Nemo задается ключ авторизации для защиты от несанкционированного доступа. Значение не должно быть пустым.
Скрипт получает данные об обновлении и добавлении (проходят как одно и то же действие) или удалении информации по аккаунту. XML-данные могут содержать несколько элементов.
Описание передаваемых в Nemo XML-документов:
<?xml version="1.0" encoding="UTF-8" ?>
<changes key="ключ_авторизации">
<accounts> - список изменений по аккаунтам пользователей
<item id=3 partnerId=10 action="update" admin="1">
<login>Логин пользователя</login>
</item>
<item id=6 partnerId=15 action="update">
...
</item>
<item id=9 partnerId=30 action="delete" />
</accounts>
<partners> - список изменений по партнерам
<item id=140 action="update">
<name>Название агентства</name>
<ofname>Официальное Название агентства</ofname>
<phone>Телефон</phone>
<tax>Форма налогообложения</tax>
<group>123</group>
<code>ABCD</item>
</partners></changes></code>
При импорте информации об агентствах будут возвращаться следующие значения:
| Поле во внешней системе | Путь к элементу xml | Тип данных | Сопоставляемое поле в Nemo | Примечание |
|---|---|---|---|---|
| Идентификатор партнера | /changes/partners/item[@id] | Целое число | Идентификатор во внешней системе для менеджера / администратора | |
| Название юридического лица | /changes/partners/item/ofname | Строка | Полное официальное название юридического лица | Необходимо для выписки счетов юридическими лицами |
| Сокращенное название | /changes/partners/item/name | Строка | Имя агентства | |
| Код агентства | /changes/partners/item/code | Строка | Используется при создании логина администратора | |
| Номер группы в самотуре | /changes/partners/item/group | Целое число, либо пусто | На основании таблицы сопоставлений (см. ниже) определяется, к какой группе агентство принадлежит в Nemo | |
| Форма налогообложения | /changes/partners/item/tax | Целое число, равное идентификатору во внешней системе |
Для каждого возвращенного агентства Nemo проверяет наличие его в своей базе. Если агентство не найдено, то создается новое, для него создается менеджер (админ) с логином ABCD-1234, где ABCD – буквенный идентификатор партнера во внешней системе, 1234 — id партнера во внешней системе. Пароль генерируется случайный и криптостойкий.
Если агентство найдено, то в случае необходимости производится обновление всех полей на основании данных из внешней системы. Если изменился буквенный код агентства, то Nemo переименовывает менеджера в соответствии с новым кодом. При импорте информации о пользователях агентств в Nemo будут посылаться следующие поля:
| Поле во внешней системе | Путь к элементу xml | Тип данных | Сопоставляемое поле в Nemo | Примечание |
|---|---|---|---|---|
| Идентификатор пользователя | /changes/accounts/item[@id] | Целое число | Идентификатор внешней системы | Храним как дополнительное поле |
| Идентификатор партнера | /changes/accounts/item[@partnerId] | Целое число | Идентификатор внешней системы менеджера агентства | |
| Логин | /changes/accounts/item/login | Строка | Логин пользователя | |
| Администратор | /changes/accounts/item[@admin] | 0 - нет, 1 - да | Эксперт по бронированию |
Для каждого возвращенного пользователя Nemo проверяет наличие его в своей базе. Если пользователь не найден, то создается новый. Пароль генерируется случайный и криптостойкий.
Если пользователь найден, то в случае необходимости производится обновление всех полей на основании данных из внешней системы. При запросе на удаление пользователя, в Nemo указанный логин удаляться не будет в целях сохранения целостности старых данных, а просто помечается как удаленный, и логин переименовывается и становится вида [логин_пользователя]_X_[числовой идентификатор_пользователя в Само].
<item id=[идентификатор] action="delete" />
Таблица сопоставлений групп
В административной части Nemo надо создать отдельную страницу, на которой можно сопоставить имеющиеся группы в Nemo номерам групп в САМО-тур (поле group в XML). Выводится список существующих групп для текущего (корневого) агентства.
API Кроссавторизации
Система Nemo позволяет обращаться к ней как базе пользователей для авторизации из других систем (например форума на сайте, собственного ПО компании и т.п)
Для этого нужно подключиться к веб-службе авторизации, WSDL-описание которой располагается по адресу:
http://hostname/authorization_reol.wsdl
Запрос
?xml version ='1.0' encoding ='UTF-8' ?>
<definitions name='Authorization'
targetNamespace='http://example.org/Authorization'
xmlns:tns=' http://example.org/Authorization '
xmlns:soap='http://schemas.xmlsoap.org/wsdl/soap/'
xmlns:xsd='http://www.w3.org/2001/XMLSchema'
xmlns:soapenc='http://schemas.xmlsoap.org/soap/encoding/'
xmlns:wsdl='http://schemas.xmlsoap.org/wsdl/'
xmlns='http://schemas.xmlsoap.org/wsdl/'>
<message name='getAuthorizationRequest'>
<part name='login' type='xsd:string'/>
<part name='pass' type='xsd:string'/>
</message>
<message name='getAuthorizationResponse'>
<part name='session_id' type='xsd:string'/>
<part name='user_id' type='xsd:string'/>
<part name='login' type='xsd:string'/>
<part name='status' type='xsd:string'/>
</message>
<portType name='AuthorizationPortType'>
<operation name='getAuthorization'>
<input message='tns:getAuthorizationRequest'/>
<output message='tns:getAuthorizationResponse'/>
</operation>
</portType>
<binding name='AuthorizationBinding' type='tns:AuthorizationPortType'>
<soap:binding style='rpc'
transport='http://schemas.xmlsoap.org/soap/http'/>
<operation name='getAuthorization'>
<soap:operation soapAction='urn:xmethods-delayed-quotes#getAuthorization'/>
<input>
<soap:body use='encoded' namespace='urn:xmethods-delayed-quotes'
encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'/>
</input>
<output>
<soap:body use='encoded' namespace='urn:xmethods-delayed-quotes'
encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'/>
</output>
</operation>
</binding>
<service name='AuthorizationService'>
<port name='AuthorizationPort' binding='AuthorizationBinding'>
<soap:address location='http://nemo.local/controllers/authorization/auth_server.php'/>
</port>
</service>
</definitions>
Передача параметров в форму поиска
Описанная функциональность не входит в стандартную поставку системы.
Для получения возможности использовать ее, пожалуйста, обратитесь в коммерческий отдел.
В системе Nemo имеется возможность перенаправлять пользователей на страницу с уже заполненными параметрами поиска или сразу напрямую на результаты поиска.
Применение
Эта технология может использоватся к примеру для формирования ссылок с баннеров, при клике на которые пользователь попадает на форму, на которой уже могут быть заполнены пункты назначения, даты, количество пассажиров и прочие параметры.
Также, при указании всех необходимых параметров, пользователя можно перебрасывать сразу на процесс поиска авиабилетов с указанными критериями.
Для использования заполнения формы из URL следует включить опцию: Администрирование → Настройки системы → Включить FastSearch (передачу параметров поиска)
После этого можно использовать ссылки на форму поиска вида
http://SITEMANE/?trip_type=OW&out_iata=MOW&in_iata=BER&departure_date=21.10.2009&adults=1&children=0&input_vendors=SU,PS¶m_by_get=on
Переменные FastSearch
Имена полей - такие же как имена инпутов на поисковой форме.
Следите за тем, чтобы значения соответствовали установленным в настройках ограничениям.
Переменные, которые предполагают в качестве значения "true" можно просто не включать в запрос, чтобы их логика не отработала.
Форма поиска
Чтобы перенаправить пользователя на страницу с заполненными параметрами поиска, необходимо указать get-параметр ¶m_by_get=on, иначе сработают стандартные предустановки полей формы поиска.
Процесс поиска
Если вы указываете все необходимые для поиска параметры, то для того чтобы отправить пользователя сразу на результаты поиска, нужно указать get-параметр &fast_search=on.
Маршрут «В одну сторону» и «Туда и обратно»
| Элемент | Переменная | Допустимые значения | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Тип маршрута | trip_type |
| ||||||||||
| Пункт вылета | out_iata |
| ||||||||||
| Пункт прилета | in_iata |
| ||||||||||
| Дата вылета | departure_date |
| ||||||||||
| Дата обратного вылета | back_departure_date |
| ||||||||||
| Время вылета | prefered_departure_type |
| ||||||||||
| Время обратного вылета | prefered_back_departure_type |
| ||||||||||
| Поиск только среди прямых рейсов ("Без пересадок") | direct | true |
Дополнительные параметры
| Элемент | Переменная | Допустимые значения | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Нижнее ограничение по цене по умолчанию | money_from |
| ||||||||
| Верхнее ограничение по цене по умолчанию | money_to |
| ||||||||
| Поиск в окружных датах | district_date | true | ||||||||
| Диапазон соседних дат +(-) [дней] | date_range |
| ||||||||
| Поиск по соседним аэропортам | district_airport | true | ||||||||
| Класс обслуживания | class |
| ||||||||
| Фильтр по авиакомпании | input_vendors |
| ||||||||
| Сортировка | sort |
|
Сложный маршрут
! Данные переменные применимы только для сложного маршрута (trip_type=CR).
[X] - номера отдельных перелетов. Нумерация начинается с 0, что означает первый перелет.
Максимальное количество сегментов для сложного маршрута определяется одноименной настройкой в разделе Авиабилеты ⇨ Поиск ⇨ Ограничения поиска.
| Элемент | Переменная | Допустимые значения | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Пункты вылета | cr_iata[0] cr_iata[1] |
MOW | Код аэропорта ИАТА | ||||||||||
| Пункты прилета | cr_back_iata[0] cr_back_iata[1] |
LED | Код аэропорта ИАТА | ||||||||||
| Дата вылета | cr_date[0] cr_date[1] |
25.10.2013 | Дата в формате ДД.ММ.ГГГГ | ||||||||||
| Время вылета | cr_pref_departure[0] cr_pref_departure[1] |
| |||||||||||
| Класс обслуживания | cr_class[0] cr_class[1] |
| |||||||||||
| Окружные аэропорты (±XX км) | cr_district_airport[0] cr_district_airport[1] |
true | |||||||||||
Пассажиры
| Элемент | Переменная | Допустимые значения | ||
|---|---|---|---|---|
| Взрослых от 12 лет | adults |
| ||
| Детей от 2 до 12 лет | children |
| ||
| Младенцев до 2 лет | infants |
| ||
| Младенцев с местом до 2 лет | infants_seat |
| ||
| Молодых от 12 до 24 лет |
youths |
| ||
| Пожилых от 65 лет | seniors |
|
Примеры FastSearch запросов
В одну сторону (простой)
Рейс в одну сторону из Москвы в Париж, дата вылета: 25.10.2013, без пересадок, 1 взрослый
- форма поиска
http://SITEMANE/?trip_type=OW&out_iata=MOW&in_iata=PAR&departure_date=25.10.2013 &direct=true&adults=2¶m_by_get=on
- процесс поиска
http://SITEMANE/?trip_type=OW&out_iata=MOW&in_iata=PAR&departure_date=25.10.2013 &direct=true&adults=2¶m_by_get=on&fast_search=on
В одну сторону (с фильтрами по авиакомпаниям)
Рейс в одну сторону из Москвы в Париж, дата вылета 25.10.2013, Пассажиры: пожилых - 2, Авиакомпании: Аэрофлот - Российские авиалинии, Международные Авиалинии Украины
- форма поиска
http://SITEMANE/?trip_type=OW&out_iata=MOW&in_iata=PAR&departure_date=25.10.2013 &seniors=2&input_vendors=SU,PS¶m_by_get=on
- процесс поиска
http://SITEMANE/?trip_type=OW&out_iata=MOW&in_iata=PAR&departure_date=25.10.2013 &seniors=2&input_vendors=SU,PS¶m_by_get=on&fast_search=on
Туда-обратно
Рейсы туда-обратно Москва ↔ Париж, дата вылета: 25.10.2013, обратно: 27.10.2013, класс перелета: Эконом, Пассажиры: взрослых - 2 младенцев - 1
- форма поиска
http://SITEMANE/?trip_type=RT&out_iata=MOW&in_iata=PAR&departure_date=25.10.2013 &back_departure_date=27.10.2013&class=econom&adults=2&infants=1¶m_by_get=on
- процесс поиска
http://SITEMANE/?trip_type=RT&out_iata=MOW&in_iata=PAR&departure_date=25.10.2013 &back_departure_date=27.10.2013&class=econom&adults=2&infants=1¶m_by_get=on&fast_search=on
Сложный маршрут
из Москвы в Париж, дата вылета 25.10.2013,
из Парижа в Санкт-Петербург, дата вылета 26.10.2013,
из Санкт-Петербурга в Москву, дата вылета 29.10.2013,
1 взрослый
- форма поиска
http://SITEMANE/?trip_type=CR &cr_iata[0]=MOW&cr_back_iata[0]=PAR&cr_date[0]=25.10.2013 &cr_iata[1]=PAR&cr_back_iata[1]=LED&cr_date[1]=26.10.2013 &cr_iata[2]=LED&cr_back_iata[2]=MOW&cr_date[2]=29.10.2013 &adults=1¶m_by_get=on
- процесс поиска
http://SITEMANE/?trip_type=CR &cr_iata[0]=MOW&cr_back_iata[0]=PAR&cr_date[0]=25.10.2013 &cr_iata[1]=PAR&cr_back_iata[1]=LED&cr_date[1]=26.10.2013 &cr_iata[2]=LED&cr_back_iata[2]=MOW&cr_date[2]=29.10.2013 &adults=1¶m_by_get=on&fast_search=on
Взаимодействие FastSearch и Метрики
Для того, чтобы переход был зарегистрирован системой как переход с определенного источника, необходимо передать в запросе дополнительный параметр utm_source (Metrics Session ID). Например:
http://SITEMANE/?(some_parameters=vals&)utm_source=source_alias
где source_alias - алиас источника переходов. Дополнительная информация по использованию модуля Метрики.
Пример FastSearch запроса с параметром для модуля Метрики
FastSearch (с учетом источника перехода для модуля Метрики)
Рейс в одну сторону из Москвы в Париж, дата вылета: 25.10.2013, без пересадок, 1 взрослый (с учетом источника перехода для модуля Метрики).
- форма поиска
http://SITEMANE/?trip_type=OW&out_iata=MOW&in_iata=PAR&departure_date=25.10.2013 &direct=true&adults=2¶m_by_get=on&utm_source=source_alias
- процесс поиска
http://SITEMANE/?trip_type=OW&out_iata=MOW&in_iata=PAR&departure_date=25.10.2013 &direct=true&adults=2¶m_by_get=on&fast_search=on&utm_source=source_alias
Проверка в сторонней системе возможности тикетинга
При выписки билета через стороннюю систему 1С, отправляется запрос "GetDebtCounterparty", который спрашивает, можно ли с счета в 1С списать средства для оплаты. В ответе содержится заключение от 1С, в случае если ошибок нет, в ответе будет
<m:Opportunity>Да</m:Opportunity>
Пример запроса "GetDebtCounterparty"
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Body>
<ns1:GetDebtCounterparty>
<ns1:ExternalUserId>00000001</ns1:ExternalUserId>
<ns1:ExternalPaymentId>00000001</ns1:ExternalPaymentId>
<ns1:BaseFare>2490</ns1:BaseFare>
<ns1:Tax>643</ns1:Tax>
<ns1:ValVendorCommission>49.8</ns1:ValVendorCommission>
<ns1:Locator>0X97T6</ns1:Locator>
<ns1:Discount>0</ns1:Discount>
<ns1:Charge>0</ns1:Charge>
<ns1:Sum>3133</ns1:Sum>
<ns1:TotalPrice>3658.1</ns1:TotalPrice>
<ns1:GDSCurrency>RUB</ns1:GDSCurrency>
<ns1:OrderCurrency>RUB</ns1:OrderCurrency>
<ns1:OrderCurrencyRate>1</ns1:OrderCurrencyRate>
<ns1:beginDate>2014-08-30T11:05:00</ns1:beginDate>
</ns1:GetDebtCounterparty>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Пример ответа "GetDebtCounterparty"
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<m:GetDebtCounterpartyResponse xmlns:m="http://DOMEN_NAME/avia">
<m:return xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="m:AnswerDebt">
<m:Opportunity>Да</m:Opportunity>
<m:Message1/>
</m:return>
</m:GetDebtCounterpartyResponse>
</soap:Body>
</soap:Envelope>
Загрузка счетов из сторонней системы
При взаимодействии с веб-сервисом 1С, на этапе бронирования отправляется запрос, на создание аккаунта 1С, содержащий в себе данные счета. В системе логирования этот запрос можно найти под именем «[GDS] Запрос "NewAccount"» и ответ «[GDS] Ответ "NewAccount"»
Пример запроса
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://DOMEN_NAME" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Body>
<ns1:NewAccount>
<ns1:Input>
<ns1:CompanyID>0001</ns1:CompanyID>
<ns1:ID>123321</ns1:ID>
<ns1:ExternalUserId>00123321</ns1:ExternalUserId>
<ns1:Locator>11KW22</ns1:Locator>
<ns1:ExternalPaymentId>0</ns1:ExternalPaymentId>
<ns1:Tickets>
<ns1:IATAValidator>92222616</ns1:IATAValidator>
<ns1:ValVendor>UT</ns1:ValVendor>
<ns1:GDSCurrency>RUB</ns1:GDSCurrency>
<ns1:OrderCurrency>RUB</ns1:OrderCurrency>
<ns1:OrderCurrencyRate>1</ns1:OrderCurrencyRate>
<ns1:BaseFare>8990</ns1:BaseFare>
<ns1:Tax>
<ns1:Code>YQ</ns1:Code>
<ns1:Amount>975</ns1:Amount>
</ns1:Tax>
<ns1:Tax>
<ns1:Code>YR</ns1:Code>
<ns1:Amount>75</ns1:Amount>
</ns1:Tax>
<ns1:Segment>
<ns1:StartDate>2015-02-17T20:20:00</ns1:StartDate>
<ns1:StartAirportCode>VKO</ns1:StartAirportCode>
<ns1:EndAirportCode>SGC</ns1:EndAirportCode>
<ns1:CompanyCode>UT</ns1:CompanyCode>
<ns1:Tariffs>OSSOW</ns1:Tariffs>
<ns1:FlightNumber>295</ns1:FlightNumber>
<ns1:StopOver>O</ns1:StopOver>
<ns1:ClassTypeCode>O</ns1:ClassTypeCode>
</ns1:Segment>
<ns1:FullName>PASSANGER NAME</ns1:FullName>
</ns1:Tickets>
<ns1:Options>
<ns1:Name>Service</ns1:Name>
<ns1:StringValue>GALILEO</ns1:StringValue>
<ns1:NumericValue xsi:nil="true"/>
<ns1:DateValue xsi:nil="true"/>
</ns1:Options>
<ns1:Options>
<ns1:Name>AAA</ns1:Name>
<ns1:StringValue>000A</ns1:StringValue>
<ns1:NumericValue xsi:nil="true"/>
<ns1:DateValue xsi:nil="true"/>
</ns1:Options>
<ns1:Options>
<ns1:Name>Checkbox</ns1:Name>
<ns1:StringValue>YES</ns1:StringValue>
<ns1:NumericValue xsi:nil="true"/>
<ns1:DateValue xsi:nil="true"/>
</ns1:Options>
</ns1:Input>
</ns1:NewAccount>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Пример ответа
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<m:NewAccountResponse xmlns:m="http://DOMEN_NAME">
<m:return xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="m:outInvoice">
<m:NoDoc>00015365</m:NoDoc>
<m:DateInvoice>2015-02-04T00:00:00</m:DateInvoice>
<m:ExternalUserId>00017483</m:ExternalUserId>
<m:TicketsSum>
<m:Price>10040</m:Price>
<m:Discount>0</m:Discount>
<m:Charge>0</m:Charge>
<m:Sum>10040</m:Sum>
</m:TicketsSum>
</m:return>
</m:NewAccountResponse>
</soap:Body>
</soap:Envelope>
