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.