Advanced REST API для OpenCart - 1.0.3 + openapi.json, Postman collection, environment

Демо модулю

Админка: перейти

Логин: demo

Пароль: demo

Ссылки на документацию и API Reference присутствуют в админке модуля! 

🚀 Advanced REST API для OpenCart - профессиональная интеграция вашего магазина с любой системой

Advanced REST API - это самый полноценный и безопасный REST API модуль для OpenCart, разработанный для магазинов, которым нужна глубокая интеграция с ERP-системами, CRM, учётными программами (1С, БАС, Bitrix24), маркетплейсами (Rozetka, Prom, Allo, Hotline, kaspi.kz, halykmarket.kz, flip.kz, Satu.kz), службами доставки (Новая Почта и другие) и мобильными приложениями.

Модуль предоставляет унифицированный HTTP-интерфейс ко всем основным сущностям магазина с поддержкой HMAC-SHA256 подписи запросов, гибкой системой прав доступа и вебхуками для реактивных интеграций.

✨ Ключевые возможности

📦 Полное управление каталогом

• Товары (Products) - создание, чтение, обновление, удаление с поддержкой мультиязычных описаний, изображений галереи, атрибутов, опций (select, radio, checkbox, image, text, textarea, file, date, time, datetime), акций (specials), скидок (discounts), связанных товаров, SEO URL, макетов, бонусных баллов, downloads, фильтров
• Расширенный endpoint action=full - получение максимально детальной информации о товаре (производитель, налоговый класс, статус наличия, магазины, layouts, отзывы, рейтинг) в одном запросе
• Массовое обновление остатков и цен (bulk_stock) - до 500 товаров за один запрос с идентификацией по product_id, SKU или model - идеально для синхронизации с ERP
• Категории (Categories) - иерархическая структура с рекурсивным удалением, мультиязычные описания, привязки к магазинам
• Производители (Manufacturers) - CRUD с мультиязычностью и SEO
• Атрибуты и группы атрибутов - полное управление характеристиками товаров
• Опции товаров (Options) - все типы OpenCart с мультиязычными значениями

🛒 Работа с заказами

• Заказы (Orders) - чтение, создание новых заказов через штатную логику OpenCart, ограниченное обновление контактных данных
• История статусов - изменение статуса заказа с автоматическим email-уведомлением покупателя, списанием остатков, начислением бонусов и применением купонов
• Статусы заказов (Order Statuses) - полный CRUD для мультиязычных статусов
• Возврат товаров (Returns / RMA) - CRUD для заявок на возврат со справочниками причин, действий и статусов
• Фильтрация по датам, покупателю, статусу, поиск по имени и email

👥 Покупатели и маркетинг

• Покупатели (Customers) - полный CRUD с адресами, группами покупателей, подписками на рассылку, безопасным хешированием паролей (совместимо с нативным OpenCart)
• Отзывы (Reviews) - CRUD для импорта отзывов с маркетплейсов
• Купоны (Coupons) - скидки в процентах или фиксированной сумме с привязкой к товарам и категориям
• Информационные страницы (CMS) - управление статическими страницами (О нас, Доставка, Политика конфиденциальности)

🌐 Локализация и справочники

• Список языков и валют магазина
• Справочники стран, зон (областей), геозон
• Классы веса, длины, статусы наличия
• Налоговые классы и ставки
• Группы покупателей и статусы заказов

🔗 SEO URL (ЧПУ)

• Универсальный ресурс, который автоматически определяет структуру таблицы ЧПУ вашей сборки:
  • seo_url с колонками key/value (OpenCart 3.0.3.0+)
  • seo_url с колонкой query (ocStore 3.x)
  • url_alias (ранние OpenCart 3.0.x / 2.x)
• CRUD для любых ЧПУ - товаров, категорий, производителей, страниц

🪝 Вебхуки (Webhooks)

• Подписка на события магазина: order.add, order.status, product.add, product.update, product.delete, customer.add
• Поддержка wildcard * - подписка на все события
• Подписанные HMAC-SHA256 POST-запросы с заголовками X-Webhook-Event и X-Webhook-Signature
• Синхронная best-effort доставка с коротким тайм-аутом - медленный подписчик не блокирует API

🖼️ Загрузка изображений

• Эндпоинт для загрузки изображений через multipart/form-data
• Автоматическая сортировка в папки и подпапки image/catalog/
• Защита от path traversal
• Поддержка форматов jpg, jpeg, png, gif, webp

🏬 Мультимагазин

• Полная поддержка мультимагазинной конфигурации OpenCart
• Привязка товаров, категорий, производителей, страниц к конкретным магазинам
• Ресурс store для получения списка магазинов

🔒 Безопасность и контроль доступа

• HMAC-SHA256 подпись запросов - защита от подделки и повторного использования (replay-атак)
• Timestamp-валидация - отклонение от серверного времени не более ±300 секунд
• IP-whitelist - ограничение доступа по IP-адресам
• Rate limiting - настраиваемый лимит запросов в минуту для каждого API-ключа
• Гранулярные scopes (области доступа) - визуальная матрица ресурс × действие (Чтение / Создание / Обновление / Удаление) для каждого ключа
• Переключатель DELETE - отдельный контроль разрешения на удаление для каждого ключа
• Лицензионный ключ с привязкой к домену (с поддержкой www и поддоменов)

🛠️ Обход серверных ограничений (Method Override)

Если ваш хостинг блокирует HTTP-методы DELETE и PUT (типичная проблема на shared-хостинге), модуль поддерживает method override через POST с параметром &method=delete или &method=put. Подпись при этом не меняется - все проверки прав и scopes работают нативно.

📚 Документация и инструменты разработчика

• OpenAPI 3.0 спецификация - полный машиночитаемый документ (docs/openapi.json) и живой эндпоинт /spec
• Интерактивная справка Redoc - docs/api.html
• Готовая Postman-коллекция - 19 папок по ресурсам, ~68 запросов с автоматической HMAC-подписью через pre-request скрипт (CryptoJS)
• Чеклист тел запросов - все эндпоинты с готовыми JSON-телами для копирования
• Примеры на PHP, cURL, bash
• Унифицированные коды ответов: 200, 201, 400, 401, 403, 404, 405, 429
• Единый формат ошибок для удобного парсинга на клиенте

🎯 Кому подойдёт модуль

• Интернет-магазины на OpenCart 2.x, 3.x, ocStore, которым нужна автоматизация
• Разработчики мобильных приложений для iOS/Android к магазину
• Интеграторы с учётными системами - 1С, БАС, МойСклад, KeyCRM, RetailCRM
• Поставщики маркетплейсов - Rozetka, Prom.ua, Allo, Hotline, Wildberries, Ozon, Yandex Market
• Сервисы синхронизации остатков и прайс-агрегаторы
• Службы доставки - Новая Почта, СДЭК, Boxberry - для автоматического обновления статусов
• Разработчики PIM-систем и каталогизаторов
• CRM-интеграторы - Bitrix24, amoCRM, RetailCRM, Zoho
• BI-системы и аналитика - выгрузка данных для отчётов

💡 Примеры сценариев использования

1. Синхронизация каталога с ERP - ежечасное обновление остатков и цен через bulk-endpoint
2. Автоматический импорт заказов с маркетплейса - создание заказов через API с нативным запуском OpenCart-событий
3. Мобильное приложение магазина - полный функционал каталога, корзины и профиля покупателя
4. Автоматическое изменение статуса заказа - интеграция с ТМС Новой Почты для обновления при отправке
5. Импорт отзывов с маркетплейсов - регулярное подтягивание отзывов с Rozetka, Wildberries, Ozon
6. Реактивная CRM - вебхуки на order.add и customer.add для мгновенного создания сделки
7. Массовое обновление SEO URL - после изменения структуры каталога

⚙️ Технические требования

• OpenCart 2.x, 3.x (все минорные версии)
• ocStore 3.x
• PHP 7.4+ (совместимо с PHP 8.x)
• MySQL 5.6+ / MariaDB 10+
• Поддержка расширения OpenSSL для HMAC