Использование плагина ecommpay для CMS «1С-Битрикс»

В данной инструкции описана работа с плагином ecommpay версии 1.0. Этот плагин позволяет использовать платёжные решения ecommpay на сайтах, созданных на базе CMS «1С-Битрикс» в редакциях «Малый бизнес», «Бизнес» и «Энтерпрайз».

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

Схема работы

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

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

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

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

По результатам проведения платежей на сайт отправляются оповещения, которые также автоматически обрабатываются с помощью плагина. В соответствии с результатом платежа изменяется статус заказа. Соответствие результата платежа и статуса заказа устанавливается в настройках CMS «1С-Битрикс».

Подключение

Для подключения плагина необходимо выполнить следующие действия:
  1. Загрузить файл с плагином ecommpay.
  2. Открыть CMS «1С-Битрикс».
  3. Перейти на вкладку Контент > Структура сайта > Файлы и папки
  4. Добавить подпапку ecommpay в папку bitrix/modules.
  5. Перейти на вкладку Настройки > Модули.
  6. Щёлкнуть Установить напротив ecommpay.

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



Приём оповещений

Автоматическое изменение платёжного статуса заказа обеспечивается с помощью приёма оповещений от ecommpay. Для получение оповещений необходимо:
  1. Добавить файл формата php в раздел Контент > Структура сайта > Файлы и папки.


    Файл должен содержать следующий программный код:
    <? $APPLICATION->IncludeComponent(
    "bitrix:sale.order.payment.receive",
    "",
    Array(
        "PAY_SYSTEM_ID_NEW" => "22"
    )
);
?>
    Значение параметра PAY_SYSTEM_ID_NEW — это значение идентификатора платёжной системы ecommpay. Идентификатор можно найти на вкладке Магазин > Настройки > Платежные системы в столбце ID.


  2. Сообщить URL для приёма оповещений службе технической поддержки ecommpay (на этапе перевода плагина в рабочий режим).

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

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

Настройка

Для настройки параметров работы плагина в тестовом режиме необходимо:
  1. На вкладке Настройка > Модули проверить, что статус модуля — Установлен.
  2. Перейти на вкладку Магазин > Настройки > Платежные системы.
  3. Выбрать в списке ecommpay и щёлкнуть Изменить.

  4. Задать необходимые настройки в секции (см. далее).
  5. Выбрать Да в поле Тестовый режим.
  6. Щёлкнуть Сохранить.
Параметры работы плагина могут настраиваться по умолчанию для всех типов плательщиков или отдельно для каждого типа плательщиков. Параметры работы включают в себя:
  • Параметры работы платёжной страницы ecommpay при её отображении:
    • Поле Активность — для отображения платёжного метода в списке доступных.
    • Поле Описание — для задания описания платёжного метода.
    • Поле Логотип — для загрузки логотипа платёжной системы.

    • Поля Открывать в новом окне и Модальное окно — для выбора режима отображения платёжной страницы. Возможны три режима отображения: встраивание платёжной страницы в веб-страницу (iframe), открытие в модальном окне и открытие в отдельной вкладке браузера.

      Для встраивания платёжной страницы в веб-страницу необходимо снять флажок в поле Открывать в новом окне выбрать Нет в поле Модальное окно.

      Для открытия платёжной страницы в модальном окне необходимо снять флажок в поле Открывать в новом окне выбрать Да в поле Модальное окно.

      Для открытия платёжной страницы в отдельной вкладке браузера необходимо установить флажок в поле Открывать в новом окне выбрать Нет в поле Модальное окно.

    • Поле Отображать страницу выбора способа оплаты — для настройки отображения страницы выбора платёжного метода перед переходом к оплате.
    • Поле Дополнительные параметры — дополнительные параметры работы платёжной страницы.

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

    • Поле Язык платежного терминала — для настройки языка платёжной страницы. При заполнении этого поля необходимо выбрать Значение и использовать код языка в соответствии с ISO 639-1 alpha-2.
  • Поля ID проекта и Секретная соль проекта — для подключения к платёжным решениям ecommpay.

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



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

После настройки параметров работы плагина следует провести тестовые заказы на сайте и проверить информацию по этим заказам в «1С-Битрикс», на вкладке Магазин > Заказы.

Запуск

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

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

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

  1. Связаться со службой технической поддержки ecommpay и сообщить следующие параметры:
    • название и URL сайта,
    • валюту платёжной страницы,
    • URL для приёма оповещений.
  2. Получить от службы технической поддержки ecommpay значения следующих параметров:
    • ID проекта — идентификатор проекта на стороне ecommpay,
    • Секретная соль проекта — секретный ключ, который генерируется для конкретного мерчанта на стороне ecommpay.

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

Для задания рабочих настроек необходимо:
  1. Открыть CMS «1С-Битрикс».
  2. Перейти на вкладку Магазин > Настройки > Платежные системы.
  3. Выбрать в списке ecommpay и щёлкнуть Изменить.
  4. Задать рабочие настройки:
    • Убедиться, что в поле Активность установлен флажок.
    • Выбрать Нет в поле Тестовый режим.
    • Заполнить поля Секретная соль проекта и ID проекта в соответствии со значениями, полученными от службы технической поддержки ecommpay.
    • Убедиться, что для остальных параметров заданы необходимые значения.
  5. Щёлкнуть Сохранить.

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

После запуска плагин работает самостоятельно и дополнительной настройки не требует.

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

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

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

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