Налаштування версіонування API 1С-Бітрікс: стратегії та реалізація

Налаштування версіонування API 1С-Бітрікс

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

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

Чи варто використовувати URL-версіонування замість заголовків?

URL-версіонування — наша рекомендація. Воно в 3 рази пришвидшує інтеграцію нових партнерів порівняно з query-параметром, а вартість розробки на 20% нижча, ніж при версіонуванні через заголовки. На практиці використовуємо три підходи. Їх порівняння — у таблиці:

Реалізація версіонування 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-версій.

Як успадкування версій скорочує час розробки?

Версія v2 не пишеться з нуля. Ми використовуємо успадкування контролерів — це скорочує час розробки нової версії на 40% порівняно з повним переписуванням:

// 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);
    }
}

Цей патерн мінімізує дублювання та полегшує підтримку.

Життєвий цикл версії API

Впроваджуємо стандартну модель: current → deprecated → sunset → retired. При зверненні до deprecated-версії додаємо заголовки:

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

Що входить у роботу

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

Вартість базового налаштування — від 5 000 грн, комплексний пакет з аудитом та міграцією — від 15 000 грн.

Моніторинг використання версій

Після впровадження версіонування важливо відстежувати, хто і наскільки активно використовує кожну версію. Без цих даних складно прийняти рішення про терміни відключення 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 день. Пишіть — розповімо, що входить у розробку під ключ. Зв'яжіться з нами для консультації за вашим проєктом. Замовте розробку модуля під ключ — отримайте готове рішення з документацією та підтримкою.