OC API

OC API - универсальное решение для работы с интернет магазином на платформе OpenCart 3.х реализованное в виде модуля. API построен на REST-принципах, работает с реальными объектами и обладает предсказуемым поведением. С помощью этого API вы сможете проходить весь цикл покупки товара, от поиска до оформления и многое другое. Так же при использовании данного решения появится возможность на его основе создавать мобильное приложение для вашего интернет магазина. 

API в качестве основного протокола использует HTTP, а значит, подходит для разработки на любом языке программирования, который умеет работать с HTTP-библиотеками (cURL и другими). API поддерживает POST и GET-запросы. API всегда возвращает ответ в формате JSON, независимо от типа запроса.

Вдобавок к модулю сделал документацию. Она построена на фреймворке Swagger (OpenApi 3.0), Ознакомиться с ней можно тут или для тех кто любит потемнее тут. Документация далека от идеала, но это и неудивительно ведь это только BETA. В дальнейшем по мере возможности буду с ней работать. Все изменения будут отражены вкладке обновления или на сайте модуля. Да кстати! Для модуля сделал не большой одностраничник на котором можно также ознакомиться  с документацией, порядком установки и настройки.

Установки:

1. Создаем резервную копию вашего сайта. Важно!!! Скачиваем и распаковываем архив.

2. После распаковки находим архив с именем ocapi.ocmod.zip. Его устанавливаем через панель администратора на вашем сайте. Панель администратора -> Дополнения -> Установка. Обновляем модификаторы.

3. Находим файл .htaccess.txt. Открываем в любом удобном для вас блокноте. Копируем все содержимое. В корневой директории вашего сайта находим файл .htaccess. Открываем, находим строку RewriteBase / и вставляем все содержимое из файла .htaccess.txt после неё и сохраняем.

Настройка:

1. Находим модуль OC API и устанавливаем.

2. В настройнах, во вкладке "Основные" переводим переключатель поля "Статус" в положение Включено.

3. Во вкладке "Приложения", добавляем новое.

4. Во вкладке "Основные" вписываем "ID приложения", например "ios_app", генерируем "Ключ приложения" и переводим переключатель поля "Статус" в положение Включено.

5. Во вкладке "IP и Hosts", добавляем "IP" и/или "Host" с которого ваше приложение будет отправлять запросы. Например: "IP:127.0.0.1, Host: http://localhost:3001". Сохраняем.

Aутентификации:

Для аутентификации запросов необходимо использовать API Key. Вам потребуется "Ключ приложения" и "ID приложения" из настроек модуля в панели администратора. Во всех заголовках запросов в качестве App-Id, необходимо передать идентификатор вашего приложения (ID приложения) , в качестве Api-Key — ваш секретный ключ (Ключ приложения).

P.S. Жду конструктивной критики, замечаний и предложений по улучшению.