Изучение API REST в OpenCart 2.0: часть 1
От автора: в новой крупной версии OpenCart множество интересных функций, начиная от полностью отзывчивого дизайна во front-end and back-end и заканчивая системой уведомлений о событиях. Одной из самых сильных функций среди них является внедрение REST API.
В этой серии из двух частей мы рассмотрим большинство доступных в OpenCart API и процесс создания заказов с их помощью. В первой части мы узнаем, как создать учетные данные пользователя API и некоторые из основных возможностей API.
API REST позволяет сторонним системам беспрепятственно взаимодействовать с магазином OpenCart. Что же насчёт размещения заказов в вашем магазине с помощью приложения iOS / Android? Фактически, вы могли бы думать о любой системе независимо от технологии, на которой она построена! Теперь интеграция возможна с набором API, предоставляемым OpenCart 2.0.
В этой части я продемонстрирую использование API-интерфейсов, используя библиотеку PHP cURL. Итак, для запуска примеров нам понадобится эта библиотека. Очевидно, нужна последняя версия OpenCart равная 2.0!
Создание пользовательских учетных данных API
Прежде чем мы начнем использовать API, для этого нам нужно настроить «API User». Без этого мы не сможем получить к нему доступ, и получим отказ в разрешении. Итак, давайте сделаем это. Перейдите в System> Users> API, там будут перечислены все пользователи API.
Профессия PHP-разработчик с нуля до PRO
Готовим PHP-разработчиков с нуля
Вы с нуля научитесь программировать сайты и веб-приложения на PHP, освоите фреймворк Laravel, напишете облачное хранилище и поработаете над интернет-магазином в команде. Сможете устроиться на позицию Junior-разработчика.
Нажмите + в правом верхнем углу, чтобы добавить нового пользователя API.
Как вы можете видеть, нужно ввести имя пользователя, пароль и статус. Также можно использовать кнопку Generate, чтобы создать сложную строку пароля, как я уже сделал! Кроме того, убедитесь, что для параметра Status установлено значение Enabled. Сохраните изменения, и всё отлично!
Теперь, когда мы настроили пользователя API, мы можем начать изучение!
Настройка общих файлов
В этой серии мы увидим основные основные примеры PHP. Давайте сделаем так, чтобы мы установили файл, который содержит общий код, и избежали дублирования!
Создайте файл common.php и вставьте следующее содержимое.
Работа с заказом через админку OpenCart, взгляд изнутри
Разрабатывая модуль для OpenCart, мне понадобилось добавить дополнительное поле к товарам заказа. Но прежде необходимо изучить как устроена работа с заказом через админку. Как оказалась схема не простая и немного запутанная, но это с первого взгляда.
Данные о товарах заказа хранятся в таблице order_product , где товары с заказами связаны по id ( order_id , product_id ). К слову информация о заказе хранится в нескольких таблицах order_ .
Интерфейс
Перейдем в админке «Продажи-Заказы» и выберем любой заказ на редактирование.
Страница редактирования заказа состоит из 5 вкладок, в каждую из которых можно попасть только из предыдущей (нажимая кнопку «Продолжить»), при этом при переходе на некоторые вкладки происходят ajax запросы, на основании ответов которых происходит заполнение вкладки.
Если js в браузере отключен — редактирование заказа будет недоступно. Попасть на произвольную вкладку нельзя.
Перейдем в admin/view/teplate/sale/order_form.tpl (OpenCart 2.3). Здесь можно увидеть что изначально весь интерфейс статический, однако при переходе на вкладку «Товары» (клик по #button-customer внутри генерирует клик #button-refresh где и происходит изменение интерфейса) следует серия ajax запросов, в результате которых на вкладке меняется интерфейс.
Интерактивный интерфейс строится посредством javascript.
Изменение заказа
Перейдем на вкладку «Товары».
При попытке изменить количество позиции посылается ajax запрос с route=api/cart/add . В файле catalog/controller/api/cart.php в методе add используется объект $this->cart класса Cart (корзина), а именно его метод add . Если взглянуть на код метода, то не трудно понять что новые данные о товарах записываются в таблицу cart , но нигде нет записи в таблицы order_ .
В таблице cart есть столбец session_id , значение которого привязывается к текущему юзеру, и является ключом данных в массиве $_SESSION . То есть данные в таблице cart временные и существуют только на период существования сессии юзера.
Подробнее о том что здесь вообще происходит, можно прочитав предыдущие статьи про ajax запросы в OpenCart и про один из способов решения проблемы с доступом к API OpenCart.
Работа с заказом через админку осуществляется через корзину — данные сохраняются в корзину (таблица cart ), но не сохраняются в данные заказа (таблицы order_ )
Сохранение изменений заказа
На странице редактирования заказа перейдем в последнюю вкладку «Итого», пролистаем вниз и нажмем кнопку «Сохранить».
Просматривая консоль браузера можно увидеть запрос route=api/order/edit . Переходим в catalog/controller/api/order.php и смотрим немаленький метод edit , где заполняется массив order_data данными заказа ( $this->cart->getProducts() ).
Небольшой кусок кода, показывающий что данные о товарах заказа берутся из корзины:
// Products $order_data['products'] = array(); foreach ($this->cart->getProducts() as $product) < $option_data = array(); //. $order_data['products'][] = array( 'product_id' =>$product['product_id'], 'name' => $product['name'], 'model' => $product['model'], 'option' => $option_data, 'download' => $product['download'], 'quantity' => $product['quantity'], 'subtract' => $product['subtract'], 'price' => $product['price'], 'total' => $product['total'], 'tax' => $this->tax->getTax($product['price'], $product['tax_class_id']), 'reward' => $product['reward'] ); >Почти в конце метода есть сохранение изменений через модель checkout/order в таблицу order_product :
$this->model_checkout_order->editOrder($order_id, $order_data);А еще ниже в этом методе есть добавление истории заказа:
$this->model_checkout_order->addOrderHistory($order_id, $order_status_id);На этом можно было бы остановится . но дальше будет интереснее 🙂
Посмотрим таблицу товаров заказа order_product :
А теперь взглянем на таблицу корзины cart где хранятся данные редактируемого заказа:
Становится безумно интересно, как данные из корзины ( cart ), сопоставляются с данными в заказе ( order )? Ведь просматривая таблицу корзины и товаров заказа между ними не видно никакой связи. Более того нет никакой связи между товарами этих двух таблиц!
На самом деле все просто, запрос сохранения заказа api/order/edit передает:
А теперь посмотрим внутрь модели checkout/order в метод editOrder и увидим там следующее:
$this->db->query("DELETE FROM " . DB_PREFIX . "order_product WHERE order_id = '" . (int)$order_id . "'"); $this->db->query("DELETE FROM " . DB_PREFIX . "order_option WHERE order_id = '" . (int)$order_id . "'");Нет никакого сопоставления товаров из корзины с товарами из заказа: данные из заказа удаляются и записываются новые данные из корзины.
Дерзко, резко, быстро понятно, но неудобно для добавления дополнительных полей в заказ.
Кстати, OpenCart занимает лидирующее место среди eCommerce на рынке России по мнению BuiltWith. Значит решение вполне годное и нам разработчикам остается лишь придумывать как с этим жить 🙂
Сохранение изменений заказа через админку осуществляется на основании данных корзины редактирования заказа, а корзина привязывается к сессии текущего администратора.
Итог
Схема не совсем очевидная, с первого взгляда может показаться запутанной. Однако, при детальном изучении становится понятна концепция, суть которой простота управления данными. Не могу сказать что мне такое решение нравится, но ясно то, что оно вполне рабочее.