Использование плагина ECommPay для CMS osCommerce

В данной инструкции описана работа с плагином ECommPay версии 1.0. Этот плагин позволяет использовать платёжные решения ECommPay на сайтах, созданных на базе CMS osCommerce версии 2.3 или выше. Требуемая версия PHP для CMS osCommerce — 5.6 или выше.

Скачать плагин ECommPay можно здесь.

Схема работы

Взаимодействие с платёжными решениями ECommPay осуществляется через платёжную страницу.

Рис.: Схема проведения платежей с использованием плагина

Запросы на открытие платёжной страницы формируются автоматически (с помощью плагина) при выборе ECommPay в методах оплаты.

Если по какой-либо причине платёж не прошёл, у пользователя есть возможность повторно ввести данные на платёжной странице.

По результатам проведения платежей на сайт отправляются оповещения, которые также автоматически обрабатываются с помощью плагина. В соответствии с результатом платежа изменяется статус заказа:

  • Pending — платёж не прошёл,
  • Processing — платёж прошёл.

Подключение

Для подключения плагина необходимо перенести файлы плагина в корень проекта в папку public_html. После подключения плагин должен отображаться в списке плагинов на вкладке Modules > Payment.



Тестирование

По умолчанию при активации плагина используется тестовый режим. Этот режим позволяет ознакомиться с работой плагина на сайте, к которому он подключён, без проведения реальных операций. В тестовом режиме можно настраивать и проверять работу плагина, проводить тестовые заказы и просматривать информацию по ним.

Настройка

Для настройки параметров работы плагина в тестовом режиме необходимо:

  1. Перейти на вкладку Modules > Payment.
  2. Выбрать в списке ECommPay и щёлкнуть кнопку Edit.


  3. Задать необходимые настройки (см. далее).
  4. Убедиться, что в поле Test mode выбрано True.
  5. Щёлкнуть кнопку Save.

Параметры работы плагина включают в себя:

  • Поле Status — для отображения метода оплаты с помощью платёжной страницы ECommPay на сайте.
  • Параметры работы платёжной страницы ECommPay при её отображении:
    • Popup mode — способ отображения платёжной страницы: во всплывающем окне или в той же вкладке.
    • Additional parameters — дополнительные параметры работы платёжной страницы.

      Список этих параметров доступен здесь. При задании нескольких параметров их необходимо записывать с разделителем «&».

    • Sort Order — номер в списке платёжных методов на сайте.
  • Другие параметры работы плагина:
    • Payment Zone — регионы, для которых доступен данный платёжный метод.
    • Set Order Status — статус заказа при успешном прохождении платежа.
  • Параметры Project ID и Secret key для подключения к платёжным решениям ECommPay.

    В тестовом режиме эти параметры не используются.

Проведение тестовых заказов

После настройки параметров работы плагина следует провести тестовые заказы на сайте и проверить информацию по этим заказам в osCommerce, на вкладке Orders.

Прим.: В тестовом режиме для изменения статуса заказа с Pending на Processing после совершения платежа необходимо щёлкнуть кнопку Вернуться на сайт. В противном случае заказ остаётся со статусом Pending.

Запуск

После проверки работы плагина с использованием всех планируемых способов оплаты его можно переводить в рабочий режим. Для этого необходимо получить рабочие параметры и скорректировать настройки.

Получение рабочих параметров

Для получения параметров подключения к платёжным решениям ECommPay необходимо:

  1. Связаться со службой технической поддержки ECommPay и сообщить следующие параметры:
    • название и URL сайта,
    • валюту платёжной страницы,
    • URL для приёма оповещений (URL, указанный в настройках, в разделе Payment).


  2. Получить от службы технической поддержки ECommPay значения следующих параметров:
    • Project ID — идентификатор сайта.
    • Secret key — секретный ключ, который генерируется для конкретного мерчанта на стороне ECommPay.

Задание рабочих настроек

Для задания рабочих настроек необходимо:

  1. Открыть osCommerce.
  2. Перейти на вкладку Modules > Payment.
  3. Выбрать в списке ECommPay и щёлкнуть кнопку Edit.
  4. Задать рабочие настройки:
    • Убедиться, что в поле Status выбрано True.
    • Выбрать False в поле Test mode.
    • Заполнить поля Project ID и Secret key в соответствии со значениями, полученными от службы технической поддержки ECommPay.
    • Убедиться, что для остальных параметров заданы необходимые значения.
  5. Щёлкнуть кнопку Save.

Использование

После запуска плагина он работает автономно.

Мы рекомендуем контролировать проведение заказов на вкладке Orders, а также следить, чтобы номера заказов были уникальными в рамках сайта. При дублировании номера заказа платёжная страница не открывается и заказ остаётся со статусом Pending.

Если после запуска плагина появляется необходимость переключить его в тестовый режим, следует обратить внимание на отображение метода оплаты на сайте. При выборе True в полях Test mode и Status метод оплаты с помощью платёжной страницы ECommPay отображается на сайте, но все платежи проводятся как тестовые.

Перед переводом плагина обратно в рабочий режим, необходимо убедиться, что поля Project ID и Secret key заполнены в соответствии со значениями, полученными от службы технической поддержки ECommPay.

При возникновении вопросов по работе плагина следует обращаться в службу технической поддержки ECommPay support@ecommpay.com.