Autocomplete API

AnyQuery — инструмент для увеличения конверсии поиска в магазинах электронной коммерции. Формирует эффективные поисковые подсказки, обрабатывает синонимы и преобразует поисковые запросы в вид, который корректно обрабатывается поисковой системой.

Сервис ранжирует выдачу на странице результатов поиска с использованием поведенческих данных посетителей и покупателей.

Полный поток от ввода пользователя до отображения подсказок и перехода к поиску:

Единственный метод — GET. Используйте только HTTPS:

GET https://autocomplete.diginetica.net/autocomplete

Полный пример URL

Минимальный запрос

Ответ API — JSON-объект верхнего уровня:

{
  "query":          "кросовк",
  "correction":     "кроссовки",
  "redirect":       "https://...",
  "redirectMobile": "https://...",
  "sts":            [ … ],
  "taps":           [ … ],
  "products":       [ … ],
  "categories":     [ … ],
  "brands":         [ … ],
  "contents":       [ … ]
}

Строка с исправленным запросом. Присутствует в ответе только если исправление произошло. Поиск выполняется именно по этому значению.

Причины исправления

Как использовать

const response = await fetchAutocomplete(userInput);
// correction присутствует только если исправление произошло
const queryForSearch = response.correction ?? userInput;
// передать в Search API
fetchSearchResults({ st: queryForSearch });

Массив популярных запросов других пользователей. Используется для отрисовки подсказок в выпадающем списке при вводе. Максимум — 10 элементов.

"sts": [
  {
    "st":          "трос стальной",
    "amount":      3,
    "redirectUrl": "https://example.com"
  },
  {
    "st":     "труборез для стальных",
    "amount": 2
  }
]

Поля элемента

Массив подсказок-ярлыков, которые помогают пользователю уточнить поисковый запрос. Отображаются на сайте только после нажатия кнопки «Поиск». Максимум — 10 элементов.

"taps": [
  {
    "tap":           "стальной",
    "relatedSearch": "стальной"
  },
  {
    "tap":           "по нержавеющей",
    "relatedSearch": "по нержавеющей стали",
    "redirectUrl":   "https://example.com"
  }
]

Поля элемента

Массив товаров, найденных по запросу. Количество регулируется параметром productsSize (макс. 100).

"products": [
  {
    "id":          "138875",
    "available":   true,
    "name":        "Бокал Bordeaux",
    "brand":       "Spiegelau",
    "price":       "2880.0",
    "score":       109.55,
    "alternative": true,
    "categories": [
      {
        "id":        "74",
        "name":      "Бокалы для вина",
        "direct":    false,
        "link_url":  "https://...",
        "image_url": "https://..."
      }
    ],
    "attributes": {
      "артикул": ["129285"],
      "страна":  ["Германия"],
      "объем":   ["0.44"]
    },
    "link_url":  "https://...",
    "image_url": "https://..."
  }
]

Поля элемента

Массив категорий, релевантных запросу. Максимум — 10 элементов.

"categories": [
  {
    "id":        "74",
    "name":      "Бокалы для вина",
    "direct":    true,
    "link_url":  "https://...",
    "image_url": "https://..."
  }
]

Поля элемента

Массив брендов, релевантных запросу. Максимум — 10 элементов. Доступен после настройки трекинга брендов.

"brands": [
  {
    "id":   "112384",
    "name": "Spiegelau - Бокалы",
    "url":  "https://example.com/catalog/bokaly/filter/brand-spiegelau/"
  }
]

Поля элемента

Массив ссылок на статьи и разделы сайта. Заполняется только при withContent=true и наличии контентного фида. Максимум — 10 элементов.

"contents": [
  {
    "id":        "211",
    "name":      "Матрасы для спортсменов",
    "link_url":  "https://example.com/article/matrasy-dlya-sportsmenov/",
    "image_url": "https://example.com/images/articles/article_img_211.jpg"
  }
]

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

Рекомендуемая реализация

let lastQuery = '';
async function onInput(value) {
  lastQuery = value;
  const result = await fetchAutocomplete(value);
  // отображаем только если запрос всё ещё актуален
  if (value === lastQuery) {
    renderSuggestions(result);
  }
}

Обязателен к проверке на этапе пре-релизного и пост-релизного тестирования.

• Запросы к API проксируются через бэкенд, apiKey не виден в браузере.
• Установлен таймаут 300 мс. При отсутствии ответа — fallback на стандартный поиск.
• Настроен троттлинг 300 мс — запрос отправляется не чаще одного раза в 300 мс.
• При фокусе на строке (пустой ввод) отправляется запрос с st= для показа популярных товаров.
• Реализована проверка актуальности ответа — устаревшие ответы не отображаются.
• В Search API передаётся correction из ответа Autocomplete API. Если correction отсутствует — передаётся исходный st.
• Значение параметра strategy проксируется из входящего URI пользователя.
• Обработаны ошибки 400, 500, 504.
• Массив sts отображается при вводе. Массив taps — только после нажатия «Поиск».