Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
site:api [2020/11/12 10:45] crs [ИЗМЕНЕНИЯ 12 ноября 2020] |
site:api [2022/06/20 08:35] (текущий) crs [Поиск] |
||
|---|---|---|---|
| Строка 8: | Строка 8: | ||
| **Документация состоит из описания бизнес-процессов и технической части** | **Документация состоит из описания бизнес-процессов и технической части** | ||
| + | |||
| + | ===== ИЗМЕНЕНИЯ 24 декабря 2021 ===== | ||
| + | hotel/view объявлен устаревшим. Hotel/index возвращает аналогичные данные и позволяет делать меньшее кол-во запросов при интеграции (используя offset и limit = 1000) | ||
| + | |||
| + | |||
| + | ===== ИЗМЕНЕНИЯ 7 ноября 2021 ===== | ||
| + | Клиенты теперь могут видеть города и гостиницы респ. Беларусь (country id 15) | ||
| + | |||
| + | ===== ИЗМЕНЕНИЯ 18 ноября 2020 ===== | ||
| + | В [[site:api#типы_размещения_в_номере|типы мест размещения]] добавили количество фактических спальных мест для взрослых **sleeping_place** | ||
| + | |||
| ===== ИЗМЕНЕНИЯ 12 ноября 2020 ===== | ===== ИЗМЕНЕНИЯ 12 ноября 2020 ===== | ||
| Строка 267: | Строка 278: | ||
| ===== Просмотр отеля / view ===== | ===== Просмотр отеля / view ===== | ||
| + | |||
| + | **УСТАРЕЛ**! | ||
| + | |||
| + | ''Используйте hotel/index. Он возвращает данных в том же формате, обёрнутые в массив (для получения гостиницы в теле передайте json {"hotels":[86]}'' | ||
| Описание: Просмотр конкретной гостиницы (на тестовом сервере авторизация не требуется) | Описание: Просмотр конкретной гостиницы (на тестовом сервере авторизация не требуется) | ||
| - | Адрес: ''/api/hotel/view?id=86'' | + | Адрес: /api/hotel/view?id=86 |
| - | Метод запрос: ''GET\POST'' | + | Метод запрос: GET\POST |
| - | Данные: ''id - номер гостиницы''. Параметр можно передавать как в URI, так и в теле запроса | + | Данные: id - номер гостиницы. Параметр можно передавать как в URI, так и в теле запроса |
| Возвращаемые данные: Модель гостиницы с номерами и ценами | Возвращаемые данные: Модель гостиницы с номерами и ценами | ||
| Строка 307: | Строка 322: | ||
| "name": "Сибирь",//Название гостиницы | "name": "Сибирь",//Название гостиницы | ||
| "created_at": "1251955948",//Дата создания | "created_at": "1251955948",//Дата создания | ||
| - | "updated_at": "1563381026",//Дата последнего обновления | + | "updated_at": "1563381026",//Дата последнего обновления объекта |
| + | "last_modified": "1563381026", //Дата последнего изменения объекта в целом (самой гостиницы или номеров, правил формирования цен и тд). Именно на этот параметр нужно смотреть, чтобы понимать актуальность данных | ||
| "alias": "Park Inn by Radisson Ижевск, Парк Инн Рэдиссон Ижевск",//Псевдонимы через запятую. В основном нужно для гостиниц с англоязычным названием | "alias": "Park Inn by Radisson Ижевск, Парк Инн Рэдиссон Ижевск",//Псевдонимы через запятую. В основном нужно для гостиниц с англоязычным названием | ||
| "active": "1",//Гостиница актуальная\работает | "active": "1",//Гостиница актуальная\работает | ||
| "geo_lon": "44.5267469",//координаты | "geo_lon": "44.5267469",//координаты | ||
| "geo_lat": "48.7175457", | "geo_lat": "48.7175457", | ||
| - | "child_updated": "1563381026", //актуальное время обновления любой зависимости по гостинице (цен, набора информации, маркапов клиента) | + | "child_updated": "1563381026", //DEPRECATED: тоже самое что last_modified |
| "rooms": [//Набор номеров с ценами | "rooms": [//Набор номеров с ценами | ||
| { | { | ||
| Строка 642: | Строка 658: | ||
| } | } | ||
| ], | ], | ||
| - | "last_modified": "1586234139", | + | "last_modified": "1586234139",//Дата последнего изменения объекта в целом (самой гостиницы или номеров, правил формирования цен и тд). Именно на этот параметр нужно смотреть, чтобы понимать актуальность данных |
| "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | ||
| } | } | ||
| Строка 782: | Строка 798: | ||
| } | } | ||
| ], | ], | ||
| - | "last_modified": "1550419709", | + | "last_modified": "1550419709", //Дата последнего изменения объекта в целом (самой гостиницы или номеров, правил формирования цен и тд). Именно на этот параметр нужно смотреть, чтобы понимать актуальность данных |
| "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | ||
| }, | }, | ||
| Строка 934: | Строка 950: | ||
| } | } | ||
| ], | ], | ||
| - | "last_modified": "1549605151", | + | "last_modified": "1549605151", //Дата последнего изменения объекта в целом (самой гостиницы или номеров, правил формирования цен и тд). Именно на этот параметр нужно смотреть, чтобы понимать актуальность данных |
| "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | ||
| }, | }, | ||
| Строка 1048: | Строка 1064: | ||
| } | } | ||
| ], | ], | ||
| - | "last_modified": "1549610129", | + | "last_modified": "1549610129", //Дата последнего изменения объекта в целом (самой гостиницы или номеров, правил формирования цен и тд). Именно на этот параметр нужно смотреть, чтобы понимать актуальность данных |
| "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | ||
| }, | }, | ||
| Строка 1181: | Строка 1197: | ||
| } | } | ||
| ], | ], | ||
| - | "last_modified": "1550570860", | + | "last_modified": "1550570860",//Дата последнего изменения объекта в целом (самой гостиницы или номеров, правил формирования цен и тд). Именно на этот параметр нужно смотреть, чтобы понимать актуальность данных |
| "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | ||
| }, | }, | ||
| Строка 1238: | Строка 1254: | ||
| } | } | ||
| ], | ], | ||
| - | "last_modified": "1553703900", | + | "last_modified": "1553703900", //Дата последнего изменения объекта в целом (самой гостиницы или номеров, правил формирования цен и тд). Именно на этот параметр нужно смотреть, чтобы понимать актуальность данных |
| "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | "cancellation_rule": "за 48 часов до заезда - без штрафа, Менее 48 часов - на усмотрение гостиницы" | ||
| } | } | ||
| Строка 1985: | Строка 2001: | ||
| ''client- id пользователя клиента (Вас). Если заявка заведена компанией Сусанин, то может отличаться от id вашего пользователя'', | ''client- id пользователя клиента (Вас). Если заявка заведена компанией Сусанин, то может отличаться от id вашего пользователя'', | ||
| + | |||
| + | ''status- массив id статусов заявок'', | ||
| Параметры не обязательные, по умолчанию возвращаются все доступные пользователю заявки. | Параметры не обязательные, по умолчанию возвращаются все доступные пользователю заявки. | ||
| Строка 2059: | Строка 2077: | ||
| "reserve_number": "ФИО",//номер брони | "reserve_number": "ФИО",//номер брони | ||
| "penalty_until": "1565722800",//дата наступления штрафа | "penalty_until": "1565722800",//дата наступления штрафа | ||
| - | "penalty_amount": "100%",//размер штрафа | + | "penalty_amount": "100%",//размер штрафа. Указывается либо в проценте (50%, 100%) , либо сумма (5000,2331,50) |
| "calc_client": "",//расчет клиенту | "calc_client": "",//расчет клиенту | ||
| "price_netto_client": null,//см обновление от 1 мая 2020! Цена за заказ будет указана в счёте (output_docs-> bills) | "price_netto_client": null,//см обновление от 1 мая 2020! Цена за заказ будет указана в счёте (output_docs-> bills) | ||
| Строка 2243: | Строка 2261: | ||
| "unstandart_check_in": "0", //не стандартное время заезда | "unstandart_check_in": "0", //не стандартное время заезда | ||
| "unstandart_check_out": "0", //не стандартное время заезда | "unstandart_check_out": "0", //не стандартное время заезда | ||
| - | "food": "1", //тип необходимого питания, справочники coming soon | + | "food": "1", //тип необходимого питания, справочники внизу документации |
| "reserve_limit": null, //лимит на проживание | "reserve_limit": null, //лимит на проживание | ||
| "guest_check_in": "1555527600",//дата заезда в unixtime | "guest_check_in": "1555527600",//дата заезда в unixtime | ||
| Строка 2337: | Строка 2355: | ||
| Данные: | Данные: | ||
| - | В uri request - id заявки , service - di услуги | + | В uri request - id заявки , service - id услуги |
| <code> | <code> | ||
| Строка 2360: | Строка 2378: | ||
| ==== Удаление гостя ==== | ==== Удаление гостя ==== | ||
| - | Адрес: ''/api/service-residence-guest/create?request=1&service=1'' | + | Адрес: ''/api/service-residence-guest/delete?id=1'' |
| Метод запрос: ''POST'' | Метод запрос: ''POST'' | ||
| Строка 2622: | Строка 2640: | ||
| ======Справочники ====== | ======Справочники ====== | ||
| ===== Статусы заявок ===== | ===== Статусы заявок ===== | ||
| - | - Новый - заявка только создана | + | * Новый - заявка только создана |
| - | - Принят - менеджер принял заявку в работу | + | * Принят - менеджер принял заявку в работу |
| - | - Забронирован - от гостиницы получили подтверждение о бронировании | + | * Забронирован - от гостиницы получили подтверждение о бронировании |
| - | - Изменен - в заявке есть серьезные изменения\изменения информации клиента. В таком статусе от клиента требуется активное участие, [[.:api#подтверждение_изменений|например подтверждение изменений]] | + | * Изменен - в заявке есть серьезные изменения\изменения информации клиента. В таком статусе от клиента требуется активное участие, [[.:api#подтверждение_изменений|например подтверждение изменений]] |
| - | - Аннулирован - заявка аннулирована | + | * Аннулирован - заявка аннулирована |
| - | - Выполнен - заявка завершена | + | * Выполнен - заявка завершена |
| - | - Отказ - отель не подтверждает бронь, нет номеров и тд. | + | * Отказ - отель не подтверждает бронь, нет номеров и тд. |
| Описание: Справочник статусов заявок. Подробнее в общей [[site:for-user:base#статусы_услуг_и_заявок|статье о статусах]] | Описание: Справочник статусов заявок. Подробнее в общей [[site:for-user:base#статусы_услуг_и_заявок|статье о статусах]] | ||
| Строка 2694: | Строка 2712: | ||
| "id": "1", | "id": "1", | ||
| "name": "Одноместное", | "name": "Одноместное", | ||
| - | "description": null | + | "description": "", |
| + | "sleeping_place": "1" //Количество спальных мест для взрослых | ||
| }, | }, | ||
| { | { | ||
| "id": "2", | "id": "2", | ||
| "name": "Двухместное", | "name": "Двухместное", | ||
| - | "description": null | + | "description": "", |
| + | "sleeping_place": "2" | ||
| } | } | ||
| ] | ] | ||