Документация · v1

Публичное API Klyaksa.

Четыре метода для чтения каталога и проверки состояния магазина. Запросы выполняются по HTTPS, ответы возвращаются в JSON.

Базовый адресhttps://api.klyaksa.shop

01 / Начало работы

Первый запрос

Публичным методам не нужен API-ключ. Начните со списка категорий или откройте JSON прямо в браузере.

TERMINAL
curl https://api.klyaksa.shop/v1/categories

Все методы на этом домене доступны только для чтения. Для учётной записи, корзины и заказов используйте сайт магазина.

02 / Каталог

GET

/v1/products

Возвращает JSON-массив видимых товаров вместе с категорией и брендом. По умолчанию в выборку входят товары, не скрытые в магазине.

ПараметрНазначение
categoryФильтр по slug категории
brandФильтр по slug бренда
statusavailable или expected
searchПоиск по названию или артикулу, до 100 символов
minPrice, maxPriceНеотрицательные целые числа; минимум не выше максимума
ПРИМЕР
curl 'https://api.klyaksa.shop/v1/products?status=available'
Открыть ответ →

03 / Справочники

GET

/v1/categories

Возвращает JSON-массив активных категорий, отсортированных по названию.

Открыть ответ →

04 / Справочники

GET

/v1/brands

Возвращает JSON-массив активных брендов, отсортированных по названию.

Открыть ответ →

05 / Мониторинг

GET

/v1/health

Проверяет, отвечает ли приложение магазина и доступна ли его база данных. При успешной проверке возвращает 200 и {"status":"ok"}; при ошибке — 503 и {"status":"unavailable"}. Ответ не кешируется.

TERMINAL
curl -i https://api.klyaksa.shop/v1/health
Открыть страницу состояния →

06 / Ответы

Коды ответа

200 — запрос выполнен. 400 — неверный фильтр товаров. 403 — метод записи на этом домене запрещён. 503 — проверка приложения или базы данных не прошла. Другие ошибки могут возникнуть при временной недоступности сервиса.

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