Опишите доработку или сценарий — обсудим вместе с другими клиентами.
Ркипер(r_keeper) - обмен статусами заказов
Технические данные
Совместимые редакции
- Программа для ЭВМ "1С-Битрикс: Управление сайтом". Лицензия Малый бизнес
- Программа для ЭВМ "1С-Битрикс: Управление сайтом". Лицензия Бизнес
Описание
1. Описание решения
Ркипер(r_keeper) - обмен статусами заказов — модуль, который принимает от r_k Delivery уведомления (вебхуки) о смене статуса заказа и переносит этот статус в заказ интернет-магазина «1С-Битрикс». Покупатель видит в личном кабинете, на каком этапе его заказ: принят, готовится, курьер в пути, доставлен. Подходит для сайтов доставки еды и ресторанов, которые принимают заказы на сайте и обрабатывают их в rKeeper.
КАК РАБОТАЕТ
r_k Delivery при каждой смене статуса заказа отправляет вебхук на адрес модуля. Модуль проверяет, что запрос действительно пришёл от r_keeper, и находит заказ сайта по номеру заказа rKeeper. Номер берётся из таблицы связей модуля «Ркипер(r_keeper) - отправка заказов». Затем модуль ставит заказу соответствующий статус магазина. Если в rKeeper заказ отменили, на сайте он тоже отменяется. Каждое событие сохраняется в таблицу истории. Запросов к API rKeeper модуль не делает, агенты и cron не нужны: статус на сайте меняется сразу, как только приходит событие.
СОПОСТАВЛЕНИЕ СТАТУСОВ
— Готовый справочник статусов r_k Delivery: новый, подтверждён, передан на кухню, готовится, приготовлен, сборка, собран, у курьера, в пути, доставлен, отменён;
— Для каждого статуса rKeeper можно выбрать статус заказа магазина или оставить «не менять»;
— Отдельная настройка для неизвестных статусов, которых нет в справочнике;
— Кнопка быстрого создания статусов магазина RA–RG и RC («Заказ принят», «Готовится», «Курьер в пути», «Доставлен», «Отменён» и др.). Эти статусы уже выбраны в сопоставлении по умолчанию, так что модуль работает сразу после создания.
СТАТУС ЗАКАЗА В ЛИЧНОМ КАБИНЕТЕ
— В карточке заказа покупателя появляется виджет с прогресс-баром. Этапы: принят → подтверждён → готовится → собирается → в пути → доставлен;
— Для отменённых заказов показывается отдельное состояние «Отменён»;
— Статус можно обновить кнопкой «Обновить» или автоматически с заданным интервалом;
— Виджет показывается только владельцу заказа или администратору;
— Виджет встраивается в стандартную страницу заказа (компонент sale.personal.order.detail) без правки шаблона. Его можно отключить или подключить вручную.
БЕЗОПАСНОСТЬ
— Обязательная проверка токена: заголовок X-Token или Authorization: Bearer. Без верного токена статус заказа изменить нельзя;
— Необязательная проверка подписи X-Signature: фиксированное значение или HMAC тела запроса (sha256 / sha1 / md5);
— Белый список IP-адресов r_keeper;
— Можно принимать события только от одного ресторана (по GUID restaurantId), события от других точек отклоняются.
КОНТРОЛЬ
— История вебхуков в отдельной таблице: номер заказа rKeeper, номер заказа сайта, статус, дата;
— Журнал приёма и смены статусов. Он хранится в каталоге вне корня сайта и недоступен по HTTP;
— Отклонённые запросы попадают в журнал с указанием причины: неверный токен, подпись, IP или чужой ресторан.
НАСТРОЙКА
— Вебхук: готовый URL для шаблона r_k Delivery, токен, подпись, белый список IP, GUID ресторана;
— Статусы: сопоставление статусов rKeeper со статусами магазина, создание недостающих статусов;
— Личный кабинет: включение виджета, путь карточки заказа, интервал автообновления;
— Журнал: включение логирования.
ТРЕБОВАНИЯ
— Модуль «Интернет-магазин» (sale);
— Модуль «Ркипер(r_keeper) - отправка заказов» (goldencode.rkeeperorders): по его таблице связей заказы rKeeper сопоставляются с заказами сайта;
— Доступ к шаблонам уведомлений в r_k Delivery (канал «api»).
Выгрузку меню выполняет отдельное решение «Ркипер(r_keeper) - синхронизация меню».
- Убедитесь, что установлены модули «Интернет-магазин» (sale) и «Ркипер(r_keeper) - отправка заказов» (goldencode.rkeeperorders). Без них установка будет прервана с соответствующим сообщением.
- Установите модуль стандартным способом: Администрирование → Модули (Настройки → Модули) → «Ркипер(r_keeper) - обмен статусами заказов» → Установить.
- При установке автоматически:
— создаётся таблица истории вебхуков;
— регистрируется обработчик, который выводит виджет статуса в личном кабинете.
При удалении модуля настройки и таблицу событий можно сохранить. Статусы заказа RA–RG и RC не удаляются: если они не нужны, удалите их вручную в разделе «Магазин → Настройки → Статусы».
НАСТРОЙКА
Откройте Настройки → Настройки модулей → «Ркипер(r_keeper) - обмен статусами заказов». Настройки разбиты на четыре вкладки.
Вкладка «Вебхук»
— URL вебхука — готовый адрес (только для чтения), который нужно указать в r_k Delivery;
— Токен вебхука (X-Token) — обязательный параметр, то же значение указывается в шаблоне вебхука r_k. Можно также передавать его заголовком Authorization: Bearer;
— Подпись (X-Signature) — значение заголовка или секретный ключ для проверки HMAC тела запроса. Если оставить пустым, подпись не проверяется;
— Белый список IP r_keeper — адреса через запятую. Если оставить пустым, проверка выключена;
— GUID ресторана (restaurantId) — если указан, принимаются только события этого ресторана.
Вкладка «Статусы»
— Таблица сопоставления: для каждого статуса r_keeper показан текст, который видит клиент, и выбирается статус заказа магазина (или «не менять»);
— Неизвестный статус — какой статус магазина ставить, если пришёл код, которого нет в справочнике;
— Блок «Статусы магазина rKeeper (RA–RG/RC)» показывает, какие статусы уже есть. Кнопка «Создать статусы rKeeper в магазине» создаёт недостающие.
Вкладка «Личный кабинет»
— Показывать виджет статуса в личном кабинете — да / нет;
— Путь карточки заказа: виджет показывается на страницах, адрес которых содержит эту строку (по умолчанию /personal/order/detail/). Если встраиваете виджет вручную, очистите поле;
— Автообновление статуса, в секундах. 0 — обновлять только по кнопке «Обновить».
Вкладка «Журнал»
— Вести журнал — файловый лог. Он пишется в каталог вне корня сайта, путь показан на странице.
НАСТРОЙКА R_K DELIVERY
- В r_k Delivery откройте «Шаблоны» и создайте новый шаблон с каналом «api».
- Укажите URL вебхука со страницы настроек модуля и заголовок X-Token с тем же токеном, что в модуле. Если используется подпись, добавьте заголовок X-Signature.
- В условиях отправки отметьте статусы заказа, о которых нужно сообщать сайту.
ПЕРВЫЙ ЗАПУСК И ПРОВЕРКА
- На вкладке «Статусы» нажмите «Создать статусы rKeeper в магазине» и проверьте сопоставление.
- Задайте токен и сохраните настройки, затем настройте шаблон в r_k Delivery.
- Оформите тестовый заказ на сайте. Модуль «Ркипер(r_keeper) - отправка заказов» передаст его в rKeeper. Измените статус заказа в rKeeper и проверьте, что статус заказа на сайте сменился.
- Откройте этот заказ в личном кабинете покупателя: виджет должен показывать текущий этап.
- Если статус не изменился, включите журнал и посмотрите причину. Чаще всего это неверный токен или подпись, IP не из белого списка, другой ресторан или заказ, который ещё не был отправлен в rKeeper.
Установите этот модуль прямо сейчас!
Для этого укажите адрес сайта:
Подтвердите что сама лицензия у вас куплена
