REST API

What this solution does

The REST API module is designed to create a programmatic interface that enables external and internal applications to interact with the site. It facilitates data exchange between resources, including other websites and mobile applications.

Students use this module to study REST API principles and develop custom interfaces for coursework and diploma projects.

Important limitation: the module does not perform import of product stock levels from supplier websites. Its functionality is limited to implementing an API for data exchange, not for automatically importing information from external sources.

The REST API module is designed for organizing data exchange between platforms. A new optimized core has been developed based on experience with the previous version, providing significantly faster request processing. The update includes a routes map that allows flexible parameter configuration for each individual route. Using the module reduces development time for API interfaces and lowers overall integration costs. Support is provided by specialists with experience in creating API solutions.

The REST API module by WEBKO • WEBCO provides a ready-to-use interface with a library of built-in methods and the ability to create custom methods implementing any required logic. The system automatically generates documentation available to external developers.

The module operates via the native REST provider for 1C-Bitrix and loads before the public part of the site starts without requiring additional platform configuration. The interface is accessible via a virtual path, including the domain root, subdomain, or a custom path.

The administrative section allows configuring access to module sections for user groups. Documentation is automatically generated both within the administrative section and for clients in JSON format.

Features include support for route maps and the creation of arbitrary routes using variables in the path. Custom controllers can be assigned to routes as classes, external classes, or PHP files. Access to routes can be configured individually, incoming request parameters undergo validation, and specific routes support authentication via login and password.

The REST API module by VEBKO • WEBCO provides flexible tools for access management and request processing. It supports token-based authorization at the individual route level, user token generation, and user group verification during authorization. Specific routes support a whitelist of allowed logins and tokens, as well as the ability to deactivate routes. The system allows limiting the number of requests per unit of time for user groups, passing additional headers in responses, caching incoming requests and responses using platform tools, and maintaining a log of requests and responses. CORS configuration is available through the site's administrative panel. To accelerate interface development, the module includes helper functions, a library of built-in routes, and examples and guides for developers. A complete description of capabilities, functions, and examples is provided in the module's documentation.

Unlike the standard Bitrix REST API, which offers limited flexibility and requires the use of only pre-defined routes, this module allows creating custom routes and writing custom logic for request handling.

The REST API module by WEBKO • WEBCO extends the standard REST API implementation in Bitrix, addressing architectural inconsistencies and improving performance. The base version sometimes performs redundant operations during request processing, causing latency; this module optimizes the process for maximum response speed.

To enhance security, the module allows defining a unique access route for the API, hiding standard paths documented in public resources. This reduces the risk of attacks. You can configure the access address using a subdomain such as api, or paths like /rest, /api, or /rest-api.

Additionally, the module adds management capabilities absent in the base version: configuring the interface via the administrative panel, controlling access to routes, limiting the number of requests from a client, and logging requests and responses.

1.7. The standard 1C-Bitrix REST API currently lacks the ability to create orders via the API. This module implements the missing functionality to perform such operations.

1.8. Development and maintenance of this module are driven by user requests. However, the architecture and evolution of the 1C-Bitrix REST API are determined solely by the platform developers. Users must independently assess whether these factors are beneficial or limiting.

Environment requirements:

- Minimum PHP version 8.1 or higher, as required by the platform. Using older versions is technically possible but strongly discouraged due to the high risk of errors.

- A file for handling 404 errors (typically 404.php) containing all necessary 1C-Bitrix directives must be present in the site root directory.

- For the Apache web server, the directive ErrorDocument 404 /404.php must be added to the .htaccess file in the site root or directly in the server's main configuration file.

- For the Nginx web server, the directive error_page 404 = /404.php?$query_string; must be specified in the server section of the configuration file (typically nginx.conf).

- To ensure CORS requests function correctly, the web server must allow OPTIONS requests.

The REST API module is developed by WEBCO • WEBCO. For questions or suggestions, contact the support section where contact details are provided. Partners are eligible for individual discount conditions; contact the manager via the contacts section for details.

General iT can take care of implementing “REST API”, including installation, configuration and result verification.