Быстрый старт

Первый запрос за 5 минут

Мы пройдём путь от получения ключа до разбора ответа. Никаких SDK ставить не нужно — работаем с обычным HTTP.

  1. 1

    Получите API-ключ

    Личный кабинет с выдачей собственных ключей пока в разработке — этот сайт уже работает на встроенном демо-ключе, можно начинать без регистрации.

  2. 2

    Сделайте первый запрос

    Простой GET-запрос к /products/ с заголовком авторизации:

    curl https://api.onecatalog.ru/wiki/v1/products/?limit=1 \
      -H "X-API-Key: YOUR_KEY"

    Альтернативно ключ можно передать в query-параметре ?api_key=... — это удобно для тестов из браузера и не вызывает CORS preflight:

    curl "https://api.onecatalog.ru/wiki/v1/products/?limit=1&api_key=YOUR_KEY"
  3. 3

    Попробуйте прямо сейчас

    Нажмите кнопку — мы выполним запрос с демо-ключом и покажем сырой ответ:

  4. 4

    Структура ответа

    Все списочные эндпоинты возвращают объект одного формата:

    {
      "data": [ /* ... */ ],
      "success": true,
      "meta": {
        "total": 24180,
        "counts": 20
      }
    }

    data — собственно полезная нагрузка, meta.total — общее число записей под текущими фильтрами (для пагинации).

  5. 5

    Получите конкретный товар

    Для запроса деталей одного товара используется его public_id (не числовой id!):

    curl https://api.onecatalog.ru/wiki/v1/products/PRD-CRX-039/ \
      -H "X-API-Key: YOUR_KEY"
    Важно: URL вида /products/123/ не работает. Эндпоинт /products/{id}/ принимает только строковый public_id или slug, которые вы получаете в листинге.
  6. 6

    Добавьте фильтры

    Чтобы получить, например, товары типа 1 от брендов 5 и 7:

    curl "https://api.onecatalog.ru/wiki/v1/products/?filter_by=brand_id:5,7;product_shape_id:1&limit=20" \
      -H "X-API-Key: YOUR_KEY"

    Внутри фильтра значения через запятую, разные фильтры — через точку с запятой. Полный список параметров — вAPI Reference.