Документация для разработчиков
Темная тема
Основные положения

Битрикс24 - программный продукт в виде облачного сервиса, а также коробочной версии, созданный компанией "1С-Битрикс".

Внимание! С 1 января 2021 года использование приложений Битрикс24.Маркет, REST API и вебхуков (локальные интеграции в разделе «Разработчикам») доступно только на коммерческих тарифах Битрикс24.

Внимание! В связи с прекращением поддержки интернет-браузера Internet Explorer со стороны компании Microsoft остановлена поддержка браузера IE в платформе «1С-Битрикс: Управление сайтом» и в продукте «1С-Битрикс24»

Разработчики могут создавать собственные приложения или интеграции для Битрикс24, используя открытый REST API, который работает как с облачным, так и с коробочным Битрикс24, а также с "1С-Битрикс: Управление сайтом" начиная с версии 16.6.0.

При использовании REST в коробочных продуктах необходимо вручную создать папку /marketplace/ в корне сайта.

В документации дано справочное описание методов. Перед использованием справочника рекомендуется изучить курс Приложения Битрикс24, в котором даётся описание базовых понятий, рассматриваются варианты получения технического доступа к методам REST и предлагаются готовые примеры, включая раздел «Быстрый старт» как для создания тиражных решений, так и для решения частных задач интеграции и расширения функционала Битрикс24 по индивидуальным сценариям.

Следить за изменениями в документации можно с помощью страницы Что нового?, либо подпиской на канал в Телеграмме, а также в блоге Отдела документации.

Напоминаем, что в REST запросах имеет значение регистр!

Примечание по использованию справочника: добавив к адресу любой страницы #examples можно быстро перейти к примеру, если он на ней есть.

Для ознакомления с API очень удобно использовать специально созданное приложение, которое представляет собой консоль разработчика и позволяет выполнять произвольные вызовы к REST API прямо из приложения, ориентируясь на примеры кода в справочнике

 Документация также доступна в виде файла в формате chm: b24_rest.chm.
Рекомендуется пользоваться онлайн версией, как более актуальной. Файлы формата chm обновляются периодически, в них может отсутствовать информация по последним изменениям в справочной системе. При возникновении проблем с просмотром скачанного файла chm откройте свойства файла и во вкладке "Общие" нажмите кнопку Разблокировать .


Работа с REST возможна не только в облачных версиях Битрикс24, но и в коробочных редакциях. Начиная с версии 18.0.7 удаление модуля Rest из коробочных редакций невозможно.


В курсе Бот платформа Битрикс24 есть описание собственного REST API для Бот-платформы.

В Телеграме есть:

  1. официальный канал разработчиков приложений
  2. неофициальное сообщество разработчиков приложений


© «Битрикс», 2001-2024, «1С-Битрикс», 2024