# Bitrix24 JS SDK — документация (RU)

> Русскоязычная версия документации Bitrix24 JS SDK — полнофункциональной JavaScript-библиотеки для работы с REST API Bitrix24, включая вызовы методов, батчинг, фреймы, хуки и OAuth.

## Установка (Nuxt, Vue, React, Node.js, UMD)

- [Проект на Vue](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/installation/vue.md): Руководство по установке Bitrix24 JS SDK в приложениях Vue.
- [Проект на Nuxt](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/installation/nuxt.md): Руководство по установке Bitrix24 JS SDK в приложениях Nuxt.
- [Проект на React](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/installation/react.md): Руководство по установке Bitrix24 JS SDK в приложениях React.
- [Проект на Node.js](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/installation/nodejs.md): Руководство по установке Bitrix24 JS SDK в приложениях Node.js.
- [UMD](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/installation/umd.md): Руководство по использованию UMD-версии Bitrix24 JS SDK в ваших приложениях.

## Начало работы

- [Начало работы](https://bitrix-tools.github.io/b24jssdk/docs/getting-started.md): Краткое руководство по работе с SDK для REST API Bitrix24
- [Проект на Vue](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/installation/vue.md): Руководство по установке Bitrix24 JS SDK в приложениях Vue.
- [Проект на Nuxt](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/installation/nuxt.md): Руководство по установке Bitrix24 JS SDK в приложениях Nuxt.
- [Проект на React](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/installation/react.md): Руководство по установке Bitrix24 JS SDK в приложениях React.
- [Проект на Node.js](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/installation/nodejs.md): Руководство по установке Bitrix24 JS SDK в приложениях Node.js.
- [UMD](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/installation/umd.md): Руководство по использованию UMD-версии Bitrix24 JS SDK в ваших приложениях.
- [Миграция на v1](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/migration/v1.md): Подробное руководство по миграции приложения с Bitrix24 JS SDK v0 на Bitrix24 JS SDK v1.
- [Миграция на v3 (удаление legacy REST-поверхности)](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/migration/v3.md): Как уйти с устаревшей REST-поверхности, которая удаляется в Bitrix24 JS SDK 3.0.0.
- [AI-навыки (Skills)](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/ai/skills.md): Узкоспециализированные skill-файлы для AI-агентов разработчика, работающих с @bitrix24/b24jssdk.
- [LLMs.txt](https://bitrix-tools.github.io/b24jssdk/docs/getting-started/ai/llms-txt.md): Как сделать, чтобы AI-инструменты вроде Cursor, Windsurf, GitHub Copilot, ChatGPT и Claude понимали методы, инструменты и лучшие практики Bitrix24 JS SDK.

## Работа с REST API

- [CallV2.make](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/call-rest-api-ver2.md): Метод для вызовов REST API Bitrix24 версии 2.
- [CallV3.make](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/call-rest-api-ver3.md): Метод для вызовов REST API Bitrix24 версии 3.
- [CallListV2.make](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/call-list-rest-api-ver2.md): Метод для быстрого получения всех данных из list-методов REST API Bitrix24 версии 2.
- [CallListV3.make](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/call-list-rest-api-ver3.md): Метод для быстрого получения всех данных из list-методов REST API Bitrix24 версии 3.
- [FetchListV2.make](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/fetch-list-rest-api-ver2.md): Возвращает AsyncGenerator, позволяющий обрабатывать данные из list-методов REST API Bitrix24 версии 2 по мере поступления, не загружая весь массив в память сразу. Особенно полезно при работе с очень большими объёмами данных.
- [FetchListV3.make](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/fetch-list-rest-api-ver3.md): Возвращает AsyncGenerator, позволяющий обрабатывать данные из list-методов REST API Bitrix24 версии 3 по мере поступления, не загружая весь массив в память сразу. Особенно полезно при работе с очень большими объёмами данных.
- [Класс B24Hook](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/hook.md): Серверная точка входа для работы с REST API Bitrix24 через входящий вебхук (постоянный токен).
- [BatchV2.make](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/batch-rest-api-ver2.md): Метод для выполнения пакетных запросов к REST API Bitrix24 версии 2. Позволяет выполнить до 50 команд в одном API-вызове.
- [BatchV3.make](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/batch-rest-api-ver3.md): Метод для выполнения пакетных запросов к REST API Bitrix24 версии 3. Позволяет выполнить до 50 команд в одном API-вызове.
- [Класс B24Frame](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/frame.md): Предназначен для управления приложениями Bitrix24, работающими внутри placement-iframe. Наследуется от AbstractB24 и предоставляет менеджеры для аутентификации, обмена сообщениями с родительским окном, слайдеров, диалогов, placement и опций.
- [Инициализация B24Frame](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/frame-initialize-b24-frame.md): Функция предназначена для инициализации B24Frame
- [Класс AuthManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/frame-auth.md): Предназначен для управления аутентификацией в приложениях Bitrix24. Обрабатывает данные аутентификации, полученные от родительского окна, и предоставляет методы для их обновления и получения.
- [Класс DialogManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/frame-dialog.md): Оборачивает системные диалоги BX24 (выбор пользователя, выбор прав доступа, выбор CRM-сущности), чтобы их можно было открывать изнутри iframe приложения Bitrix24.
- [Класс OptionsManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/frame-options.md): Используется для управления настройками приложения и пользователя в приложении Bitrix24. Позволяет инициализировать данные, получать и устанавливать опции через сообщения родительскому окну.
- [Класс ParentManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/frame-parent.md): Предоставляет методы для управления родительским окном приложения в Bitrix24, включая изменение размера окна, управление прокруткой, инициацию звонков и открытие мессенджера.
- [Класс PlacementManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/frame-placement.md): Используется для управления placement виджетов в приложении Bitrix24.
- [Класс SliderManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/frame-slider.md): Предоставляет методы для работы со слайдерами в приложении Bitrix24. Позволяет открывать и закрывать слайдеры, а также управлять их содержимым.
- [BatchByChunkV2.make](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/batch-by-chunk-rest-api-ver2.md): Метод для выполнения пакетных запросов с автоматическим разбиением на чанки для любого числа команд. Автоматически делит большие наборы команд на батчи по 50 и выполняет их последовательно. Используйте только массивы кортежей или массивы объектов.
- [BatchByChunkV3.make](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/batch-by-chunk-rest-api-ver3.md): Метод для выполнения пакетных запросов к REST API Bitrix24 версии 3 с автоматическим разбиением на чанки для любого числа команд. Автоматически делит большие наборы команд на батчи по 50 и выполняет их последовательно. Используйте только массивы кортежей или массивы объектов.
- [Класс B24OAuth](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/oauth.md): Серверная точка входа для работы с REST API Bitrix24 по access token OAuth 2.0 (с автоматическим обновлением).
- [Выбор подходящего метода](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/choosing-the-right-method.md): Руководство по выбору между Call, CallList, FetchList, Batch и BatchByChunk в REST API v2 и v3.
- [Фильтрация](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/filtering.md): Справочник по построению параметров фильтра в Bitrix24 REST API v2 (префиксные операторы) и v3 (массив троек), включая формат дат и правило отбрасывания order.
- [B24HelperManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/helper.md): Агрегирующий менеджер, который загружает данные профиля, приложения, оплаты, лицензии, валют и опций одним батч-запросом REST, а также подключает Pull-клиент.
- [Composable useB24Helper](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/helper-use-b24-helper.md): Основанный на замыкании composable, который владеет единственным экземпляром B24HelperManager и предоставляет хелперы жизненного цикла (init / destroy / связка с Pull-клиентом).
- [ProfileManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/helper-profile-manager.md): Разобранный ответ REST-метода `profile`: id, имя, фамилия, пол, фото, часовой пояс, флаг администратора.
- [AppManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/helper-app-manager.md): Разобранный ответ REST-метода `app.info`: id приложения, код, версия, статус, флаг установки.
- [PaymentManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/helper-payment-manager.md): Статус оплаты приложения Bitrix24 — извлекается из `app.info`.
- [LicenseManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/helper-license-manager.md): Информация о лицензии Bitrix24 из `app.info` — и автоматическая перенастройка менеджера ограничений под соответствующий тарифный план.
- [CurrencyManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/helper-currency-manager.md): Каталог валют, кэшируемый в памяти — базовая валюта, форматтеры для каждой валюты и форматтер числа в строку.
- [OptionsManager](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/helper-options-manager.md): Типизированный доступ к `app.option.get` / `user.option.get`, плюс save(), который батчит `*.option.set` с необязательным Pull-уведомлением.
- [Коды ошибок и обработка](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/errors.md): Справочник кодов SdkError и AjaxError, выбрасываемых SDK, плюс коды ошибок REST Bitrix24, которые через них проявляются.
- [Pull (Push & Pull)](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/pull.md): Поток сообщений в реальном времени от Bitrix24 к вашему приложению — WebSocket как основной канал, long-polling как запасной. Только для фрейма.
- [Logger](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/logger.md): Логгер, вдохновлённый PHP Monolog, предоставляет структурированную систему логирования с поддержкой каналов, обработчиков, процессоров и форматтеров. Реализация следует принципам PSR-3 и паттерну цепочки ответственности.
- [Обработчик Telegram](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/logger-telegram.md): Отправка логов в Telegram
- [Обнаружение v3-методов (OpenAPI)](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/discovering-v3-methods.md): Используйте rest.documentation.openapi, чтобы получить собственный машиночитаемый список всех доступных методов REST API v3 портала — источник истины, на который SDK опирается вместо захардкоженного allowlist. Особенно полезно для AI-агентов и кодогенерации.
- [AjaxResult](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/core-ajax-result.md): Специализированный Result, возвращаемый каждым REST-хелпером. Предоставляет `isMore() / getNext() / getTotal() / getStatus()` для постраничных ответов и неизменяемые данные.
- [Http (TypeHttp)](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/core-http.md): Низкоуровневый интерфейс транспорта, возвращаемый `b24.getHttpClient(version)`. Прямой доступ к axios-клиентам, параметрам ограничений, статистике и сбросу.
- [B24LangList](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/core-lang-list.md): Enum языков интерфейса облачного Bitrix24 плюс карта локалей BCP-47.
- [RequestIdGenerator](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/core-request-id-generator.md): Реализация `IRequestIdGenerator` по умолчанию. Генерирует request id в формате UUID v7 и предоставляет имена HTTP-заголовка / query-параметра, используемые SDK.
- [Result](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/core-result.md): Обобщённый результат операции с флагом успеха, данными и картой ошибок. Аналог \\Bitrix\\Main\\Result из Bitrix Framework.
- [Система ограничений](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/limiters.md): Система ограничений предоставляет комплексный механизм управления частотой запросов, временем выполнения операций и адаптивными задержками.
- [Логирование и редактирование учётных данных](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/logging.md): Что SDK редактирует автоматически до того, как информация о запросе попадёт в логгер или AjaxError, что он не редактирует, и как подключить кастомный логгер через setLogger(...) без повторного появления утечек учётных данных.
- [Browser](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/tools-browser.md): Дешёвый детектор user-agent / платформы / возможностей. Полезен для runtime-ветвлений во фронтенд-коде.
- [Text](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/tools-text.md): Утилиты для текста и дат — UUID v4 / v7, кодирование / декодирование HTML-сущностей, преобразования типов, хелперы регистра, `toDateTime` / `toB24Format` на Luxon, форматирование чисел и конструктор query-строки.
- [Type](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/tools-type.md): Runtime type guards — строки, числа, обычные объекты, массивы, DOM-узлы, Blob, FormData, формы JSON-RPC сообщений.
- [useFormatter](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/tools-use-formatters.md): Composable, возвращающий общие экземпляры `FormatterNumbers` и `FormatterIban`, преднастроенные спецификациями стран.
- [IResult](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/types-iresult.md): Обобщённый интерфейс результата операции. Реализуется `Result<T>` и (транзитивно) `AjaxResult<T>`.
- [TypeB24](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/types-type-b24.md): Публичный контракт, реализуемый каждым классом-точкой входа (B24Frame, B24Hook, B24OAuth). Единый источник истины для поверхности SDK.
- [Телеметрия](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/telemetry.md): Query-параметры request id, версии SDK и типа SDK, добавляемые к каждому REST-вызову Bitrix24.
- [Коды ошибок](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/error-codes.md): Каталог кодов ошибок, которые распознаёт SDK — разделённых на «hard» (выбрасываются) и «soft» (возвращаются как AjaxError внутри AjaxResult).
- [HealthCheck.make()](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/tools-health-check.md): Метод для проверки доступности REST API Bitrix24. Выполняет простой запрос к REST API для проверки работоспособности сервиса.
- [Ping.make()](https://bitrix-tools.github.io/b24jssdk/docs/working-with-the-rest-api/tools-ping.md): Метод для измерения скорости ответа REST API Bitrix24. Выполняет тестовый запрос и возвращает время ответа в миллисекундах.

## Documentation Sets

- [Полная документация Bitrix24 JS SDK](https://bitrix-tools.github.io/b24jssdk/llms-full.txt): Полный корпус документации Bitrix24 JS SDK на русском в виде Markdown-файлов с MDC-синтаксисом.

## Notes

- Контент генерируется из того же источника, что и верстка публичной документации. Переводы синхронизируются с upstream `bitrix24/b24jssdk`.