API Reference · v1.1

Все эндпоинты

База: https://api.onecatalog.ru/wiki/v1. Все ответы — JSON. Аутентификация — через заголовок X-API-Key или query-параметр ?api_key=....

Авторизация

Передавайте свой ключ одним из двух способов:

# Через заголовок (рекомендуется)
curl https://api.onecatalog.ru/wiki/v1/products/ \
  -H "X-API-Key: YOUR_KEY"

# Через query-параметр (без CORS preflight)
curl "https://api.onecatalog.ru/wiki/v1/products/?api_key=YOUR_KEY"

Ключи получаете в личном кабинете.

Фильтрация

Параметр filter_by поддерживает комбинированные фильтры в одной строке:

filter_by=brand_id:1,2,3;product_shape_id:5;country_id:7
  • Значения внутри одного фильтра — через запятую (OR).
  • Разные фильтры — через точку с запятой (AND).
  • Имена полей с суффиксом _id: brand_id, не brand.

Пагинация

Используйте limit (размер страницы) и start (смещение):

# Первая страница: товары 0–19
GET /products/?limit=20&start=0

# Вторая страница: товары 20–39
GET /products/?limit=20&start=20

В каждом ответе поле meta.total — общее число записей под текущими фильтрами, meta.counts — количество в этой странице.

Ошибки

API возвращает стандартные HTTP-коды:

КодЗначениеЧто делать
400Невалидный параметрПроверьте синтаксис filter_by, формат id.
401Нет ключаПередайте X-API-Key или api_key.
403Ключ невалидныйПроверьте, не отозван ли ключ в кабинете.
404Ресурс не найденПроверьте public_id (не id!) товара.
429Превышен лимитПодождите минуту или повысьте тариф.
500Внутренняя ошибкаНапишите нам — мы починим.

Эндпоинты

Products

Каталог товаров. Самый важный набор эндпоинтов.

Brands

Производители товаров.

Categories

Категории каталога (плитка для ванной, фасадная и т.д.).

Product shapes

Типы товаров: плитка, мозаика, клинкер, ступени и т.д.

Files

Изображения товаров и брендов.

Не хватает чего-то?

Полная схема OpenAPI 3.1: openapi.json ↗

Если нужен эндпоинт, которого пока нет — напишите. Мы добавляем по запросу.