Инструкция по установке сервиса Умного поиска Soft IQ

Введение

В данной инструкции будет рассмотрены этапы по установке сервиса умного поиска Soft IQ с нескольким вариантами по типу сайта: общая инструкция подходящая для большинства сайтов, и второй вариант – на популярную CMS WordPress. После успешной установки вам будет доступен сервис в полном объеме.


Требования, необходимые для работоспособности сервиса умного поиска Soft IQ:

1. Уровень подготовки пользователя: пользователь должен иметь навык эксплуатации персонального компьютера и операционной системы из перечисленных: Windows 7 и выше, Unix-подобные, MacOS.

2. Тип ЭВМ пользователя: персональный компьютер или ноутбук.

3. Требования к браузеру установленному на ЭВМ пользователя:

– Yandex Browser версии 15.4. и выше
– Google Chrome версии 74.0.3729.169 и выше
– Firefox версии 77.0.0 и выше
– Opera версии 71.0.3770.228 и выше
– Edge версии 79.0.309.68 и выше


Содержание

  1. Подготовка
    1. YML-фид
    2. Сайт опубликованный в сети Интернет
  2. Регистрация
  3. Создание проекта
  4. Настройка проекта
  5. Интеграция сервиса на сайт
    1. Общая инструкция
    2. WordPress
  6. Заключение

1. Подготовка

Рекомендуется перед установкой сервиса иметь:

  • Готовый YML-фид
  • Сайт опубликованный в сети Интернет

1.1. YML-фид

YML (Yandex Market Language) — собственный стандарт Яндекса, основанный на XML. В YML-файлах можно целиком описать каталог магазина в формате, удобном для автоматической генерации.
Полную инструкцию по структуре и руководству можно прочитать на официальном сайте YML-формата здесь

Пример готового YML-фида
Вы можете скопировать этот код полностью 

<?xml version="1.0" encoding="UTF-8"?>
<yml_catalog date="2022-08-10T14:37:38+03:00">
    <shop>
        <name>BestSeller</name>
        <company>Tne Best inc.</company>
        <url>http://best.seller.ru</url>
        <platform>uCoz</platform>
        <version>1.0</version>
        <agency>Технологичные решения</agency>
        <email>example-email@gmail.com</email>
        <categories>
            <category id="1">Бытовая техника</category>
            <category id="10" parentId="1">Мелкая техника для кухни</category>
            <category id="101" parentId="10">Сэндвичницы и приборы для выпечки</category>
        </categories>
        <offers>
            <offer id="901299">
                <name>Мороженица Brand 3811</name>
                <vendor>Brand</vendor>
                <vendorCode>A1234567B</vendorCode>
                <categoryId>10</categoryId>                
                <picture>http://best.seller.ru/img/model_12345.jpg</picture>               
                <description>
                    <![CDATA[          
                        <h3>Мороженица Brand 3811</h3>
                        <p>Это прибор, который придётся по вкусу всем любителям десертов и сладостей, ведь с его помощью вы сможете делать вкусное домашнее мороженое из натуральных ингредиентов.</p>
                    ]]>
                </description>                               
                <manufacturer_warranty>true</manufacturer_warranty>
                <country_of_origin>Китай</country_of_origin>
                <barcode>4601546021298</barcode>
                <param name="Цвет">белый</param>
                <weight>3.6</weight>
                <dimensions>20.1/20.5/22.5</dimensions>
                <service-life-days>P2Y</service-life-days>
                <comment-life-days>Использовать при температуре не ниже -10 градусов.</comment-life-days>
                <warranty-days>P1Y</warranty-days>
                <comment-warranty>Гарантия не распространяется на механические повреждения покрытия чаши.</comment-warranty>             
            </offer>
            <offer id="123467">
                <name>Сэндвичница Brand A1234567B</name>                            
                <vendor>Brand</vendor>                  
                <vendorCode>A1234567B</vendorCode>                
                <categoryId>101</categoryId>                
                <picture>http://best.seller.ru/img/device56789.jpg</picture>               
                <:param name="Мощность">750 Вт</param>
                <description>Сэндвичница 2 в 1: можно приготовить как сэндвичи, так и вафли.</description>                
                <manufacturer_warranty>true</manufacturer_warranty><country_of_origin>Россия</country_of_origin>
                <barcode>9876543210</barcode>  
                <weight>1.03</weight>  
                <dimensions>20.800/23.500/9.000</dimensions>
            </offer>
        </offers>
    </shop>
</yml_catalog>

Далее необходимо опубликовать этот YML-фид для публичного доступа, и подготовить прямую ссылку для дальнейшей работы

1.2. Сайт опубликованный в сети Интернет

Для установки сервиса необходим опубликованный в сети Интернет Web-сайт. Минимальные требования: функционирующая поисковая строка для стандартного поиска, например, в интернет магазине.

Можно использовать следующий HTML + CSS код для создания поисковой строки

<div class="header-search-block">
    <form id="search_form" action="/search" method="get">
        <input id="search-input" class="header-search-block__search" name="q" value="" type="search" placeholder="Поиск по каталогу">
        <button type="button" class="header-search-submit"></button>
    </form>
</div>

<style>
.header-search-block {
    border: 1px solid #ea5a0c;
    position: relative;
    -webkit-box-flex: 1;
    -ms-flex-positive: 1;
    flex-grow: 1;
}
.header-search-block:focus, .header-search-block:hover {
    border: 1px solid #eaaf0c;
}
.header-search-block form {
    position: relative;
    display: -webkit-box;
    display: -ms-flexbox;
    display: flex;
    -webkit-box-align: center;
    -ms-flex-align: center;
    align-items: center;
    -webkit-box-pack: center;
    -ms-flex-pack: center;
    justify-content: center;
}
.header-search-block__search {
    height: 46px;
    border: 0;
    border-radius: 10px;
    padding: 0 10px;
    outline-color: transparent;
    width: calc(100% - 52px);
}
.header-search-submit {
    background-color: #ea5a0c;
    background-image: url(https://www.w3.org/Icons/search.svg);
    background-repeat: no-repeat;
    background-position: center;
    background-size: 44%;
    height: 40px;
    width: 47px;
    border: 0;
    outline-color: transparent;
    cursor: pointer;
}
</style>

Вы можете скопировать этот код и вставить на страницу сайта

2. Регистрация

Регистрация пользователей в сервисе доступна на странице https://lk.softiq.org/register.
Для успешной регистрации необходимо ввести следующие данные:

  • Адрес электронной почты
  • Имя Фамилия
  • Телефон
  • Пароль
  • Подтверждение пароля.

Необходимо использовать пароли не менее 8 символов. Пароль должен содержать хотя бы одну цифру и заглавную букву.

Далее необходимо нажать на чекбокс для принятия Политики конфиденциальности. Ознакомиться с согласием на обработку персональных данных можно по ссылке https://softiq.org/docs/consent_to_the%20processing_of_pd.pdf. После, нажать на кнопку "Создать" под формой с данными.

Теперь вы зарегистрированы в сервисе Умный поиск Soft IQ!


3. Создание проекта

Первым экраном после регистрации у вас будет страница "Проекты" – с этого начинается работа в личном кабинете. Для начала вам необходимо создать проект – форма для заполнения находится в правой части экрана. Необходимо ввести следующие данные:

  • Имя проекта
  • Ссылка на сайт
  • Ссылка на фид
  • Форма фида

Нажимаем кнопку "Добавить проект" внизу под формой.

Теперь ваш проект будет создан и готов для дальнейшего управления

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

4. Настройка проекта

Теперь необходимо перейти в раздел "Поисковый виджет" https://lk.softiq.org/search/widget

Если вы используете код поисковой строки из раздела 1. Подготовка, тогда необходимо заполнить следующие пункты:

  • Поле ввода поискового запроса на вашем сайте – введите #search-input
  • Кнопка «искать» на вашем сайте – введите .header-search-button
  • Контейнер поиска (wrapper) – введите .header-search-block

Теперь необходимо скопировать код виджета, для этого в блоке "Скрипт виджета" нажмите кнопку "Скопировать".


5. Интеграция сервиса на сайт

В этом пункте необходимо обратиться к администратору сайта или самостоятельно, если обладаете необходимыми правами.

5.1. Общая инструкция

Этот вариант подходит для большинства сайтов на CMS, фреймворках или других нестандартных инструментов управления сайтов.

Установка сервиса на сайт следующая – необходимо интегрировать код скрипта скопированный из пункта 4 этой инструкции на страницы сайта, где планируется производить поиск по каталогу.

Рекомендуется вставлять код скрипта в нижней части страницы, например в подвал сайта.

Скрипт будет работать только по клику на поисковой строке, настройку этого мы производили в пункте 4.

Пример страницы с интегрированным скриптом смотрите ниже:

5.2. WordPress

Вариант 2 – интеграция кода скрипта на популярную CMS WordPress. Входим в панель управления WordPress

Wordpress форма входа

Выбираем раздел “Внешний вид” и жмем “Настроить” на нужной теме

Wordpress Внешний вид

В разделе Виджеты

В разделе Виджеты

Выбираем “Подвал”

Выбираем подвал

и уже в Подвал добавляем js-код виджета умного поиска SoftIQ.

Добавляем скрипт

Сохраняем и запускаем в работу.

6. Заключение

Все необходимое для установки сервиса мы сделали, теперь можно приступить к проверке работоспособности – введите поисковые запросы:

  • с названием товара
  • с названием товара, но с раскладкой на английском языке
  • с артикулом товара
  • с опечаткой

Готово! Основной функционал протестирован и работает.