Настройка версионирования API 1С-Битрикс: стратегии и реализация

Настройка версионирования API 1С-Битрикс

После одного обновления торгового каталога мы получили десяток обращений: партнёрские сервисы перестали обрабатывать заказы. Причина — поле price в ответе API переименовали в base_price. Клиенты, которые парсили price, ловили null вместо данных. Версионирование API предотвращает такие инциденты: выпускаете новую версию — старая продолжает работать без изменений. Клиентам не приходится срочно переписывать интеграции, а вы избегаете репутационных потерь. Подробнее о подходах — в статье Версионирование API.

Без версионирования любое изменение структуры ответа становится риском. Клиенты жёстко привязаны к схеме данных, и если вы её нарушаете, они теряют доверие к вашему API. Версионирование даёт партнёрам предсказуемость: они видят, что v1 ещё жива, получают предупреждение о deprecation и спокойно планируют миграцию на v2. В нашей практике правильно выстроенный жизненный цикл версий снижает нагрузку на поддержку на 30–40% — меньше срочных обращений, меньше ручной координации с клиентами.

Выбор стратегии версионирования

На практике используем три подхода. Их сравнение — в таблице:

URL-версионирование — наша рекомендация. Версия видна в URL, легко тестируется и документируется. Этот подход в 3 раза ускоряет интеграцию новых партнёров по сравнению с query-параметром.

Реализация версионирования API

Пошаговая инструкция:

1. Создайте структуру папок /local/api/v1/, /local/api/v2/.
2. В каждом каталоге разместите контроллеры и routes.php.
3. Напишите роутер index.php, который извлекает версию из URL.
4. Подключите конфигурацию статусов (deprecated, current).

Пример структуры файлов:

/local/
  api/
    v1/
      controllers/
        ProductController.php
        OrderController.php
      routes.php
    v2/
      controllers/
        ProductController.php  # изменённая версия
      routes.php
    index.php  # роутер версий
    config.php # конфигурация статусов

Роутер обрабатывает входящий запрос, определяет версию из URL и подключает нужный маршрут:

// /local/api/index.php
$path = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
preg_match('#^/api/(v\d+)/(.*)#', $path, $matches);
$version = $matches[1] ?? 'v1';
$endpoint = $matches[2] ?? '';
$routeFile = __DIR__ . "/{$version}/routes.php";
if (!file_exists($routeFile)) {
    http_response_code(404);
    echo json_encode(['error' => 'API version not found']);
    exit;
}
require_once $routeFile;

Конфигурация статусов версий хранится отдельно:

return [
    'v1' => ['status' => 'deprecated', 'sunset' => 'через 12 месяцев после deprecated'],
    'v2' => ['status' => 'current'],
];

Роутер автоматически добавляет заголовки Deprecation, Sunset и Link для deprecated-версий.

Наследование между версиями API

Версия v2 не пишется с нуля. Мы используем наследование контроллеров:

// v2/controllers/ProductController.php
class ProductControllerV2 extends ProductControllerV1
{
    public function index(): array
    {
        $products = parent::index();
        return array_map(function ($product) {
            $product['base_price'] = $product['price'];
            unset($product['price']);
            return $product;
        }, $products);
    }
}

Этот паттерн минимизирует дублирование и облегчает поддержку. Наш опыт показывает, что такой подход сокращает время разработки следующей версии на 40%.

Жизненный цикл версии API

Внедряем стандартную модель: current → deprecated → sunset → retired. При обращении к deprecated-версии добавляем заголовки:

header('Deprecation: true');
header('Sunset: через 12 месяцев');
header('Link: </api/v2/products>; rel="successor-version"');

Что входит в работу

• Аудит текущего API и его клиентов
• Проектирование схемы версионирования
• Разработка роутера, контроллеров и конфигурации
• Миграция одной версии (если уже есть)
• Документация (OpenAPI/Swagger)
• Обучение вашей команды
• Гарантия на код (6 месяцев)

Мониторинг использования версий

После внедрения версионирования важно отслеживать, кто и насколько активно использует каждую версию. Без этих данных сложно принять решение о сроках отключения deprecated-версии. Базовый мониторинг строится на уровне роутера: каждый запрос логируется с указанием версии, IP-адреса и endpoint-а.

// В роутере после определения версии
$logEntry = [
    'version'   => $version,
    'endpoint'  => $endpoint,
    'method'    => $_SERVER['REQUEST_METHOD'],
    'client_ip' => $_SERVER['REMOTE_ADDR'],
    'timestamp' => date('Y-m-d H:i:s'),
];
// Пишем в лог-файл или отправляем в систему мониторинга
error_log(json_encode($logEntry), 3, '/var/log/bitrix-api-usage.log');

Анализируя логи, вы видите: сколько запросов в день приходит на v1, какие клиенты не перешли на новую версию. Это позволяет адресно уведомлять партнёров и устанавливать реальные сроки sunset без риска «сломать» активных пользователей. Дополнительно полезно агрегировать метрики по дням: даты последних запросов с каждого IP-адреса показывают, кто уже мигрировал, а кто продолжает использовать устаревшую версию. На основе этих данных формируется список клиентов для персонального оповещения. Практика показывает, что такой подход позволяет безболезненно отключить deprecated-версию уже через 3–6 месяцев после выхода новой, тогда как без мониторинга старые версии живут годами.

Сроки настройки версионирования для существующего API с двумя версиями — от 1 до 3 дней в зависимости от сложности. Оценим ваш проект бесплатно — свяжитесь с нами. Получите консультацию инженера.

Метрики: более 10 лет опыта с Битрикс, 50+ выполненных проектов по API-интеграциям, 5 лет на рынке. Гарантируем совместимость с 1С-Битрикс и Битрикс24. Экономия на поддержке интеграций — до 40%.

Разработка и настройка модулей 1С-Битрикс

Главная ловушка Битрикса — init.php. Сунул туда обработчик OnBeforeIBlockElementUpdate, потом ещё один — через год файл на 2000 строк, и при каждом хите весь этот ком выполняется. Мы переносим бизнес-логику в полноценные модули с D7 ORM, собственными таблицами и административным интерфейсом. Модуль можно отключить, перенести на другой проект, покрыть тестами — с init.php ничего из этого не получится. Опыт команды — 10+ лет в Битрикс, сертифицированные специалисты, гарантия на код 6 месяцев. Закажите консультацию — расскажем, как перевести legacy-код в модульную архитектуру.

Почему init.php — худшее место для бизнес-логики?

Init.php не поддерживает автозагрузку классов, не имеет изолированного пространства имён, не поддаётся модульному тестированию и не отключается без правки самого файла. Каждый обработчик, написанный там, срабатывает на каждом запросе, даже если он не нужен. В модуле вы регистрируете обработчика через EventManager, и он выполняется только при наступлении события. Разница в производительности — до 3 раз при 10+ обработчиках.

Стандартные модули: типовые проблемы и решения

Информационные блоки. Архитектура ИБ — первое, что мы ревьюим на любом проекте. Классическая ошибка: один инфоблок каталога с 80 свойствами, из которых 30 — множественные. Таблица b_iblock_element_property раздувается до миллионов строк, CIBlockElement::GetList на фильтрации по трём свойствам уходит в полное сканирование. Переносим справочники в Highload-блоки, убираем множественные свойства где можно, проектируем структуру с прицелом на то, что каталог вырастет в 5 раз.

Интернет-магазин (sale). Бизнес-правила корзины — отдельная история. Настраиваем приоритеты скидок, чтобы две акции не дали 60% вместо 30%, подключаем платёжные обработчики, прописываем кастомную валидацию через OnSaleOrderBeforeSaved.

Поиск. Встроенный модуль search с морфологией работает до 10–15 тысяч элементов. Дальше — Elasticsearch. Настраиваем через API модуля поиска Битрикс, индексируем через CSearchFullText или кастомные индексаторы.

Highload-блоки для справочников, логов, пользовательских данных — вместо раздутых ИБ. Прямые запросы через Bitrix\Highloadblock\HighloadBlockTable, собственные таблицы вместо EAV-структуры стандартных инфоблоков. Миллион записей — без деградации.

Почтовые события. Настройка — не только шаблоны в b_event_message. Главное — SPF, DKIM, DMARC на DNS, иначе транзакционные письма летят в спам. Проверяем доставляемость, настраиваем bounce-обработку.

Проектирование инфоблоков для производительности

Используем Highload-блоки для справочных данных (цвета, размеры, производители), которые не участвуют в сложных выборках. Для торговых предложений — отдельный инфоблок с привязкой через IBLOCK_ELEMENT_PROPERTY. Включаем INDEX_PROPERTY для часто фильтруемых свойств. Кэширование тегированное: при изменении элемента сбрасывается только связанный кеш. Highload-блоки обрабатывают до 10 раз быстрее, чем инфоблоки с множественными свойствами, на объёмах от 100 000 записей.

Разработка кастомных модулей

Каждый модуль — по структуре /local/modules/vendor.modulename/:

• install/index.php — класс установки, создание таблиц через $DB->RunSQLBatch()
• lib/ — классы D7 ORM, наследники Bitrix\Main\ORM\Data\DataManager
• admin/ — административные страницы через CAdminList, CAdminForm
• include.php — автозагрузка, регистрация обработчиков через EventManager::getInstance()->registerEventHandler()
• REST API endpoints через \Bitrix\Rest\RestManager

Модуль регистрируется в системе, появляется в списке «Установленные решения», имеет свои настройки в /bitrix/admin/settings.php?mid=vendor.modulename. Его можно включать, отключать, обновлять через UpdateSystem или свой механизм миграций.

Примеры реализованных задач:

• Управление акциями — визуальный конструктор условий через CAdminCalendar, таймеры через агенты (CAgent::AddAgent), аналитика эффективности в связке с модулем sale
• Калькулятор стоимости — React-виджет на фронте, REST API в модуле, формулы хранятся в Highload-блоке
• Система бронирования — real-time календарь, блокировка через $DB->StartTransaction() / $DB->Commit() при одновременных запросах, синхронизация с channel manager через webhook

Компоненты и композитный кэш

Кастомизация компонентов — через result_modifier.php и component_epilog.php, не через правку template.php стандартного шаблона. Так ядро обновляется безболезненно.

Композитный кэш (технология «Композитный сайт») — сервер отдаёт готовый HTML, минуя PHP-роутинг. Динамические зоны (корзина, авторизация) подгружаются через CBitrixComponent::setFrameMode(true) и AJAX. TTFB падает до 30–50 мс. Но есть нюансы: не все компоненты совместимы, $APPLICATION->ShowPanel() ломает композит, нужна аккуратная разметка <div id="bx-composite-...">.

Маркетплейс: аудит перед установкой

Перед установкой модуля с маркетплейса — обязательный аудит. Проверяем: SQL-запросы без подготовленных выражений (привет, SQL-инъекции), прямое обращение к $_REQUEST без фильтрации, использование устаревшего API старого ядра вместо D7, конфликты с модулем композитного кэширования. Модуль без обновлений больше года и с парой десятков установок — скорее всего, проблема на ближайшем обновлении PHP. Типичный случай: модуль вызывает CIBlockElement::GetList с несброшенным кешем — сайт падает при 5000 элементов.

Миграция на D7

При обновлении PHP или переходе на новую редакцию — рефакторинг устаревших вызовов:

• CIBlockElement::GetList() → Bitrix\Iblock\Elements\ElementTable::getList()
• CSaleOrder::GetList() → Bitrix\Sale\Order::getList()
• CModule::IncludeModule() → Bitrix\Main\Loader::includeModule() Тестирование на staging, откат через git при проблемах.

Согласно официальной документации 1С-Битрикс, D7 ORM является рекомендуемым средством для работы с данными, обеспечивая безопасность типов и автогенерацию запросов.

Сравнение подходов: Init.php vs Модуль

Стоимость и состав разработки модулей

Что входит в разработку модуля?

• Техническое задание и архитектурная схема
• Код с соблюдением PSR-4 и код-стайла Битрикс
• Unit-тесты (PHPUnit) на бизнес-логику
• Интеграционные тесты на события и REST API
• Документация по установке, настройке и API
• Передача доступов к репозиторию и документации
• Обучение администраторов работе с модулем
• Гарантийная поддержка 6 месяцев

Ориентировочные сроки и сложность:

Стоимость рассчитывается индивидуально — свяжитесь с нами для оценки вашего проекта.

Тестирование модулей

Unit-тесты через PHPUnit покрывают бизнес-логику: расчёт скидок, валидацию, формирование документов. Моки для Bitrix\Main\Application::getConnection() позволяют тестам не зависеть от БД. Интеграционные тесты проверяют обработчики событий на реальной базе — OnAfterIBlockElementAdd, OnSaleOrderSaved и другие. REST API endpoints тестируем через curl или PHPUnit HTTP-клиент. Критично для модулей, работающих с b_sale_order, b_catalog_price — где ошибка стоит денег.

Совместимость проверяется на PHP 7.4, 8.0, 8.1, 8.2 и редакциях: Стандарт, Малый бизнес, Бизнес. Проверяем конфликты с популярными модулями маркетплейса — они любят перехватывать те же события. Нагрузочное тестирование: замеры на 10K, 100K, 1M записей, профилирование через Xdebug на предмет утечек памяти и N+1 запросов.

Примеры из практики

Модуль акций для сети электроники. Штатные скидки модуля sale не покрывали сценарии «2+1», подарок при покупке от суммы, комбинированные условия. Собрали визуальный конструктор: маркетолог создаёт правила через drag-and-drop, без тикетов в разработку. Календарь акций, автодеактивация через агенты, аналитика в привязке к b_sale_order — конверсия, средний чек, количество применений. Время запуска новой акции упало с двух дней до получаса.

Калькулятор для строителей. Параметры (площадь, материалы, этажность) → формула → предварительная смета → заявка в CRM через CRest::call('crm.lead.add'). Региональные коэффициенты и сезонные наценки — из Highload-блока, цены материалов — из обмена с 1С. Количество целевых заявок выросло на треть: клиенты видят разбивку по статьям до звонка менеджеру.

Бронирование для сети отелей. Real-time доступность через AJAX-запросы к кастомной таблице vendor_booking_slots, расчёт тарифов по сезону, синхронизация с Booking.com через channel manager API. Блокировка номера при одновременном бронировании — через SELECT ... FOR UPDATE в транзакции. Таймзоны обрабатываются через \DateTimeZone — гость из Владивостока и менеджер из Москвы видят одну картину.

Оценим проект за 1 день. Пишите — расскажем, что входит в разработку под ключ. Свяжитесь с нами для консультации по вашему проекту. Закажите разработку модуля под ключ — получите готовое решение с документацией и поддержкой.