Открыть главное меню

Изменения

Frontend API

7297 байт добавлено, 14:14, 27 февраля 2019
Нет описания правки
* Request
** URI /api/hotels/search/request/{searchId?} (получение данных запроса поиска с идентификатором {searchId}или создание нового запроса на поиск)
** POST request="[[#hotels.search.request|hotels.search.request]]" (Параметры запроса поиска)
* Response:
== Модуль Заказов (order) ==
=== Модуль авторизации аутентификации === Внимание, для сохранения статуса авторизованного пользователя запросы должны быть отправлены с поддержкой cookie (Параметр withCredentials = true у объекта XmlHttpRequest в случае использования JS) ==== Запрос аутентификации пользователя====
* Request
** URI /api/order/auth/request
** POST request="[[#order.auth.request|order.auth.request]]" (Параметры запроса аутентификации)
* Response:
** [[#order.auth.response|order.auth.response]] (Результат аутентификации)
** [[#system.info|system.info]] (Служебная информация)
 
==== Запрос восстановления пароля====
 
* Request
** URI /api/order/auth/sendPasswordLink
** POST request="[[#order.auth.sendPasswordLink|order.auth.sendPasswordLink]]" (Параметры запроса восстановления пароля)
* Response:
** [[#order.auth.responsesendPasswordLinkResponse|order.auth.responsesendPasswordLinkResponse]] (Результат авторизацииИнформация о результате операции)** [[#system.info|system.info]] (Служебная информация) ==== Запрос регистрации==== * Request ** URI /api/order/auth/registration** POST request="[[#order.auth.registration|order.auth.registration]]" (Параметры запроса регистрации)* Response: ** [[#order.auth.registrationResponse|order.auth.registrationResponse]] (Информация о результате регистрации)** [[#system.info|system.info]] (Служебная информация) ==== Запрос на получение параметров капчи==== * Request ** URI /api/order/auth/captchaParams* Response: ** [[#order.auth.captchaParamsResponse|order.auth.captchaParamsResponse]] (Информация о параметрах капчи)** [[#system.info|system.info]] (Служебная информация) ==== Запрос проверки состояния заказа==== * Request ** URI /api/order/auth/status** POST request="[[#order.auth.status|order.auth.status]]" (Параметры запроса проверки состояния заказа)* Response: ** [[#order.auth.statusResponse|order.auth.statusResponse]] (Информация о состоянии заказа)
** [[#system.info|system.info]] (Служебная информация)
== Заказы (order) ==
order.auth.response
=== Авторизация Аутентификация (auth) ===
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">
==== Авторизация Данные запроса аутентификации(ordersrequest) ====<pre id="order.reminderauth.ordersrequest">order.auth.response request = </pre>
<div class="mw-collapsible-content">
<pre>
[ { "successlogin": true"test", "password": "test"}]
</pre>
{| border="1" cellpadding="10" cellspacing="0"
!Значения
|-
|successlogin|Результат авторизацииЛогин пользователя|Stringstring|Целое положительное числострока
|-
|typepassword|тип заказаПароль пользователя|Stringstring|Строка строка
|-
|products}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">==== Данные результата аутентификации(response) ====<pre id="order.auth.response">order.auth.response = </pre><div class="mw-collapsible-content"> <pre>{ "success": true}</pre>{| border="1" cellpadding="10" cellspacing="0"!Параметр!Описание!Тип!Значения|Массив продуктов-|[]success|Результат аутентификации|Boolean|Логический тип|-|}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">==== Данные запроса восстановления пароля(sendPasswordLink) ====<pre id="order.auth.sendPasswordLink">order.auth.sendPasswordLink = </pre><div class="mw-collapsible-content"> <pre>{ "login": "test"}</pre>{| border="1" cellpadding="10" cellspacing="0"!Параметр!Описание!Тип!Значения|-|login|Логин пользователя|string|строка|-|}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">==== Результат запроса восстановления пароля(sendPasswordLinkResponse) ====<pre id="order.auth.sendPasswordLinkResponse">order.auth.sendPasswordLinkResponse = </pre><div class="mw-collapsible-content"> <pre>{ "success": true, "message": status"Письмо со ссылкой на восстановление пароля отправлено вам на почту"}</pre>{| border="1" cellpadding="10" cellspacing="0"!Параметр!Описание!Тип!Значения|-|success|Результат аутентификации|Boolean|Логический тип|-|message|Сообщение|string|Статусстрока|String-|Строка}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">==== Данные запроса регистрации пользователя(registration) ====<pre id="order.auth.registration">order.auth.registration = </pre><div class="mw-collapsible-content"> <pre>{ "booking_name": "tst", принимающая одно из следующих значений "booking_lastname":"tst", "registration_email": pending "tst@mute- ожидает бронированияlab.com", "registration_password": booked - забронирован"tst", "booking_phone": "89271111111", ожидает оплаты "subscribe": true, "capture": completed "tst"}</pre>{| border="1" cellpadding="10" cellspacing="0"!Параметр!Описание!Тип!Значения|- оплаченный|booking_name|Имя пользователя|string|строка|-|booking_lastname: type|Фамилия пользователя|string|строка|-|registration_email|Адрес электронной почты пользователя|string|строка|-|registration_password|Пароль|string|строка|-|booking_phone|Телефон пользователя|string|строка|-|subscribe|Признак согласия на получение информации о лучших предложениях|Boolean|Логический тип|-|capture|Код проверки с контрольного изображения|string|Тип продуктастрока|String-|Строка}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">==== Результат запроса регистрации пользователя(registrationResponse) ====<pre id="order.auth.registrationResponse">order.auth.registrationResponse = </pre><div class="mw-collapsible-content"> <pre>{ "success": true, принимающая одно из следующих значений "message":"Письмо с регистрационными данными отправлено на Ваш электронный адрес. Для подтверждения регистрации перейдите, пожалуйста, по ссылке в письме.", "redirectUrl": flight null}</pre>{| border="1" cellpadding="10" cellspacing="0"!Параметр!Описание!Тип!Значения|-|success|Результат регистрации|Boolean|Логический тип|-|message|Сообщение|string|строка|- перелет,|redirectUrl|Ссылка для перехода|string|строка|-|}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom: hotel 10px;">==== Данные результата запроса о параметрах капчи(captchaParamsResponse) ====<pre id="order.auth.captchaParamsResponse">order.auth.captchaParamsResponse = </pre><div class="mw-collapsible- отельcontent"> <pre>{ "image": "data:image/jpeg;base64,JBJ435346....": train }</pre>{| border="1" cellpadding="10" cellspacing="0"!Параметр!Описание!Тип!Значения|- поездка |image|Ссылка на поездеизображение|string|строка|-|}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width: depAirpIATA800px; margin-bottom:10px;">==== Данные запроса о состоянии заказа(status) ====<pre id="order.auth.status">order.auth.status = </pre><div class="mw-collapsible-content"> <pre>{ "booking_id": 445469, "passenger_lastname": "Ivanov", "access_code": "8Z273L"}</pre>{| border="1" cellpadding="10" cellspacing="0"!Параметр!Описание!Тип!Значения|-|booking_id|Идентификатор заказа|string|строка, может содержать цифры от 0 до 9 и дефис|Для перелёта - код аэропорта вылета|Stringpassenger_lastname|Строка Фамилия одного из 2 знаков пассажиров|string|строка|-|access_code|Код доступа к заказу|string|строка|-|}</div></div> <div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">==== Данные результата запроса о состоянии заказа(букв латинского алфавита и цифрstatusResponse)====<pre id="order.auth.statusResponse">order.auth.statusResponse = </pre><div class="mw-collapsible-content"> <pre>{ "success": true, "message": null, "redirectUrl": "http://nemotravel/poffice__bookinfo?booking_id=452434"}</pre>{| border="1" cellpadding="10" cellspacing="0"!Параметр!Описание!Тип!Значения|-|success|Признак успешности получения ответа|Boolean|Логический тип|-|message|Сообщение|string|строка
|-
|: arrAirpIATA|Для перелёта - код аэропорта прилета|String|Строка из 2 знаков (букв латинского алфавита и цифр)|-|: beginDateTime|Дата начала услуги|String|Строка в формате yyyy-MM-ddTHH:mm:ss (ISO 8601)|-|: endDateTime|Дата завершения услуги|String|Строка в формате yyyy-MM-ddTHH:mm:ss (ISO 8601)|-|: totalPrice|Цена услуги|{}|...|-|:: amount|Сумма |number|Дробное число|-|:: currencyredirectUrl|Код валютыСсылка для перехода
|string
|Строка в формате ISO 4217(трёхбуквенный алфавитный код)|-|: description|Описание продукта|string|Строка|-|orderPrice|Цена заказа|{}|Формат аналогичен totalPriceстрока
|-
|}
</div>
</div>
 
 
=== Протокорзина (reminder) ===
'