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

Чому Postman-колекція обов'язкова для API Бітрікс

Розробник CusDev стикається з десятками ендпоінтів — обмін товарами 1С, створення лідів, обробка замовлень. Без готових запитів кожен тест перетворюється на копіювання cURL із документації. Ми налаштовуємо Postman-колекцію так, що один клік — і API відповідає. Наш досвід роботи з Бітрікс — понад 10 років, 50+ проєктів, гарантія якості.

Postman-колекція для 1С-Бітрікс — це не просто набір HTTP-запитів, а повноцінний інструмент автоматизації тестування та документування API. Вона включає автоматичну авторизацію, змінні оточення для різних стендів, тести на статус і структуру відповіді. З такою колекцією регресійне тестування з 20 ендпоінтів займає 1–2 хвилини замість 30–60 хвилин ручної праці. Економія часу на кожному циклі — до 20 годин на місяць.

Проблеми, які вирішує колекція

• Відсутність документації. Бітрікс-розробники часто покладаються на усні домовленості. Колекція стає єдиним джерелом правди.
• Помилки авторизації. JWT-токени протухають, ключі API плутаються. Автоматизація в Pre-request Script виключає людський фактор.
• Довгий регрес. Після кожного оновлення потрібно перевіряти всі ендпоїнти. Collection Runner і Newman роблять це за хвилини.

Як автоматизувати авторизацію в Postman?

Під час роботи з JWT-авторизацією token потрібно отримувати та підставляти в кожен запит. У Postman це вирішується через Pre-request Script у запиті логіна:

pm.sendRequest({
    url: pm.environment.get('base_url') + '/api/v1/auth/login',
    method: 'POST',
    header: { 'Content-Type': 'application/json' },
    body: {
        mode: 'raw',
        raw: JSON.stringify({
            login: pm.environment.get('api_login'),
            password: pm.environment.get('api_password')
        })
    }
}, function(err, res) {
    if (!err) {
        pm.environment.set('token', res.json().token);
    }
});

Для решти запитів у розділі Authorization → Bearer Token: {{token}}. Або налаштувати авторизацію на рівні колекції — тоді всі запити успадковують її. Це скорочує час налаштування кожного запиту з 5 хвилин до 10 секунд — у 30 разів швидше.

Що входить у налаштування колекції

• Проектування структури колекції (групи ендпоінтів: Auth, Catalog, Orders, CRM)
• Створення змінних оточення для dev/stage/prod
• Налаштування Pre-request Script для автоматичної авторизації
• Додавання тестів для кожного запиту (статус, структура відповіді, обов'язкові поля)
• Експорт колекції в JSON (Collection v2.1) та інтеграція з Git
• Документація щодо запуску (включаючи Newman для CI/CD)
• Навчання команди (1 година онлайн)

Як ми налаштовуємо колекцію: процес роботи

1. Аналіз API. Вивчаємо ендпоїнти, методи, авторизацію, формати даних.
2. Проектування структури. Розбиваємо на логічні групи, створюємо папки.
3. Створення оточень. Готуємо змінні для кожного стенду.
4. Реалізація запитів. Додаємо заголовки, тіла, параметри.
5. Автоматизація авторизації. Пишемо Pre-request Script.
6. Тести. Додаємо перевірки для кожного запиту.
7. Експорт та інтеграція. Зберігаємо в репозиторій, налаштовуємо Newman у CI/CD.

Collection Runner і Newman

Collection Runner дозволяє запустити всі запити колекції послідовно й побачити, чи всі тести пройшли. Це базове smoke-тестування API.

Newman — CLI-інструмент для запуску колекцій з командного рядка. Інтегрується в CI/CD:

npm install -g newman
newman run bitrix-api.postman_collection.json \
    -e production.postman_environment.json \
    --reporters cli,html

Після кожного деплою CI автоматично проганяє колекцію та перевіряє працездатність API. Економія часу на регрес — до 20 годин на місяць.

Як уникнути типових помилок під час налаштування?

Одна з частих проблем — неправильне зберігання чутливих даних. Ніколи не кладіть логіни та паролі в саму колекцію. Використовуйте змінні оточення, які не потрапляють до Git. Друга помилка — забути оновити колекцію після зміни API. Рекомендуємо зберігати JSON-файл колекції в тому самому репозиторії, що й код, і оновлювати його в межах тієї самої задачі.

Документація з колекції

Postman генерує документацію з колекції автоматично: опис кожного запиту, приклади відповідей, параметри. Це не повноцінна OpenAPI-документація, але достатньо для внутрішнього використання.

Чому варто інвестувати в налаштування колекції?

Налаштування колекції для API з 15–20 ендпоінтів з тестами та оточеннями — 1–2 дні. Зв'яжіться з нами для консультації — оцінимо ваш проєкт за один день. Замовте налаштування Postman-колекції й забудьте про ручні тести. Отримати консультацію можна через форму на сайті — ми відповімо протягом робочого дня.

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