required/1c-bitrix-exchange repository overview

⁠Инструмент для эмуляции обмена файлами 1С => Битрикс

Этот инструмент полностью эмулирует работу обмена файлами между 1С и Битрикс. Предусмотрены следующие способы обмена:

• Стандартный механизм обмена⁠ CommerceML - файлы import.xml и offers.xml
• Доработанный механизм обмена на основе стандартного⁠ - любые файлы, например JSON, CSV
• Получение необработанных заказов⁠
• Простая отправка данных POST запросом на свой обработчик в Битрикс⁠

Демонстрация стандартного обмена:

Минимальный пример запуска через Docker⁠:

docker  run -it --rm \
        -e SITE=http://site.ru \
        -e [email protected] \
        -e AUTH_PASS=password \
        -e FILE_NAME=offers.xml \
        -v $(pwd)/data/offers.xml:/src \
        required/1c-bitrix-exchange:latest

⁠Установка

⁠Из реестра Docker Hub

Чтобы получить образ из реестра Docker Hub⁠, откройте командную строку и введите:

docker pull required/1c-bitrix-exchange

⁠Из репозитория GitHub

Чтобы собрать образ из репозитория GitHub, введите в терминале:

git clone https://github.com/dbfun/1c-bitrix-exchange.git
docker build --tag required/1c-bitrix-exchange 1c-bitrix-exchange

⁠Конфигурация

⁠Описание параметров

⁠Файл конфигурации

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

В таком случае нужно скопировать .env.dist⁠ в .env и поправить в нем базовую конфигурацию (адрес сайта, логин-пароль, кодировку).

Тогда запуск обмена станет еще короче:

docker  run -it --rm \
        --env-file .env \
        -e FILE_NAME=offers.xml \
        -v $(pwd)/data/offers.xml:/src \
        required/1c-bitrix-exchange:latest

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

⁠Стандартный механизм обмена

Если файл для импорта находится в data/offers.xml, команда выглядит так:

docker  run -it --rm \
        --env-file .env \
        -e FILE_NAME=offers.xml \
        -e SITE=test.site.ru \
        --dns=10.0.1.1 \
        -v $(pwd)/data/offers.xml:/src \
        -v $(pwd)/log/:/var/log/ \
        required/1c-bitrix-exchange:latest

В этом расширенном примере (полужирным - обязательные настройки):

• --env-file .env - базовые настройки (также настройки можно передать через -e ПАРАМЕТР=значение)
• -e FILE_NAME=offers.xml - имя загружаемоего файла (будет передано в Битрикс как GET-параметр)
• -e SITE=test.site.ru - переопределен сайт, указанный в базовых настройках .env файла
• --dns=10.0.1.1 - указан собственный DNS (указывать в случае ошибки Could not resolve host для локальных сайтов)
• -v $(pwd)/data/offers.xml:/src - подмонтировать файл data/offers.xml в контейнер для импорта, имя файла может быть любым, но название для обмена нужно указать через FILE_NAME
• -v $(pwd)/log/:/var/log/ - подмонтировать каталог log/ в контейнер, в нем будут созданы логи обмена (полезно при отладке)

Полученные из файла данные будут загружены на сайт тем же путем, как это делает 1С.

⁠Доработанный механизм обмена на основе стандартного

Для импорта JSON, CSV и других типов файлов (в свои отдельные таблицы БД, например) нужно добавить свои кастомные обработчики в стандартный обмен. При этом сохранится стандартный механизм обмена, и появится возможность обработки произвольных файлов.

⁠1. Создать собственный компонент

Создадим собственный компонент обмена, для чего скопируем и доработаем стандартный bitrix:catalog.import.1c. Переходим в корень сайта и вводим:

mkdir -p local/components/vendor/
cp -r bitrix/components/bitrix/catalog.import.1c local/components/vendor/

Теперь следует поправить скопированный файл local/components/vendor/catalog.import.1c/component.php, сниппет с изменениями находится в файле этого репозитория: snippets/vendor:catalog.import.1c/component.php⁠.

При вызове можно указать в GET-параметре вместо стандартного режима mode=import другое значение, например mode=report, и использовать в качестве условия в собственном обработчике: if(($_GET["..."] == "report")) { /* свой обработчик */ }.

⁠2. Заменить стандартный компонент

В файле bitrix/admin/1c_exchange.php необходимо заменить стандартный компонент на собственный:

// заменить
$APPLICATION->IncludeComponent("bitrix:catalog.import.1c"
// на
$APPLICATION->IncludeComponent("vendor:catalog.import.1c"

⁠3. Запуск нового обмена

В docker run нужно использовать дополнительный параметр -e GET_STEP_MODE=custom_mode, где custom_mode - параметр, который будет передан в $_GET['mode']. Например, обмен отчетами report будет выглядеть так:

docker  run -it --rm \
        -e FILE_NAME=report.zip \
        -e ZIP=1 \
        -e GET_STEP_MODE=report \
        --env-file .env \
        -v $(pwd)/data/report.zip:/src \
        required/1c-bitrix-exchange:latest

⁠Получение необработанных заказов

Для получения необработанных заказов необходимо подмонтировать в /var/log/ каталог, в который будет записан файл с заказами 02-get-orders.xml.

docker  run -it --rm \
        --env-file .env \
        -v $(pwd)/log/:/var/log/ \
        required/1c-bitrix-exchange:latest \
        getorders

⁠Простая отправка данных POST запросом на свой обработчик в Битрикс

Простая отправка данных POST из файла на выделенный URI сайта. Дополнительные параметры:

Вариант использования:

docker  run -it --rm \
        -e URI="/lk/ws/orders/" \
        --env-file .env \
        -v $(pwd)/data/orders.json:/src \
        required/1c-bitrix-exchange:latest \
        post