Swagger

Интерактивная Swagger-документация Relavio Search доступна по адресу:

Открыть Swagger

Swagger показывает актуальные endpoint-ы публичного API, схемы запросов и ответов, коды ошибок и примеры payload. Используйте его, если нужно быстро проверить структуру API или протестировать запросы без написания собственного клиента.

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

1. Откройте https://relavio.su/api/documentation.
2. Найдите нужный раздел: Search для поиска и подсказок или Events для аналитических событий.
3. Откройте endpoint, например POST /api/v1/search.
4. Нажмите Try it out, если нужно выполнить тестовый запрос.
5. Укажите API-ключ магазина в заголовке api-key.
6. Заполните JSON-тело запроса и нажмите Execute.

Основные endpoint-ы

Endpoint	Назначение
POST /api/v1/search	Поиск товаров, каталог, пагинация и фильтры.
POST /api/v1/search/suggests	Подсказки, история, категории, бренды и товары для автодополнения.
POST /api/v1/search/events	События аналитики: клики, добавления в корзину и покупки.

Авторизация

Для запросов нужен API-ключ проекта Relavio. Передавайте его в заголовке:

api-key: YOUR_API_KEY

Если ключ отсутствует или неверный, API вернет ошибку 401 Unauthorized.

Когда использовать Swagger

Swagger полезен для быстрой проверки интеграции, просмотра схем данных и ручного тестирования endpoint-ов. Для описания сценариев работы виджета используйте страницы этого раздела: Search API, Suggest API, товары и фильтры, Analytics API.