Bitrix24 REST API
Инструмент для создания интеграций, автоматизаций рабочих процессов и кастомизации пользовательских сценариев Битрикс24
Быстрый старт
С чего начать знакомство
Узнайте, как устроена документация и как использовать API
Как получить доступ
Ознакомьтесь с требованиями к тарифу Битрикс24 и начните знакомство с разделом для разработчиков внутри продукта
Как выполнить запрос
Получите практическую инструкцию для вашего первого вызова REST API Битрикс24
Как устроен REST API
Версии API
В Битрикс24 используются две версии REST API: REST и REST 3.0. Они различаются путем вызова, форматом некоторых ответов и составом документации. Перед началом работы уточните, какая версия REST используется в вашем сценарии.
Именование методов
Название метода часто помогает понять область API и тип операции. Но одного имени метода недостаточно, чтобы точно определить его поведение, параметры и ограничения. Используйте название как ориентир, а подробности проверяйте в справочнике API.
Ответ метода
Методы REST API возвращают ответ в JSON. Структура успешного ответа и формат ошибки зависят от версии REST и конкретного метода. Точные поля ответа смотрите в описании нужного метода.
Какой сценарий интеграции выбрать
В Битрикс24 можно использовать webhook и разные типы приложений. Сначала определите, нужен ли вам webhook или приложение, затем выберите подходящий сценарий по архитектуре и интерфейсу.
Быстрые вызовы отдельных методов без разработки приложения
Подходит для простых сценариев, когда нужно быстро обратиться к отдельным методам без серверной логики приложения и пользовательского интерфейса в слайдере.
Статичная страница внутри Битрикс24 без серверной логики
Подходит для простых локальных приложений, которые открываются внутри портала, не выполняют серверную логику и не отправляют запросы на внешний сервер.
Серверная логика с интерфейсом в слайдере
Подходит и для локальных, и для тиражных приложений. Выбор зависит от того, нужно ли решение только для одного портала или для публикации в Маркетплейсе.
Серверная логика без интерфейса
Подходит и для локальных, и для тиражных приложений. Такой сценарий используется, когда приложение работает в фоне и пользователь не открывает его в слайдере.
Ключевые концепции
Scope
Для вызова метода нужны соответствующие права доступа. Набор прав зависит от сценария интеграции и конкретного метода. Проверяйте требования на странице метода и в описании scope.
Лимиты
В Битрикс24 действуют лимиты на интенсивность запросов и ресурсоемкость методов. Перед массовыми вызовами проверьте ограничения и рекомендации по снижению нагрузки.
Batch
Метод batch позволяет объединить несколько вызовов в один запрос и снизить нагрузку на лимиты.
Пагинация
Многие методы списка возвращают данные частями. Способ постраничного получения результатов и параметры пагинации зависят от метода и версии REST. Проверяйте детали в описании конкретного метода.
Файлы
В Битрикс24 используются разные сценарии работы с файловыми полями. Способ передачи файла зависит от типа поля и метода. Перед загрузкой, обновлением или удалением файла проверьте, какой сценарий поддерживает нужный вам метод.
Частые кейсы и сценарии
Если вам нужен готовый сценарий для практической задачи, начните с раздела Частые кейсы и сценарии. Здесь собраны примеры интеграций и типовые задачи. Для точных параметров и ограничений используйте страницы конкретных методов в справочнике API.
Как быстро связать форму на своем сайте с CRM? Как автоматически создавать сделки с товарными позициями? Как, создавая лид из своего источника, «прокинуть» в Битрикс информацию для сквозной аналитики?
Как быстро сформировать заказ интернет-магазина? Как получить ссылку на оплату для передачи клиенту? Как подключить свою онлайн-кассу?
Импортировать данные, интегрировать свою телефонию, использовать товарный каталог — десятки готовых практических примеров.
Комьюнити и коммуникация с Битрикс24
Улучшить документацию
Мы выложили исходный код документации в открытый доступ. Вы можете помочь нам стать лучше.
Общаться с коллегами
Если не нашли ответ в официальной документации, присоединяйтесь к комьюнити разработчиков — это лучшая среда для обмена опытом.
Связаться с поддержкой
Наша техническая поддержка помогает решать проблемы партнерам и клиентам. Мы всегда открыты к диалогу.
