API v1 · Только чтение

Каталог Zapford

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

Скачать OpenAPI 3.0.3 · Статус приложения

Авторизация

Для всех маршрутов /v1/, включая фотографии, передавайте секретный ключ в заголовке. Документация и статус приложения открыты.

Authorization: Bearer YOUR_API_KEY

Маршруты

GET	Результат
/v1/products	Список карточек с пагинацией
/v1/products/{id}	Полная карточка и дополнительные фото
/v1/categories	Группы и количество карточек
/v1/manufacturers	Производители и количество карточек
/v1/products/{id}/images/main	Основное фото
/v1/products/{id}/images/{image_id}	Дополнительное фото по ID из карточки

Получить список

curl 'https://api.zapford.ru/v1/products?per_page=50&page=1'   -H "Authorization: Bearer $ZAPFORD_API_KEY"

Найти карточку по производителю и артикулу

curl -G 'https://api.zapford.ru/v1/products'   -H "Authorization: Bearer $ZAPFORD_API_KEY"   --data-urlencode 'manufacturer=Ford'   --data-urlencode 'model=1449986'

Фильтры списка

Параметр	Значение
`page`	Страница, начиная с 1
`per_page`	Размер страницы: 1–100
`q`	Поиск фрагмента названия, артикула, SKU или производителя
`model`	Точное совпадение артикула без учета регистра
`manufacturer`	Точное название без учета регистра; Ford, Ford USA и FORD EUROPE равнозначны
`manufacturer_id`	ID производителя
`category_id`	ID группы; без вложенных групп
`status`	Активность: 0 или 1; по умолчанию обе
`in_stock`	1 — количество > 0, 0 — количество <= 0
`price_min`	Минимальная базовая цена включительно
`price_max`	Максимальная базовая цена включительно
`sort`	id, name, model, price, quantity, date_modified
`order`	asc или desc

Формат ответа

{
  "data": [{"id": 983, "model": "...", "price": "1000.0000",
            "currency": "RUB", "quantity": 0, "active": true}],
  "pagination": {"page": 1, "per_page": 25, "total": 1491, "total_pages": 60}
}

Пример сокращен. Полный состав полей описан в OpenAPI. Список содержит основное фото; полная карточка также содержит images — дополнительные фото, описание, идентификаторы, размеры и характеристики.

Как читать данные

Источник — действующая база магазина 0, русский язык. По умолчанию возвращаются и активные, и отключенные карточки. Для опубликованных используйте status=1.
Цена — базовая цена OpenCart в RUB, десятичной строкой. Акции, скидки и налоговые расчеты не применяются.
Даты передаются как сохранены в базе, без изменения часового пояса. Между страницами каталог может измениться.
Основное фото — main_image, остальные — images. Поле available сообщает о наличии файла. Для скачивания фото требуется Bearer-ключ; поддерживаются ETag и HEAD.
Количество в справочниках включает отключенные карточки и считается без вложенных групп.
HTML описания необходимо очищать перед отображением в своем интерфейсе.

Ошибки и ограничения

401 — неверный ключ; 404 — карточка или фото отсутствует; 405 — метод недоступен; 422 — неверные параметры; 429 — слишком много запросов; 503 — база недоступна. Ошибка содержит code, message и request_id.

До 100 карточек на страницу. Ограничение: 10 запросов в секунду на IP с коротким всплеском до 30 запросов. На 429 повторите запрос с паузой. Создание и изменение карточек в этой версии не реализованы.