224
правки
Изменения
Нет описания правки
* 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) ==
=== Авторизация Аутентификация (auth) ===
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">
==== Авторизация Данные запроса аутентификации(ordersrequest) ====<pre id="order.auth.responserequest">order.auth.response request = </pre>
<div class="mw-collapsible-content">
<pre>
</pre>
{| border="1" cellpadding="10" cellspacing="0"
!Значения
|-
|login|Логин пользователя|string|строка|-|password|Пароль пользователя|string|строка|-|}</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": "Письмо со ссылкой на восстановление пароля отправлено вам на почту"
}
</pre>
{| border="1" cellpadding="10" cellspacing="0"
!Параметр
!Описание
!Тип
!Значения
|-
|success
|Результат аутентификации
|Boolean
|Логический тип
|-
|message
|Сообщение
|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": "tst@mute-lab.com",
"registration_password": "tst",
"booking_phone": "89271111111",
"subscribe": true,
"capture": "tst"
}
</pre>
{| border="1" cellpadding="10" cellspacing="0"
!Параметр
!Описание
!Тип
!Значения
|-
|booking_name
|Имя пользователя
|string
|строка
|-
|booking_lastname
|Фамилия пользователя
|string
|строка
|-
|registration_email
|Адрес электронной почты пользователя
|string
|строка
|-
|registration_password
|Пароль
|string
|строка
|-
|booking_phone
|Телефон пользователя
|string
|строка
|-
|subscribe
|Признак согласия на получение информации о лучших предложениях
|Boolean
|Логический тип
|-
|capture
|Код проверки с контрольного изображения
|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": 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:10px;">
==== Данные результата запроса о параметрах капчи(captchaParamsResponse) ====
<pre id="order.auth.captchaParamsResponse">order.auth.captchaParamsResponse = </pre>
<div class="mw-collapsible-content">
<pre>
{
"image": "data:image/jpeg;base64,JBJ435346...."
}
</pre>
{| border="1" cellpadding="10" cellspacing="0"
!Параметр
!Описание
!Тип
!Значения
|-
|image
|Ссылка на изображение
|string
|строка
|-
|}
</div>
</div>
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px; 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 и дефис
|-
|passenger_lastname
|Фамилия одного из пассажиров
|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
|строка
|-
|redirectUrl
|Ссылка для перехода
|string
|строка
|-
|}