Обзор Relavio Search

Relavio Search — это товарный поиск для интернет-магазинов и каталогов. Он помогает пользователю быстрее найти нужный товар, показывает подсказки во время ввода, выводит карточки товаров, поддерживает фильтры и передает события кликов в аналитику.

Основной способ подключения — JavaScript-виджет. Его можно встроить в шапку сайта, на страницу поиска, в каталог или в отдельный блок с рекомендациями по запросу.

Для чего нужен Relavio Search

Relavio Search закрывает несколько задач на сайте:

• быстрый поиск товаров по названию, бренду, модели и категориям;
• автодополнение запроса до отправки пользователя на страницу результатов;
• показ релевантных товаров прямо в выпадающем списке;
• отображение полноценного каталога с пагинацией;
• фильтрация результатов по бренду, категории, цене, наличию и атрибутам товара;
• сбор аналитики по поисковым сессиям и кликам по товарам.

Как работает виджет

Виджет подключается через скрипт search-widget.js и контейнер с атрибутом data-relavio-search-widget.

<div
    data-relavio-search-widget
    data-api-key="YOUR_API_KEY"
    data-behavior="suggests"
></div>

<script src="https://relavio.su/js/search-widget.js"></script>

После загрузки скрипта виджет автоматически инициализирует контейнеры на странице, добавляет поле поиска, подключает стили и начинает отправлять запросы к API Relavio.

Основные возможности

Поиск по товарам

В режиме search виджет показывает товары в выпадающем списке по мере ввода запроса. Карточка товара может содержать название, изображение, описание, цену, старую цену и ссылку на страницу товара.

Если результатов больше одной страницы, виджет догружает следующие товары при прокрутке списка.

Подсказки

В режиме suggests виджет показывает компактный список подсказок. В него могут входить:

• история запросов пользователя;
• поисковые фразы;
• категории;
• товары.

Клик по подсказке подставляет ее в поле поиска и запускает поиск. Этот режим удобно использовать в шапке сайта.

Каталог

В режиме catalog виджет работает как страница результатов поиска. Он показывает поле поиска, сетку товаров и пагинацию.

Количество колонок и рядов настраивается атрибутами data-columns и data-catalog-rows. Если нужно задать точное количество товаров на странице, используйте data-per-page.

Каталог с фильтрами

В режиме catalog-with-filters рядом с товарами отображается блок фильтров. Виджет строит фильтры из ответа API и автоматически перезапускает поиск при изменении значений.

Поддерживаются фильтры следующих типов:

• terms — список значений, например бренд или категория;
• range — диапазон, например цена от и до;
• boolean — переключатель значения, например наличие товара.

Голосовой ввод

Виджет добавляет кнопку голосового ввода. Если браузер поддерживает Web Speech API, пользователь может зажать кнопку, произнести запрос, а виджет подставит распознанный текст в поле поиска.

По умолчанию используется язык ru-RU. Его можно изменить через data-speech-language.

Аналитика кликов

При клике по карточке товара виджет отправляет событие в /api/v1/search/events. В событие попадают данные поисковой сессии, товар, позиция, страница выдачи, цена и источник клика.

Это позволяет анализировать, какие запросы приводят к переходам на товары, какие позиции кликают чаще и где пользователи не находят подходящий результат.

Режимы виджета

Режим	Где использовать	Что показывает
search	Поисковая строка с быстрыми результатами	Товары в выпадающем списке
suggests	Шапка сайта, компактный поиск	Историю, подсказки, категории и товары
catalog	Страница результатов	Сетку товаров и пагинацию
catalog-with-filters	Каталог или расширенный поиск	Сетку товаров, пагинацию и фильтры

Из чего состоит интеграция

Интеграция Relavio Search обычно включает три части:

1. Импорт товаров в Relavio, чтобы поиск получил названия, категории, цены, изображения, ссылки и атрибуты.
2. Подключение виджета на сайт с API-ключом проекта.
3. Проверка аналитики поисковых запросов и кликов после запуска.

Для импорта можно использовать YML, CSV или API. После импорта товары индексируются и становятся доступны в поиске, подсказках и фильтрах.

API, который использует виджет

Виджет работает с публичными endpoint-ами Relavio Search:

• /api/v1/search — поиск товаров, каталог, фильтры и пагинация;
• /api/v1/search/suggests — подсказки, история, категории и товары для автодополнения;
• /api/v1/search/events — события кликов, добавлений в корзину и покупок.

API-ключ передается в заголовке api-key. Поисковая сессия сохраняется через session_id и search_id, чтобы связывать запросы, подсказки и клики пользователя.

Когда использовать разные сценарии

Используйте suggests, если нужен быстрый поиск в шапке сайта без отдельной страницы результатов.

Используйте search, если хотите показывать товарные карточки сразу под поисковой строкой и догружать результаты при прокрутке.

Используйте catalog, если у вас есть отдельная страница поиска или раздел каталога.

Используйте catalog-with-filters, если пользователю нужно уточнять выдачу по бренду, категории, цене, наличию или характеристикам товара.

Следующие разделы

• Быстрый старт — подключение виджета на сайт.
• Установка виджета — варианты установки и инициализации.
• Конфигурация — параметры data-* и JavaScript-инициализации.
• Импорт товаров — подготовка товарных данных для поиска.
• Search API — работа с API поиска напрямую.