API документация для example.com

API позволяет сделать поисковый GET запрос и получить результат в формате JSON в виде отранжированных id товаров, категорий и других данных.

Описание GET параметров

Параметр	Значение	Пример	Обязательный параметр
id	идентификатор сайта	https://api.multisearch.io/?id=11740&query=ноут &key=82ca141f1b1da7ffc1562830433d5ea0	Да
key	секретный ключ	https://api.multisearch.io/?id=11740&query=ноут &key=82ca141f1b1da7ffc1562830433d5ea0	Да
query	поисковый запрос	https://api.multisearch.io/?id=11740&query=ноут &key=82ca141f1b1da7ffc1562830433d5ea0	Опциональный
uid	сессия или id пользователя	https://api.multisearch.io/?id=11740&query=ноут &uid=cc441f080 &key=82ca141f1b1da7ffc1562830433d5ea0	Опциональный
t[]	id категории, для фильтрации по категориям	https://api.multisearch.io/?id=11740&query=ноут &t[]=3 &key=82ca141f1b1da7ffc1562830433d5ea0	Опциональный
	фильтр по нескольким категориям	https://api.multisearch.io/?id=11740&query=ноут &t[]=3&t[]=2 &key=82ca141f1b1da7ffc1562830433d5ea0
lang	язык результатов поиска (uk, en, ru и т.д.)	https://api.multisearch.io/?id=11740&query=ноут &uid=cc441f080&lang=ru &key=82ca141f1b1da7ffc1562830433d5ea0	Опциональный
categories	0 - без группировки	https://api.multisearch.io/?id=11740&query=ноут &categories=0 &key=82ca141f1b1da7ffc1562830433d5ea0	Опциональный, по умолчанию all
	all - группировать по всем найденным категориям	https://api.multisearch.io/?id=11740&query=ноут &categories=all &key=82ca141f1b1da7ffc1562830433d5ea0
	n - группировать по первым n категориям	https://api.multisearch.io/?id=11740&query=ноут &categories=1 &key=82ca141f1b1da7ffc1562830433d5ea0
limit	количество позиций (по умолчанию 4)	https://api.multisearch.io/?id=11740&query=ноут &categories=0&limit=10 &key=82ca141f1b1da7ffc1562830433d5ea0	Опциональный, max=50
offset	смещение для выборки (постраничная выдача)	https://api.multisearch.io/?id=11740&query=ноут &categories=0&limit=1&offset=1 &key=82ca141f1b1da7ffc1562830433d5ea0	Опциональный
fields	вывод дополнительных полей:		Опциональный
	true - показать все поля	https://api.multisearch.io/?id=11740&query=ноут &fields=true &key=82ca141f1b1da7ffc1562830433d5ea0
	name,price,picture… - показать выбранные поля	https://api.multisearch.io/?id=11740&query=ноут &fields=name,price,picture &key=82ca141f1b1da7ffc1562830433d5ea0
sort	сортировка результатов направление сортировки: asc - по возрастанию desc - по убыванию		Опциональный, по умолчанию relevance
	relevance (сортировка по релевантности)
	name (сортировка по названию)	https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name&sort=name.asc &key=82ca141f1b1da7ffc1562830433d5ea0 https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name&sort=name.desc &key=82ca141f1b1da7ffc1562830433d5ea0
	price (сортировка по цене)	https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name,price&sort=price.asc &key=82ca141f1b1da7ffc1562830433d5ea0 https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name,price&sort=price.desc &key=82ca141f1b1da7ffc1562830433d5ea0
	ordering (сортировка по популярности, если значение ordering передается в фиде)	https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name&sort=ordering.asc &key=82ca141f1b1da7ffc1562830433d5ea0 https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name&sort=ordering.desc &key=82ca141f1b1da7ffc1562830433d5ea0
	created_at (сортировка по новинкам, если значение передается в фиде)	https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name&sort=created_at.asc &key=82ca141f1b1da7ffc1562830433d5ea0 https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name&sort=created_at.desc &key=82ca141f1b1da7ffc1562830433d5ea0
	profit (сортировка по выгоде, разница между старой и новой ценой товара)	https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name,price,oldprice&sort=profit.asc &key=82ca141f1b1da7ffc1562830433d5ea0 https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name,price,oldprice&sort=profit.desc &key=82ca141f1b1da7ffc1562830433d5ea0
	presence (сортировка по наличию)	https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name,price,oldprice&sort=presence.asc &key=82ca141f1b1da7ffc1562830433d5ea0 https://api.multisearch.io/?id=11740&query=ноут &categories=0&fields=name,price,oldprice&sort=presence.desc &key=82ca141f1b1da7ffc1562830433d5ea0

История запросов

Описание	Метод HTTP	Пример
Запрос отправляется без параметра query	GET	https://api.multisearch.io/?id=11740&uid=cc441f080&key=82ca141f1b1da7ffc1562830433d5ea0
Удаление истории запросов пользователя	DELETE	https://api.multisearch.io/history?id=11740&uid=cc441f080&key=82ca141f1b1da7ffc1562830433d5ea0
Удаление определенного запроса в истории пользователя	DELETE	https://api.multisearch.io/history?id=11740&uid=cc441f080&query=ноут&key=82ca141f1b1da7ffc1562830433d5ea0

Примеры запросов

Описание	Пример
с пагинацией, с группировкой по категории	https://api.multisearch.io/?id=11740&query=ноут&uid=cc441f080&limit=10&offset=10&categories=all &key=82ca141f1b1da7ffc1562830433d5ea0
с фильтром по 2 категориям и пагинацией, со списком категорий	https://api.multisearch.io/?id=11740&query=ноут&uid=cc441f080&limit=18&offset=18&t[]=3&t[]=2&categories=0 &key=82ca141f1b1da7ffc1562830433d5ea0
с дополнительными полями и списком категорий	https://api.multisearch.io/?id=11740&query=ноут&uid=cc441f080&limit=10&categories=0&fields=true &key=82ca141f1b1da7ffc1562830433d5ea0
с дополнительными полями, списком категорий и сортировкой по цене	https://api.multisearch.io/?id=11740&query=ноут&uid=cc441f080&limit=10&categories=0&fields=true&sort=price.asc &key=82ca141f1b1da7ffc1562830433d5ea0
со списком категорий и пагинацией	https://api.multisearch.io/?id=11740&query=ноут&uid=cc441f080&limit=10&categories=0&offset=10 &key=82ca141f1b1da7ffc1562830433d5ea0

Умные автоподсказки - описание GET параметров

Параметр	Значение	Пример	Обязательный параметр
autocomplete	true - тип ответа «autocomplete»	https://api.multisearch.io/?id=11740&query=ноут &uid=cc441f080&lang=ru&autocomplete=true &key=82ca141f1b1da7ffc1562830433d5ea0	Да
group	true - отображение товаров с разбивкой по категориям	https://api.multisearch.io/?id=11740&query=ноут &uid=cc441f080&lang=ru&autocomplete=true&group=true &key=82ca141f1b1da7ffc1562830433d5ea0	Опциональный

Динамические фильтры - описание GET параметров

Параметр	Значение	Пример	Обязательный параметр
filters	вывод фильтров:
	true - показать все фильтры	https://api.multisearch.io/?id=11740&query=ноут &uid=cc441f080&categories=0&fields=true&limit=36&lang=ru &filters=true &key=82ca141f1b1da7ffc1562830433d5ea0	Опциональный
	filters={…} - показать фильтры с выбранными значениями	https://api.multisearch.io/?id=11740&query=ноут &uid=cc441f080&categories=0&fields=true&limit=36&lang=ru &filters={"brand":["Asus"],"price":{"from":"50","to":"1500"}} &key=82ca141f1b1da7ffc1562830433d5ea0

HTTP-заголовки

Заголовок	Значение	Описание	Обязательный параметр	Пример
X-Forwarded-For	IP конечного пользователя, который отправил поисковый запрос	Можно использовать для: • защиты от ботов и парсинга через поиск • исключения записи данных в аналитику поиска Срок хранения: 1 месяц	Необязательный	curl -H 'X-Forwarded-For: 1.2.3.4' 'https://api.multisearch.io/?id=11740&query=ноут &key=82ca141f1b1da7ffc1562830433d5ea0'

Важно: все параметры в GET запросе должны быть URL-encoded.