How to Set Up API Versioning for 1C-Bitrix?

After one update of the trade catalog, we got a dozen calls: partner services stopped processing orders. The reason — the price field in the API response was renamed to base_price. Clients that parsed price received null instead of data. API versioning prevents such incidents: you release a new version — the old one continues to work unchanged. Clients don't have to urgently rewrite integrations, and you avoid reputational losses. For more approaches, see API versioning on Wikipedia.

Without versioning, any change in the response structure becomes a risk. Clients are tightly bound to the data schema, and if you break it, they lose trust in your API. Versioning gives partners predictability: they see that v1 is still alive, receive a deprecation warning, and can calmly plan migration to v2. In our practice, a well-structured version lifecycle reduces support load by 30–40% — fewer urgent requests, less manual coordination with clients. This can save businesses over $5,000 annually in support costs.

Which Versioning Strategy Is Best?

In practice, we use three approaches. Their comparison is in the table:

URL versioning — our recommendation. The version is visible in the URL, easy to test and document. This approach speeds up new partner integrations by 3x compared to query parameters, and is 2x faster to debug than header versioning.

How to Implement API Versioning in 1C-Bitrix?

Step-by-step instructions:

1. Create a folder structure /local/api/v1/, /local/api/v2/.
2. Place controllers and routes.php in each directory.
3. Write a router index.php that extracts the version from the URL.
4. Connect the status configuration (deprecated, current).

Example file structure:

/local/
  api/
    v1/
      controllers/
        ProductController.php
        OrderController.php
      routes.php
    v2/
      controllers/
        ProductController.php  # modified version
      routes.php
    index.php  # version router
    config.php # status configuration

The router processes the incoming request, determines the version from the URL, and includes the appropriate route:

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

Version status configuration is stored separately:

return [
    'v1' => ['status' => 'deprecated', 'sunset' => '12 months after deprecated'],
    'v2' => ['status' => 'current'],
];

The router automatically adds Deprecation, Sunset, and Link headers for deprecated versions.

How Does Inheritance Between API Versions Work?

Version v2 is not written from scratch. We use controller inheritance:

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

This pattern minimizes duplication and eases maintenance. Our experience shows this approach reduces development time for the next version by 40%.

API Version Lifecycle

We implement a standard model: current → deprecated → sunset → retired. When accessing a deprecated version, we add headers:

header('Deprecation: true');
header('Sunset: 12 months');
header('Link: </api/v2/products>; rel="successor-version"');

What's Included in the Work

• Audit of current API and its clients
• Designing the versioning scheme
• Developing the router, controllers, and configuration
• Migrating one version (if already exists)
• Documentation (OpenAPI/Swagger)
• Training your team
• Code guarantee (6 months)

Why Monitor Version Usage?

After implementing versioning, it's important to track who and how actively uses each version. Without this data, it's hard to decide when to retire a deprecated version. Basic monitoring is built at the router level: each request is logged with the version, IP address, and endpoint.

// In the router after determining the version
$logEntry = [
    'version'   => $version,
    'endpoint'  => $endpoint,
    'method'    => $_SERVER['REQUEST_METHOD'],
    'client_ip' => $_SERVER['REMOTE_ADDR'],
    'timestamp' => date('Y-m-d H:i:s'),
];
// Write to a log file or send to a monitoring system
error_log(json_encode($logEntry), 3, '/var/log/bitrix-api-usage.log');

Analyzing the logs, you see: how many requests per day hit v1, which clients haven't migrated to the new version. This allows you to notify partners specifically and set realistic sunset dates without risking breaking active users. Additionally, aggregating daily metrics: the last request dates from each IP show who already migrated and who still uses the old version. Based on this data, you form a list of clients for personal notification. Practice shows that this approach allows painless deactivation of a deprecated version within 3–6 months after the new version's release, whereas without monitoring, old versions live for years.

The timeline for setting up versioning for an existing API with two versions is 1 to 3 days depending on complexity. We'll assess your project for free — contact us. Get an engineer consultation.

Metrics: over 10 years of experience with Bitrix, 50+ completed API integration projects, 5 years on the market. We guarantee compatibility with 1C-Bitrix and Bitrix24. Savings on integration support — up to 40%.

1C-Bitrix Module Development and Setup

The main trap of Bitrix is init.php. You add an OnBeforeIBlockElementUpdate handler there, then another one — a year later the file is 2000 lines, and on every hit all that code executes. We move business logic into full-fledged modules with D7 ORM, custom tables, and administrative interface. The module can be disabled, transferred to another project, covered with tests — none of that is possible with init.php. Our team has 10+ years of Bitrix experience, certified specialists, and a 6-month code guarantee. Request a consultation — we'll explain how to migrate legacy code to a modular architecture.

Why is init.php the worst place for business logic?

Init.php does not support class autoloading, lacks an isolated namespace, cannot be unit tested, and cannot be disabled without editing the file itself. Every handler written there runs on every request, even if not needed. In a module, you register handlers through EventManager, and they only execute when the event occurs. Performance difference: up to 3x with 10+ handlers.

Standard Modules: Typical Problems and Solutions

Information blocks. IBlock architecture is the first thing we review on any project. A classic mistake: one catalog infoblock with 80 properties, 30 of which are multiple. The b_iblock_element_property table swells to millions of rows, and CIBlockElement::GetList with filtering on three properties does a full scan. We move reference data to Highload-blocks, eliminate multiple properties where possible, and design the structure for 5x growth.

e-Store (sale). Cart business rules are a separate story. We set discount priorities to prevent two campaigns from giving 60% instead of 30%, connect payment handlers, and write custom validation via OnSaleOrderBeforeSaved.

Search. The built-in search module with morphology works up to 10–15 thousand elements. Beyond that — Elasticsearch. We configure it via the Bitrix search module API, indexing through CSearchFullText or custom indexers.

Highload-blocks for dictionaries, logs, user data — instead of bloated IBlocks. Direct queries via Bitrix\Highloadblock\HighloadBlockTable, custom tables instead of the EAV structure of standard infoblocks. A million records — no degradation.

Mail events. Configuration is not just templates in b_event_message. The key is SPF, DKIM, DMARC on the DNS, otherwise transactional emails go to spam. We check deliverability and set up bounce handling.

How to Design Infoblocks for Performance?

We use Highload-blocks for reference data (colors, sizes, manufacturers) that are not involved in complex queries. For SKUs — a separate infoblock with linking via IBLOCK_ELEMENT_PROPERTY. Enable INDEX_PROPERTY for frequently filtered properties. Tagged caching: when an element changes, only the related cache is cleared. Highload-blocks process up to 10x faster than infoblocks with multiple properties on volumes of 100,000 records.

Custom Module Development

Each module follows the structure /local/modules/vendor.modulename/:

• install/index.php — setup class, create tables via $DB->RunSQLBatch()
• lib/ — D7 ORM classes, extending Bitrix\Main\ORM\Data\DataManager
• admin/ — administrative pages using CAdminList, CAdminForm
• include.php — autoloading, event handler registration via EventManager::getInstance()->registerEventHandler()
• REST API endpoints via \Bitrix\Rest\RestManager

The module registers in the system, appears in the "Installed Solutions" list, and has its own settings at /bitrix/admin/settings.php?mid=vendor.modulename. It can be enabled, disabled, and updated through UpdateSystem or custom migration mechanics.

Examples of implemented tasks:

• Campaign management — visual condition builder via CAdminCalendar, timers via agents (CAgent::AddAgent), analytics linked to the sale module
• Cost calculator — React widget on the frontend, REST API in the module, formulas stored in a Highload-block
• Booking system — real-time calendar, locking via $DB->StartTransaction() / $DB->Commit() on concurrent requests, integration with channel manager via webhook

Components and Composite Cache

Component customization via result_modifier.php and component_epilog.php, not by editing template.php of the standard template. This way core updates are painless.

Composite cache ("Composite Site" technology) — the server sends ready HTML, bypassing PHP routing. Dynamic areas (cart, authorization) are loaded via CBitrixComponent::setFrameMode(true) and AJAX. TTFB drops to 30–50 ms. But there are caveats: not all components are compatible, $APPLICATION->ShowPanel() breaks composite, and careful markup of <div id="bx-composite-..."> is required.

What to Check Before Installing a Marketplace Module?

Before installing a module from the marketplace, an audit is mandatory. We check: SQL queries without prepared statements (hello SQL injection), direct use of $_REQUEST without filtering, use of outdated kernel API instead of D7, conflicts with the composite cache module. A module with no updates for over a year and a few dozen installations is likely a problem on the next PHP update. A typical case: a module calls CIBlockElement::GetList with no cache reset — the site crashes with 5000 elements.

Migration to D7

When upgrading PHP or switching to a new edition — refactor outdated calls:

• CIBlockElement::GetList() → Bitrix\Iblock\Elements\ElementTable::getList()
• CSaleOrder::GetList() → Bitrix\Sale\Order::getList()
• CModule::IncludeModule() → Bitrix\Main\Loader::includeModule() Testing on staging, rollback via git on issues.

According to official 1C-Bitrix documentation, D7 ORM is the recommended tool for working with data, providing type safety and automatic query generation.

Comparison: Init.php vs Module

Module Development Scope and Cost

What is included in module development?

• Technical specification and architectural plan
• Code following PSR-4 and Bitrix code style
• Unit tests (PHPUnit) for business logic
• Integration tests for events and REST API
• Installation, configuration, and API documentation
• Repository and documentation access
• Administrator training for module usage
• 6-month warranty support

Estimated timelines and complexity:

Cost is calculated individually — contact us for a project estimate.

Module Testing

Unit tests via PHPUnit cover business logic: discount calculation, validation, document generation. Mocks for Bitrix\Main\Application::getConnection() allow tests to be DB-independent. Integration tests verify event handlers on a real database — OnAfterIBlockElementAdd, OnSaleOrderSaved, etc. REST API endpoints are tested via curl or PHPUnit HTTP client. Critical for modules working with b_sale_order, b_catalog_price — where errors cost money.

Compatibility is checked on PHP 7.4, 8.0, 8.1, 8.2 and editions: Standard, Small Business, Business. We check conflicts with popular marketplace modules — they often intercept the same events. Load testing: measurements on 10K, 100K, 1M records, profiling via Xdebug for memory leaks and N+1 queries.

Practical Examples

Campaign module for an electronics chain. The built-in sale module discounts did not cover scenarios like "2+1", a gift with purchase over a certain amount, or combined conditions. We built a visual builder: marketers create rules via drag-and-drop without development tickets. Campaign calendar, auto-deactivation via agents, analytics linked to b_sale_order — conversion, average check, usage count. Time to launch a new campaign dropped from two days to half an hour.

Calculator for builders. Parameters (area, materials, number of floors) → formula → preliminary estimate → lead to CRM via CRest::call('crm.lead.add'). Regional coefficients and seasonal markups from a Highload-block, material prices from 1C exchange. The number of target leads increased by a third: clients see a breakdown before calling a manager.

Booking for a hotel chain. Real-time availability via AJAX requests to a custom table vendor_booking_slots, seasonal tariff calculation, synchronization with Booking.com via channel manager API. Room locking on concurrent booking via SELECT ... FOR UPDATE in transactions. Timezones handled via \DateTimeZone — a guest from Vladivostok and a manager from Moscow see the same picture.

We will evaluate your project within one day. Write to us — we'll tell you what is included in turnkey development. Contact us for a consultation on your project. Order a custom module development — get a ready solution with documentation and support.