Схема использования агентского API (workflow): различия между версиями

Материал из Центр поддержки системы бронировании
Перейти к навигации Перейти к поиску
м (→‎Рекомендуемая схема для работы с заказом через API)
 
(не показано 6 промежуточных версий 3 участников)
Строка 3: Строка 3:
 
'''Агентский API [[Авиабилеты_(компонент)|Авиабилеты]]''' интегрирует ваши приложения с модулями системы [http://www.nemo.travel Nemo.Travel] по [[Поиск_(Авиабилеты)|поиску]] перелетов в Глобальных Распределительных Системах ([[ГРС]]), последующему [[Бронирование_(Авиабилеты)|бронированию]], [[Выписка|оформлению электронных билетов]], [[Обмен_и_возврат_авиабилетов|возврату и обмену]] оформленных авиабилетов, [[Синхронизация_заказов|синхронизации бронирований в ГРС]]. Подробнее об API см. [[Агентский интерфейс прикладного программирования (Агентский API)]], [[Агентский API Авиабилеты]].
 
'''Агентский API [[Авиабилеты_(компонент)|Авиабилеты]]''' интегрирует ваши приложения с модулями системы [http://www.nemo.travel Nemo.Travel] по [[Поиск_(Авиабилеты)|поиску]] перелетов в Глобальных Распределительных Системах ([[ГРС]]), последующему [[Бронирование_(Авиабилеты)|бронированию]], [[Выписка|оформлению электронных билетов]], [[Обмен_и_возврат_авиабилетов|возврату и обмену]] оформленных авиабилетов, [[Синхронизация_заказов|синхронизации бронирований в ГРС]]. Подробнее об API см. [[Агентский интерфейс прикладного программирования (Агентский API)]], [[Агентский API Авиабилеты]].
  
−
==Рекомендуемая схема работы API==
+
==Рекомендуемая схема для работы с заказом через API==
 
{{NameSystem}} рекомендует агентам для оформления заказов онлайн в компоненте Авиа строить последовательность АПИ-запросов к системе следующим образом:
 
{{NameSystem}} рекомендует агентам для оформления заказов онлайн в компоненте Авиа строить последовательность АПИ-запросов к системе следующим образом:
  
−
#'''Поиск перелетов'''. Запрос [http://support.nemo.travel/ru/%D0%92%D0%B5%D0%B1-%D1%81%D0%BB%D1%83%D0%B6%D0%B1%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2 SearchFlights].
+
#'''Поиск перелетов''' — Запрос [http://support.nemo.travel/ru/%D0%92%D0%B5%D0%B1-%D1%81%D0%BB%D1%83%D0%B6%D0%B1%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2 SearchFlights].
−
#'''Создание отложенного заказа''' - после получения результатов поиска следует создать отложенный заказ с указаннием нужного номера перелета, так же рекомендуется в запросе на создание отложенного заказа [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.A1.D0.BE.D0.B7.D0.B4.D0.B0.D0.BD.D0.B8.D0.B5_.D0.BE.D1.82.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.BD.D0.BE.D0.B3.D0.BE_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0_.D0.B2_.D1.81.D0.B8.D1.81.D1.82.D0.B5.D0.BC.D0.B5_Nemo EmptyBook] применить дополнительные операции GareFareFamilies (получение перелетов с тарифными семействами) и ActualizeFlight (актуализация перелета в гдс).
+
#'''Получение семейств тарифов''' — выполнить запрос получения семейств тарифов для определенного перелета [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D0.BD.D0.B0_.D0.BF.D0.BE.D0.BB.D1.83.D1.87.D0.B5.D0.BD.D0.B8.D0.B5_.D1.81.D0.B5.D0.BC.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B0_.D1.82.D0.B0.D1.80.D0.B8.D1.84.D0.BE.D0.B2_.D0.B4.D0.BB.D1.8F_.D0.BE.D0.BF.D1.80.D0.B5.D0.B4.D0.B5.D0.BB.D0.B5.D0.BD.D0.BD.D0.BE.D0.B3.D0.BE_.D0.BF.D0.B5.D1.80.D0.B5.D0.BB.D0.B5.D1.82.D0.B0 GetFareFamilies]. Если были найдены семейства тарифов, то для их применения необходимо использовать выбранный FlightId из результатов поиска семейств тарифов.
−
#'''Получение семейств тарифов и актуализация перелета (альтернативный вариант без создания отложенного заказа)''' - в случае использования семейств тарифов необходимо после получения ответа на запрос [http://support.nemo.travel/ru/%D0%92%D0%B5%D0%B1-%D1%81%D0%BB%D1%83%D0%B6%D0%B1%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2 SearchFlights]:
+
#'''Создание отложенного заказа''' — запрос [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.A1.D0.BE.D0.B7.D0.B4.D0.B0.D0.BD.D0.B8.D0.B5_.D0.BE.D1.82.D0.BB.D0.BE.D0.B6.D0.B5.D0.BD.D0.BD.D0.BE.D0.B3.D0.BE_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0_.D0.B2_.D1.81.D0.B8.D1.81.D1.82.D0.B5.D0.BC.D0.B5_Nemo EmptyBook] создаст в системе Nemo заказ, который еще не забронирован в ГРС. В запросе рекомендуется применить дополнительную операцию ActualizeFlight (актуализация перелета в гдс), которая позволит убедиться в доступности перелета для бронирования.
−
## выполнить запрос получения семейств тарифов для определенного перелета [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D0.BD.D0.B0_.D0.BF.D0.BE.D0.BB.D1.83.D1.87.D0.B5.D0.BD.D0.B8.D0.B5_.D1.81.D0.B5.D0.BC.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B0_.D1.82.D0.B0.D1.80.D0.B8.D1.84.D0.BE.D0.B2_.D0.B4.D0.BB.D1.8F_.D0.BE.D0.BF.D1.80.D0.B5.D0.B4.D0.B5.D0.BB.D0.B5.D0.BD.D0.BD.D0.BE.D0.B3.D0.BE_.D0.BF.D0.B5.D1.80.D0.B5.D0.BB.D0.B5.D1.82.D0.B0 GetFareFamilies],  
+
#'''Актуализация перелета без создания отложенного заказа''' — имеется возможность выполнить проверку доступности без создания отложенного заказа в системе Nemo [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.9F.D1.80.D0.BE.D0.B2.D0.B5.D1.80.D0.BA.D0.B0_.D0.BD.D0.B0_.D0.B4.D0.BE.D1.81.D1.82.D1.83.D0.BF.D0.BD.D0.BE.D1.81.D1.82.D1.8C AirAvail].
−
## выбрать нужный перелет среди полученных в ответе на данный запрос.  
 
−
## выполнить запрос [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.9F.D1.80.D0.BE.D0.B2.D0.B5.D1.80.D0.BA.D0.B0_.D0.BD.D0.B0_.D0.B4.D0.BE.D1.81.D1.82.D1.83.D0.BF.D0.BD.D0.BE.D1.81.D1.82.D1.8C AirAvail] с указанием полученного в ответе на запрос [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D0.BD.D0.B0_.D0.BF.D0.BE.D0.BB.D1.83.D1.87.D0.B5.D0.BD.D0.B8.D0.B5_.D1.81.D0.B5.D0.BC.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B0_.D1.82.D0.B0.D1.80.D0.B8.D1.84.D0.BE.D0.B2_.D0.B4.D0.BB.D1.8F_.D0.BE.D0.BF.D1.80.D0.B5.D0.B4.D0.B5.D0.BB.D0.B5.D0.BD.D0.BD.D0.BE.D0.B3.D0.BE_.D0.BF.D0.B5.D1.80.D0.B5.D0.BB.D0.B5.D1.82.D0.B0 GetFareFamilies] ID перелета.
 
 
# '''Бронирование''' — запрос выполняется после ввода данных пассажиров. Запрос [http://support.nemo.travel/ru/%D0%92%D0%B5%D0%B1-%D1%81%D0%BB%D1%83%D0%B6%D0%B1%D0%B0_%D0%B1%D1%80%D0%BE%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F BookFlight]. В случае использования семейств тарифов в запросе бронирования необходимо использовать ID перелета, полученный в ответе на запрос [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D0.BD.D0.B0_.D0.BF.D0.BE.D0.BB.D1.83.D1.87.D0.B5.D0.BD.D0.B8.D0.B5_.D1.81.D0.B5.D0.BC.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B0_.D1.82.D0.B0.D1.80.D0.B8.D1.84.D0.BE.D0.B2_.D0.B4.D0.BB.D1.8F_.D0.BE.D0.BF.D1.80.D0.B5.D0.B4.D0.B5.D0.BB.D0.B5.D0.BD.D0.BD.D0.BE.D0.B3.D0.BE_.D0.BF.D0.B5.D1.80.D0.B5.D0.BB.D0.B5.D1.82.D0.B0 GetFareFamilies].
 
# '''Бронирование''' — запрос выполняется после ввода данных пассажиров. Запрос [http://support.nemo.travel/ru/%D0%92%D0%B5%D0%B1-%D1%81%D0%BB%D1%83%D0%B6%D0%B1%D0%B0_%D0%B1%D1%80%D0%BE%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F BookFlight]. В случае использования семейств тарифов в запросе бронирования необходимо использовать ID перелета, полученный в ответе на запрос [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D0.BD.D0.B0_.D0.BF.D0.BE.D0.BB.D1.83.D1.87.D0.B5.D0.BD.D0.B8.D0.B5_.D1.81.D0.B5.D0.BC.D0.B5.D0.B9.D1.81.D1.82.D0.B2.D0.B0_.D1.82.D0.B0.D1.80.D0.B8.D1.84.D0.BE.D0.B2_.D0.B4.D0.BB.D1.8F_.D0.BE.D0.BF.D1.80.D0.B5.D0.B4.D0.B5.D0.BB.D0.B5.D0.BD.D0.BD.D0.BE.D0.B3.D0.BE_.D0.BF.D0.B5.D1.80.D0.B5.D0.BB.D0.B5.D1.82.D0.B0 GetFareFamilies].
 
# '''Оплата заказа''':
 
# '''Оплата заказа''':
Строка 17: Строка 15:
 
## '''Оплата заказа'''. Запрос [[Агентский API Оплата#Фиксации оплаты через Агентский АПИ|PayOrder]].
 
## '''Оплата заказа'''. Запрос [[Агентский API Оплата#Фиксации оплаты через Агентский АПИ|PayOrder]].
 
# '''Выписка билетов''':
 
# '''Выписка билетов''':
 +
#* В случае, если используется автовыписка заказа после успешной оплаты:
 +
## '''Обновление заказа''' — обновление заказа для получения номеров выписанных билетов. Запрос [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D0.BD.D0.B0_.D0.BE.D0.B1.D0.BD.D0.BE.D0.B2.D0.BB.D0.B5.D0.BD.D0.B8.D0.B5_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0 UpdateBook].
 +
#* В случае, если ''не'' используется  автовыписка заказа после успешной оплаты:
 
## '''Синхронизация заказа с ГРС''' — проверка статуса оплаты и актуализация информации о заказе перед выпиской. Запрос [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D0.BD.D0.B0_.D0.BE.D0.B1.D0.BD.D0.BE.D0.B2.D0.BB.D0.B5.D0.BD.D0.B8.D0.B5_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0 UpdateBook].
 
## '''Синхронизация заказа с ГРС''' — проверка статуса оплаты и актуализация информации о заказе перед выпиской. Запрос [http://support.nemo.travel/ru/%D0%94%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D0%90%D0%9F%D0%98_%D0%B0%D0%B2%D0%B8%D0%B0%D0%B1%D0%B8%D0%BB%D0%B5%D1%82%D0%BE%D0%B2#.D0.97.D0.B0.D0.BF.D1.80.D0.BE.D1.81_.D0.BD.D0.B0_.D0.BE.D0.B1.D0.BD.D0.BE.D0.B2.D0.BB.D0.B5.D0.BD.D0.B8.D0.B5_.D0.B7.D0.B0.D0.BA.D0.B0.D0.B7.D0.B0 UpdateBook].
 
## '''Выписка билетов'''. Запрос [http://support.nemo.travel/ru/%D0%92%D0%B5%D0%B1-%D1%81%D0%BB%D1%83%D0%B6%D0%B1%D0%B0_%D0%B2%D1%8B%D0%BF%D0%B8%D1%81%D0%BA%D0%B8 Ticketing].
 
## '''Выписка билетов'''. Запрос [http://support.nemo.travel/ru/%D0%92%D0%B5%D0%B1-%D1%81%D0%BB%D1%83%D0%B6%D0%B1%D0%B0_%D0%B2%D1%8B%D0%BF%D0%B8%D1%81%D0%BA%D0%B8 Ticketing].

Текущая версия на 18:26, 19 декабря 2018

Агентский API Авиабилеты интегрирует ваши приложения с модулями системы Nemo.Travel по поиску перелетов в Глобальных Распределительных Системах (ГРС), последующему бронированию, оформлению электронных билетов, возврату и обмену оформленных авиабилетов, синхронизации бронирований в ГРС. Подробнее об API см. Агентский интерфейс прикладного программирования (Агентский API), Агентский API Авиабилеты.

Рекомендуемая схема для работы с заказом через API

Nemo.Travel рекомендует агентам для оформления заказов онлайн в компоненте Авиа строить последовательность АПИ-запросов к системе следующим образом:

  1. Поиск перелетов — Запрос SearchFlights.
  2. Получение семейств тарифов — выполнить запрос получения семейств тарифов для определенного перелета GetFareFamilies. Если были найдены семейства тарифов, то для их применения необходимо использовать выбранный FlightId из результатов поиска семейств тарифов.
  3. Создание отложенного заказа — запрос EmptyBook создаст в системе Nemo заказ, который еще не забронирован в ГРС. В запросе рекомендуется применить дополнительную операцию ActualizeFlight (актуализация перелета в гдс), которая позволит убедиться в доступности перелета для бронирования.
  4. Актуализация перелета без создания отложенного заказа — имеется возможность выполнить проверку доступности без создания отложенного заказа в системе Nemo AirAvail.
  5. Бронирование — запрос выполняется после ввода данных пассажиров. Запрос BookFlight. В случае использования семейств тарифов в запросе бронирования необходимо использовать ID перелета, полученный в ответе на запрос GetFareFamilies.
  6. Оплата заказа:
    1. Если пользователь переходит к оплате заказа позднее, чем через 5 минут после бронирования, то прежде чем перенаправить пользователя на страницу оплаты, необходимо выполнить синхронизацию заказа с ГРС для актуализации информации о заказе. Помогает предотвратить возможную оплату недоступного заказа, заказов с аннулированными со стороны авиакомпании сегментами, а так же оплату заказа с изменившейся ценой по старой стоимости. Запрос UpdateBook.
    2. Оплата заказа. Запрос PayOrder.
  7. Выписка билетов:
    • В случае, если используется автовыписка заказа после успешной оплаты:
    1. Обновление заказа — обновление заказа для получения номеров выписанных билетов. Запрос UpdateBook.
    • В случае, если не используется автовыписка заказа после успешной оплаты:
    1. Синхронизация заказа с ГРС — проверка статуса оплаты и актуализация информации о заказе перед выпиской. Запрос UpdateBook.
    2. Выписка билетов. Запрос Ticketing.
  8. При необходимости можно выполнить отмену выписанной брони.
    • Если время на войдирование не истекло (зависит от ГДС), то:
      1. Выполните запрос войдирования VoidTicket.
      2. Выполните запрос аннуляции брони CancelBook.
    • Если время на войдирование истекло, то необходимо выполнить возврат, для этого:
      1. Запросите сумму к возврату на всех пассажиров GetRefundData.
      2. Выполните запрос на возврат RefundTicket.


Рекомендуемая схема работы API
Рекомендуемая схема работы API Авиабилеты

См. также

Источник — https://support.nemo.travel/index.php?title=Схема_использования_агентского_API_(workflow)&oldid=15638