API Platform

What this solution does

The API platform serves as a unified infrastructure foundation for all integrations. It enables the creation of APIs for mobile applications, personal accounts, CRM, ERP, and partner services. The platform handles technical operations including authorization, access control, caching, documentation generation, and logging, allowing the team to focus on business tasks. The solution is suitable for companies connecting external systems to a website or corporate portal, for development teams building APIs for mobile apps and internal services, and for integrators and studios as a reusable base for client projects. The platform operates within the 1C-Bitrix: Site Management environment and the boxed version of Bitrix24. The module is installed using the standard wizard from the Marketplace. After installation, API and documentation addresses are configured, service methods are activated, and functionality is verified via Swagger. Subsequently, application methods are added and access rules are defined for specific project tasks. A developer is required for full implementation to realize data handling methods, exchanges with specific systems, and permission checks for individual data within the project.

Reduce rework by using built-in mechanisms for authorization, parameter validation, response generation, and logging when connecting new applications and services.

Manage access. Distinguish operations by user groups, configure token validity periods and rotation, and revoke access for individual clients.

Control requests. Limit requests by IP addresses, schedules, and volume. Configure CORS for browser-based applications.

Simplify maintenance. Request history, counters, and configurable logging help identify errors and access denial causes.

Documentation alongside the API. OpenAPI descriptions are generated automatically from route configurations. The built-in Swagger interface allows you to explore methods, parameters, and responses, and to execute test requests.

Configurable caching. Set caching rules for results separately for each route. Access checks are performed again even when retrieving responses from the cache.

In the event of an incident, regenerating the key invalidates all previously issued tokens in a single operation.

Extensible infrastructure. Create custom routes and handlers, use JSON and XML formats, and extend request processing via module events.

The platform's unified foundation streamlines development and reduces the burden on the team maintaining infrastructure code. Settings and tokens are managed via the Bitrix administrative panel with separate permissions for viewing and editing. The Swagger interface displays available operations based on user group rights, which is convenient for internal teams and contractors with varying access levels. Documentation includes instructions for installation and initial launch, access configuration and token management, creating custom routes and handlers, as well as request examples and platform extension guides.

When needed, General iT can implement “API Platform”, configure the module and verify it against the current website setup.