Веб-служба выписки: различия между версиями
Перейти к навигации
Перейти к поиску
(→Ответ) |
(→Ответ) |
||
| Строка 193: | Строка 193: | ||
<ETicket>?</ETicket> | <ETicket>?</ETicket> | ||
<!--ETicket — признак электронного билета, значения: true / false--> | <!--ETicket — признак электронного билета, значения: true / false--> | ||
| + | <isCharter>?</isCharter> | ||
| + | <!--isCharter — признак чартерного перелета, значения: true / false--> | ||
</Segment> | </Segment> | ||
</Segments> | </Segments> | ||
Версия 12:05, 1 августа 2016
Содержание
Информация
Агентский АПИ выписки позволяет определить валидирующего перевозчика и значение комиссии от авиакомпании для брони, а также запустить процедуру выписки билета.
Как правило для выписки билета достаточно чтобы у заказа был статус «Оплачено». При включенной опции Для успешных бронирований производить оформление: автоматически после изменения статуса на «Оплачено» из раздела «Для техподдержки» → «Устаревшие настройки» → «Настройки бронирования» билет будет автоматически выписан после оплаты. Однако, это является обязательным условием только для пользователей, имеется возможность получения выписки билета, не требующей оплаты, для этого необходимо чтобы у АПИ пользователя были соответствующие права. К примеру, АПИ учётка должна быть заведена на менеджера агентства.
Дополнительно была реализована настройка Допустимые IP адреса в разделе «Администрирование» → «Веб-сервисы», определяющая диапазон IP-адресов для дополнительной защиты учётных записей, под которыми происходит выписка билета. IP-адреса имеют следующий допустимый формат: 125.125.25.5/8, то есть возможно задавать с маской подсети.
В Nemo 2.0 в агентский сервис (интерфейс к серверу бронирования) добавлены дополнительные настройки для выписки авиабилетов. В новой версии АПИ позволяет:
- сообщать ВП (валидирующего перевозчика) по данной комбинации
- сообщать комиссию по данной комбинации;
- сообщать эндорсменты по данной комбинации;
- принимать запрос на тикетинг;
- проверять наличие брони в ГРС;
- синхронизировать бронь;
- выписывать билет;
- передавать дополнительную информацию в ремарках;
- войдировать билет.
Общий формат запроса / ответа выписки
Данный запрос запускается после оплаты заказа, может быть запущен как в ручном режиме — пользователем, у которого есть на это права, так и автоматически. Выписать неоплаченный заказ через Nemo.Travel возможности нет. При запуске запроса на выписку также запускается процесс обновления заказа, в ходе которого сверяется цена и остальные параметры заказа, а также проверяется его актуальность. Заказы, с истекшим таймлимитом выписать нельзя.
WSDL: http://CLIENT_DOMAIN/nemoflights/wsdl.php?for=Ticketing
Запрос
1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ver="http://CLIENT_DOMAIN/nemoflights/?version%3D1.0%26for%3DTicketing">
2 <soapenv:Header/>
3 <soapenv:Body>
4 <ver:Ticketing>
5 <RequestBin>
6 <Request>
7 <Ticketing>
8 <BookID>?</BookID>
9 <!--BookID — Id заказа в системе nemo.travel-->
10 <ValCompany>?</ValCompany>
11 <!--ValCompany — валидирующий перевозчик (тот кто выписывает билет)-->
12 <Comission Amount="?" Percent="?" CurrencyCode="?"/>
13 <!--Comission Amount — комиссии, указываются или в валюте, или в процентах, для валюты обязательным является
14 код валюты. Если указана и в валюте и в процентах, то у поставщика комиссия устанавливается в валюте-->
15 <!--Amount — комиссия в валюте-->
16 <!--Percent — комиссия в процентах-->
17 <!--CurrencyCode — код валюты комиссии-->
18 <PassengerFops>
19 <!--Zero or more repetitions:-->
20 <PassengerFop>
21 <PassengerId>?</PassengerId>
22 <!--PassengerId — порядковый номер пассажира в перелете-->
23 <Fops>
24 <!--Zero or more repetitions:-->
25 <Fop>
26 <Type>?</Type>
27 <!--Type — форма оплаты: CC (по кредитной карте) или СА (наличными)-->
28 <Money Currency="?">?</Money>
29 <!--Money — сумма платежа-->
30 <!--Currency — код валюты-->
31 <VendorCode>?</VendorCode>
32 <!--VendorCode — код типа карты: (например, VI — Visa,
33 MC — MasterCard,
34 AX — American Express
35 DC — DCL,
36 CA — EURO,
37 IK — EURO,
38 JB — JCB,
39 JC — JCB,
40 BA — Visa)-->
41 <Number>?</Number>
42 <!--Number — номер карты-->
43 <ExpireDate>?</ExpireDate>
44 <!--ExpireDate — срок действия карты, например 12.2020-->
45 <ManualApprovalCode>?</ManualApprovalCode>
46 <!--ManualApprovalCode - Код преавторизации транзакции, по которой были заблокированы средства для выписки. Это НЕ CVV код. Необязательный. Если не указан, то он будет автоматически получен нашей системой через ГРС/-->
47 </Fop>
48 </Fops>
49 </PassengerFop>
50 </PassengerFops>
51 <DataItems>
52 <!--Zero or more repetitions:-->
53 <DataItem>
54 <Type>Remark</Type>
55 <!--Type — тип контента в данном блоке, например: Meal, Remark-->
56 <Remark>
57 <Type>?</Type>
58 <!--Type — тип ремарки, например: General, Historical-->
59 <Text>?</Text>
60 <!--Text — содержание ремарки-->
61 </Remark>
62 </DataItem>
63 </DataItems>
64 </Ticketing>
65 </Request>
66 <Source>
67 <ClientId>?</ClientId>
68 <!--ClientId — ID клиента в системе nemo.travel. Можно посмотреть/добавить в разделе
69 «Настройки системы» → «Интеграция» → «Nemo 1.0 (SOAP API)».-->
70 <APIKey>?</APIKey>
71 <!--APIKey — секретный ключ доступа к API nemo.travel. Можно посмотреть/добавить в разделе
72 «Настройки системы» → «Интеграция» → «Nemo 1.0 (SOAP API)».-->
73 <Language>?</Language>
74 <!--Language — язык, например: RU-->
75 <Currency>?</Currency>
76 <!-- Currency — валюта, например: RUB, EUR-->
77 </Source>
78 </RequestBin>
79 </ver:Ticketing>
80 </soapenv:Body>
81 </soapenv:Envelope>
Ответ
1 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://CLIENT_DOMAIN/nemoflights/?version%3D1.0%26for%3DTicketing" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
2 <SOAP-ENV:Body>
3 <ns1:TicketingResponse>
4 <ResponseBin>
5 <Response>
6 <Ticketing ID="?" Status="?" Code="?">
7 <!--ID — Id брони в системе nemo.travel, целое число, обязательный-->
8 <!--Status — индикатор состояния брони, возможные значения:
9 booked — забронировано,
10 canceled — бронь отменена,
11 ticket — выписана
12 UNDEFINED — статус не определён-->
13 <!--Code — код брони в системе поставщика-->
14 <QueryPlace xsi:nil="true"/>
15 <!--QueryPlace — положение брони в очереди, Number — номер брони в очереди-->
16 <Flight FlightId="?">
17 <!--FlightId — Id перелёта в системе nemo.travel-->
18 <WebService>?</WebService>
19 <!--WebService — поставщик перелёта-->
20 <ValCompany>?</ValCompany>
21 <!--ValCompany — код авиакомпании, являющейся валидирующим перевозчиком, IATA-->
22 <URL>?</URL>
23 <!--URL — ссылка на бронирование конкретного перелета-->
24 <Segments>
25 <Segment SegNum="?" SegGroupNum="?">
26 <!--SegNum — номер сегмента в перелёте-->
27 <!--SegGroupNum – номер плеча перелёта-->
28 <SupplierCode>?</SupplierCode>
29 <!--SupplierCode – номер заказа в системе АК-->
30 <DepAirp CodeType="IATA">?</DepAirp>
31 <!--DepAirp — аэропорт отправления, например: MOW — любой аэропорт в г.Москва
32 или SVO — Шереметьево-->
33 <DepTerminal>?</DepTerminal>
34 <!--DepTerminal — терминал пункта отправления, если пустое значение,
35 то в аэропорту всего 1 терминал-->
36 <ArrAirp CodeType="IATA">?</ArrAirp>
37 <!--ArrAirp — аэропорт прибытия-->
38 <ArrTerminal>?</ArrTerminal>
39 <!--ArrTerminal — терминал пункта прибытия, если пустое значение,
40 то в аэропорту всего 1 терминал-->
41 <OpAirline>?</OpAirline>
42 <!--OpAirline — авиакомпания перевозчик, например: SU — Аэрофлот-->
43 <MarkAirline>?</MarkAirline>
44 <!--MarkAirline — авиакомпания, продающая перелёт-->
45 <MarkAirlineName>?</MarkAirlineName>
46 <!--MarkAirlineName - полное наименование АК на кириллице-->
47 <FlightNumber>?</FlightNumber>
48 <!--FlightNumber — номер рейса-->
49 <AircraftName>?</AircraftName>
50 <!--AircraftName — наименование воздушного судна-->
51 <AircraftType>?</AircraftType>
52 <!--AircraftType — тип воздушного судна, код-->
53 <DepDateTime>?</DepDateTime>
54 <!--DepDateTime — дата и время отправления, формат ГГГГ-MM-ДДTЧЧ:ММ:СС-->
55 <ArrDateTime>?</ArrDateTime>
56 <!--ArrDateTime — дата и время прибытия, формат ГГГГ-MM-ДДTЧЧ:ММ:СС-->
57 <StopNum>?</StopNum>
58 <!--StopNum — количество остановок-->
59 <BookingCodes>
60 <BookingCode ClassType="?">
61 <!--ClassType — класс перелета, например: economy-->
62 <BookingCode>?</BookingCode>
63 <!--BookingCode — код класса бронирования, у разных авиакомпаний один и тот же класс
64 может записываться разными литерами, например: L-->
65 </BookingCode>
66 </BookingCodes>
67 <FlightTime>?</FlightTime>
68 <!--FlightTime — время перелёта в минутах-->
69 <TimeZone Departure="?" Arrival="?"/>
70 <!--Departure временная зона аэропорта отправления-->
71 <!--Arrival — временная зона аэропорта прибытия-->
72 <ETicket>?</ETicket>
73 <!--ETicket — признак электронного билета, значения: true / false-->
74 <isCharter>?</isCharter>
75 <!--isCharter — признак чартерного перелета, значения: true / false-->
76 </Segment>
77 </Segments>
78 <PricingInfo Refundable="?">
79 <!--Refundable — возвратный/невозвратный, true/false. Если пустое, то не известно-->
80 <PassengerFare Type="?" Quantity="?">
81 <!--Type — тип пассажира, возможные значения: ADT — взрослые, CNN — дети,
82 INF — младенцы, INS — младенцы с местом-->
83 <!--Quantity — количество пассажиров данного типа-->
84 <BaseFare Currency="?" Amount="?"/>
85 <!--BaseFare — базовая стоимость, в базовой валюте. Currency — код валюты, Amount — значение цены-->
86 <EquiveFare Currency="?" Amount="?"/>
87 <!--EquiveFare — базовая стоимость, в эквивалентной валюте(валюте продажи).
88 Currency — код валюты, Amount — значение цены-->
89 <TotalFare Currency="?" Amount="?"/>
90 <!--TotalFare — суммарная стоимость, в эквивалентной валюте.
91 Currency — код валюты, Amount — значение цены-->
92 <Taxes>
93 <Tax CurCode="?" TaxCode="?" Amount="?"/>
94 <!--CurCode — код валюты, TaxCode — код таксы, Amount — сумма таксы-->
95 </Taxes>
96 <Tariffs>
97 <Tariff Code="?" SegNum="?"/>
98 <!--Code — код тарифа, SegNum — номер сегмента, к которому применён тариф-->
99 </Tariffs>
100 <FareCalc>?</FareCalc>
101 <!--FareCalc — строка расчёта цены-->
102 <LastTicketDateTime>?</LastTicketDateTime>
103 <!--LastTicketDateTime — дата и время таймлимита по выписке в формате ГГГГ-MM-ДДTЧЧ:ММ:СС-->
104 </PassengerFare>
105 </PricingInfo>
106 <Commission Currency="?">?</Commission>
107 <Charges Currency="?">?</Charges>
108 <!--Charges — сборы, Currency — код валюты-->
109 <TotalPrice Currency="?">?</TotalPrice>
110 <!--TotalPrice — итоговая цена, Currency — код валюты-->
111 </Flight>
112 <Agency Name="?">
113 <!--Name — название агентства-->
114 <Telephone Type="?">
115 <!--Type — тип номера, обязательный, возможные значения:
116 M — мобильный, H — домашний, B — рабочий, A — агенство-->
117 <!--Optional:-->
118 <PhoneNumber>?</PhoneNumber>
119 <!--PhoneNumber — номер телефона-->
120 <!--Optional:-->
121 <CountryAccessCode>?</CountryAccessCode>
122 <!--CountryAccessCode — код страны-->
123 <!--Optional:-->
124 <AreaCityCode>?</AreaCityCode>
125 <!--AreaCityCode — код региона/города-->
126 </Telephone>
127 <Address City="?" State="?" StreetAddress="?" PostalCode="?" CountryCode="?"/>
128 <!--City — город-->
129 <!--State — штат-->
130 <!--StreetAddress — адрес в городе (улица, дом, корпус, офис и т.д.)-->
131 <!--PostalCode — почтовый индекс-->
132 <!--CountryCode — код страны (RU, UA и т.п.)-->
133 </Agency>
134 <ItinReceipts Encoding="?" Format="?">
135 <!--ItinReceipts — маршрут квитанция, Encoding — кодировка, Format — формат-->
136 <FareStored xsi:nil="true"/>
137 <PaymentTransactions>
138 <Transaction>
139 <Id>?</Id>
140 <!--Id — номер транзакции в Немо-->
141 <Status>?</Status>
142 <!--Status — статус транзакции-->
143 <GatewayName>?</GatewayName>
144 <!--GatewayName — название платежного шлюза-->
145 <MoneyPaid Currency="?">?</MoneyPaid>
146 <!--MoneyPaid — сумма оплаты-->
147 <!--Currency — валюта-->
148 <PaymentDateTime>?</PaymentDateTime>
149 <!--PaymentDateTime — дата и время оплаты-->
150 <CreateDateTime>?</CreateDateTime>
151 <!--CreateDateTime — дата и время создания платежной транзакции-->
152 <Description/>
153 </Transaction>
154 </PaymentTransactions>
155 <PaymentStatus>?</PaymentStatus>
156 <!--PaymentStatus — статус оплаты:
157 not_paid — не оплачено
158 partly_paid — оплачено, частично
159 fully_paid — оплачено, полностью-->
160 <Travellers>
161 <!--Zero or more repetitions:-->
162 <Traveller Type="?" IsContact="?" LinkedTo="?" Num="?" TravellerId="?">
163 <!--Type — тип пассажира, обязательный, возможные значения: ADT — взрослые,
164 CNN — дети, UNN — дети без сопровождения взрослых, INF — младенцы, INS — младенцы с местом-->
165 <!--IsContact — если true — то данный пассажир является контактным лицом, если false — то не является,
166 контактное лицо может быть только 1, если среди пассажиров есть взрослые, то только кто-то из них
167 может быть контактным лицом, по умолчанию false-->
168 <!--Num — порядковый номер пассажира, начинается с 1-->
169 <!--LinkedTo — номер взрослого, к которому привязан младенец/ребёнок (привязка ребёнка ко взрослому является опциональной)-->
170 <!--TravellerId — устаревший параметр, не используется-->
171 <Meal>?</Meal>
172 <!--Meal — код типа питания, возможные значения:
173 NONE — отсутствует
174 AVML — Азиатская вегетарианская кухня
175 BLML — Блюда щадящей диеты
176 CHML — Детское питание
177 CHPC — Детский холодный завтрак
178 СНСС — Детский горячий завтрак
179 CHHC — Детский ланч, ветчина и сыр
180 PBJS — Детский ланч, ореховое масло
181 CHMC — Детский обед макароны с сыром
182 DBML — Диабетическое питание
183 FPML — Фрукты
184 GFML — Питание без клейковины
185 HFML — Питание богатое клетчаткой
186 HNML — Индусская кухня
187 BBML — Питание для младенцев
188 KSML — Кошерная кухня
189 SMKB — Кошерный завтрак
190 SMKL — Кошерный ланч
191 SMKD — Кошерный обед
192 LPML — Малобелковое питание
193 LCML — Низкокалорийное питание
194 LFML — Низкохолестериновое питание
195 PRML — Низкопуриновое питание
196 LSML — Малосоленое питание
197 MOML — Мюсли
198 NLML — Безмолочные продукты
199 ORML — Восточная кухня
200 RVML — Сырые овощи
201 SFML — Морепродукты
202 SPML — Особое питание
203 VLML — Вегетарианское, молоко и яйца
204 VGML — Строго вегетарианское питание
205 VJML — Джайнизское вегетарианское
206 VOML — Восточное вегетарианское питание-->
207 <PersonalInfo DateOfBirth="?" Nationality="?" Gender="?">
208 <!--DateOfBirth — дата рождения в формате ДД.ММ.ГГГГ (например 31.12.2000)-->
209 <!--Nationality — гражданство, двух буквенный код страны (RU, UA, US и т.д.)-->
210 <!--Gender — пол пассажира, возможные значения: M — мужской(Male), F — женский(Female)-->
211 <FirstName>?</FirstName>
212 <!--FirstName — имя пассажира-->
213 <LastName>?</LastName>
214 <!--LastName — фамилия пассажира-->
215 <!--Optional:-->
216 <MiddleName>?</MiddleName>
217 <!--MiddleName — отчество пассажира-->
218 </PersonalInfo>
219 <LoyaltyCard OpCode="?" Number="?"/>
220 <!--OpCode — код авиакомпании-->
221 <!--Number — номер карточки-->
222 <ContactInfo>
223 <!--Optional:-->
224 <EmailID>?</EmailID>
225 <!--EmailID — контактный email-->
226 <!--Optional:-->
227 <Telephone Type="?">
228 <!--Type — тип номера, возможные значения: M — мобильный, H — домашний, B — рабочий-->
229 <!--Optional:-->
230 <PhoneNumber>?</PhoneNumber>
231 <!--PhoneNumber — номер телефона-->
232 <!--Optional:-->
233 <CountryAccessCode>?</CountryAccessCode>
234 <!--CountryAccessCode — код страны-->
235 <!--Optional:-->
236 <AreaCityCode>?</AreaCityCode>
237 <!--AreaCityCode — код региона/города-->
238 </Telephone>
239 </ContactInfo>
240 <DocumentInfo DocType="?" DocNum="?" CountryCode="?" DocElapsedTime="?"/>
241 <!--DocType — тип документа, возможные значения:
242 Р — Паспорт
243 A – Паспорт иностранца
244 С — Внутренний гражданский паспорт
245 F – Документ заменяющий паспорт
246 М — Воинское удостоверение
247 N – Сертификат натурализации(специфичный документ США)
248 T – Док.повторного въезда, паспорт беженца
249 V – Документ для пересечения границы-->
250 <!--DocNum — номер документа-->
251 <!--CountryCode — двух буквенный код страны выдачи паспорта (RU, UA, US и т.д.)-->
252 <!--DocElapsedTime — срок истечения срока действия паспорта в ДД.ММ.ГГГ (например 31.12.2000)-->
253 <Ticket TicketNum="?">
254 <!-- TicketNum — номер выписанного билета-->
255 <VisaInfo Num="?" IssueCountry="?" IssuePlace="?" BirthCountry="?" BirthCity="?" IssueDate="?"/>
256 <!--Num — номер визы-->
257 <!--IssueDate — дата(ДД.ММ.ГГГГ) выдачи визы-->
258 <!--IssueCountry — страна выдачи визы-->
259 <!--IssuePlace — место выдачи визы-->
260 <!--BirthCountry — страна рождения(IATA код страны)-->
261 <!--BirthCity — город рождения(название)-->
262 <ArrAddress City="?" State="?" StreetAddress="?" PostalCode="?" CountryCode="?"/>
263 <!--City — город-->
264 <!--State — штат или область въезда-->
265 <!--StreetAddress — адрес: улица, номер дома, квартиры и т.д.-->
266 <!--PostalCode — почтовый код-->
267 <!--CountryCode — код страны-->
268 <PreferedPlace SmokingAllowed="?" Location="?" RowNumber="?" PlaceNumber="?" SegNumber="?"/>
269 <!--Если указаны номер ряда и номер места, то параметры SmokingAllowed и Location игнорируются-->
270 <!--SmokingAllowed — булевское значение, true — место для курящих, false — место для некурящих-->
271 <!--Location — положение места в ряде, возможные значения:
272 W — у окна (Window)
273 M — где-то в середине ряда (Middle)
274 NPW — возле прохода (NearPassengerWay)
275 NS — нет предпочтения (NotSpecified)-->
276 <!--RowNumber — номер ряда-->
277 <!--PlaceNumber — номер места-->
278 <!--SegNumber — номер сегмента-->
279 <DocStringFormats>
280 <!--Zero or more repetitions:-->
281 <DocStringFormat>?</DocStringFormat>
282 <!--DocStringFormat — формат паспортной строки, возможные значения:
283 DOCS — строка формата DOCS, FOID — строка формата FOID-->
284 </DocStringFormats>
285 </Traveller>
286 </Travellers>
287 </Ticketing>
288 <Requisites/>
289 <RequestType xsi:nil="true"/>
290 <UserID xsi:nil="true"/>
291 <Error Code="?">Сообщение об ошибке</Error>
292 </Response>
293 </ResponseBin>
294 </ns1:TicketingResponse>
295 </SOAP-ENV:Body>
296 </SOAP-ENV:Envelope>
Общий формат запроса / ответа войдирования
Данный запрос запускается после выписки билета, если необходимо его отменить.
WSDL: http://CLIENT_DOMAIN/nemoflights/wsdl.php?for=VoidTicket
Запрос
1 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ver="http://CLIENT_DOMAIN/nemoflights/?version%3D1.0%26for%3DVoidTicket">
2 <soapenv:Header/>
3 <soapenv:Body>
4 <ver:VoidTicket>
5 <RequestBin>
6 <Request>
7 <VoidTicket>
8 <BookID>?</BookID>
9 <!--BookID — Id брони в системе nemo.travel, целое число-->
10 </VoidTicket>
11 </Request>
12 <Source>
13 <ClientId>?</ClientId>
14 <!--ClientId — ID клиента в системе nemo.travel. Можно посмотреть/добавить в разделе
15 «Настройки системы» → «Интеграция» → «Nemo 1.0 (SOAP API)».-->
16 <APIKey>?</APIKey>
17 <!--APIKey — секретный ключ доступа к API nemo.travel. Можно посмотреть/добавить в разделе
18 «Настройки системы» → «Интеграция» → «Nemo 1.0 (SOAP API)».-->
19 <Language>?</Language>
20 <!--Language — язык, например: RU-->
21 <Currency>?</Currency>
22 <!-- Currency — валюта, например: RUB, EUR-->
23 </Source>
24 </RequestBin>
25 </ver:VoidTicket>
26 </soapenv:Body>
27 </soapenv:Envelope>
Ответ
1 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://CLIENT_DOMAIN/nemoflights/?version%3D1.0%26for%3DVoidTicket" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
2 <SOAP-ENV:Body>
3 <ns1:VoidTicketResponse>
4 <ResponseBin>
5 <Response>
6 <VoidTicket BookID="?">
7 <!--BookID — Id брони в системе nemo.travel, целое число-->
8 <Result Success="?"/>
9 <!--Sucscess — результат отмены выписки, true или false-->
10 </VoidTicket>
11 <Requisites/>
12 <RequestType xsi:nil="true"/>
13 <UserID xsi:nil="true"/>
14 <Error Code="?">Сообщение об ошибке</Error>
15 </Response>
16 </ResponseBin>
17 </ns1:VoidTicketResponse>
18 </SOAP-ENV:Body>
19 </SOAP-ENV:Envelope>
