Изменения

Перейти к навигации Перейти к поиску

Frontend API

4070 байт добавлено, 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.sendPasswordLinkResponse|order.auth.sendPasswordLinkResponse]] (Информация о результате операции)
* Request
** URI /api/order/auth/registration
** POST request="[[#order.auth.registration|order.auth.registration]]" (Параметры запроса регистрации)
* Response:
** [[#order.auth.registrationResponse|order.auth.registrationResponse]] (Информация о результате регистрации)
* Request
** URI /api/order/auth/status
** POST request="[[#order.auth.status|order.auth.status]]" (Параметры запроса проверки состояния заказа)
* Response:
** [[#order.auth.statusResponse|order.auth.statusResponse]] (Информация о состоянии заказа)
== Заказы (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>
{
"successlogin": true"test", "password": "test"
}
</pre>
!Значения
|-
|successlogin|Результат авторизацииЛогин пользователя|Booleanstring|Логический типстрока|-|password|Пароль пользователя|string|строка
|-
|}
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">
==== Восстановление пароляДанные результата аутентификации(sendPasswordLinkresponse) ====<pre id="order.auth.sendPasswordLinkResponseresponse">order.auth.sendPasswordLinkResponse response = </pre>
<div class="mw-collapsible-content">
<pre>
{
"success": true, "message": "Письмо со ссылкой на восстановление пароля отправлено вам на почту"
}
</pre>
|-
|success
|Результат авторизацииаутентификации
|Boolean
|Логический тип
|-
|message
|Сообщение
|string
|строка
|-
|}
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">
==== Регистрация пользователяДанные запроса восстановления пароля(registrationsendPasswordLink) ====<pre id="order.auth.registrationResponsesendPasswordLink">order.auth.registrationResponse sendPasswordLink = </pre>
<div class="mw-collapsible-content">
<pre>
{
"successlogin": true, "messagetest": "Письмо с регистрационными данными отправлено на Ваш электронный адрес. Для подтверждения регистрации перейдите, пожалуйста, по ссылке в письме.", "redirectUrl": null
}
</pre>
!Значения
|-
|successlogin|Результат регистрации|Boolean|Логический тип|-|message|Сообщение|string|строка|-|redirectUrl|Ссылка для переходаЛогин пользователя
|string
|строка
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px; margin-bottom:10px;">
==== Информация о параметрах капчиРезультат запроса восстановления пароля(captchaParamssendPasswordLinkResponse) ====<pre id="order.auth.captchaParamsResponsesendPasswordLinkResponse">order.auth.captchaParamsResponse sendPasswordLinkResponse = </pre>
<div class="mw-collapsible-content">
<pre>
{
"imagesuccess": true, "message"data:image/jpeg;base64,JBJ435346...."Письмо со ссылкой на восстановление пароля отправлено вам на почту"
}
</pre>
!Значения
|-
|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 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">

Навигация

'