Справочник REST API: инструменты и методы Битрикс24

С помощью REST API приложение работает с инструментами Битрикс24. Например, оно может создать сделку в CRM, получить задачу, загрузить файл на Диск, обработать событие об изменении данных или встроить виджет в карточку.

Быстрый переход: все разделы справочника

Как пользоваться справочникомКак пользоваться справочником

Начните с того, что уже известно: какие данные приложение должно получать или изменять, какой метод нужно вызвать или какие права выдать.

Например, для работы с клиентами откройте CRM. Там собраны методы для лидов, сделок, контактов, компаний и других объектов CRM. Для задач подойдет раздел Задачи, для файлов — Диск, для заказов интернет-магазина — Интернет-магазин.

Если знаете название метода, ищите его в профильном разделе или через поиск. По названию многих методов можно понять, с каким объектом работает метод и какое действие выполняет: crm.deal.add создает сделку, tasks.task.get получает задачу, disk.file.get получает файл.

Если название нужного метода неизвестно, откройте обзор разделов справочника и выберите подходящий раздел. На странице раздела есть список методов и ссылки на связанные материалы.

Права приложения проверяйте в разделе Скоупы методов. Скоуп определяет, к каким группам методов приложение может обращаться через REST API. Его указывают при настройке прав приложения.

Скоуп не открывает все данные сам по себе. Приложение увидит только те данные, к которым есть доступ у пользователя, от имени которого выполняется запрос.

Какая информация есть на страницах методовКакая информация есть на страницах методов

Страницы методов помогают подготовить отдельные запросы. В них указано, какое действие выполняет метод, какие параметры передать и какой ответ вернет сервер.

Они не описывают рабочий сценарий целиком. Если нужно решить задачу полностью, начните с обзорной страницы инструмента или посмотрите Туториалы.

Обзор разделов справочникаОбзор разделов справочника

Основы REST APIОсновы REST API

Раздел	Описание
Типы данных и форматы параметров	Базовые типы, форматы дат, файлов и сложных параметров
Скоупы методов	Права доступа приложения к группам методов
Общие методы и события	Системные методы, настройки приложения, пользователи и общие события
События	Регистрация, удаление и обработка событий REST API
REST 3.0	Методы и правила новой версии REST API
Устаревшие методы	Методы для поддержки существующих интеграций

Продажи и клиентыПродажи и клиенты

Раздел	Описание
CRM	Лиды, сделки, контакты, компании, смарт-процессы и связанные объекты
Интернет-магазин	Заказы, корзина, оплаты, отгрузки, кассы и события магазина
Торговый каталог	Товары, торговые предложения, цены, склады и складские документы
Платежные системы	Платежные обработчики и настройки оплаты
Генератор документов	Документы, шаблоны, нумераторы и роли
Подпись	Электронное подписание документов

Автоматизация и работа компанииАвтоматизация и работа компании

Раздел	Описание
Бизнес-процессы и роботы	Шаблоны, задания, роботы и действия бизнес-процессов
Задачи	Задачи, чек-листы, комментарии, шаблоны, стадии и потоки
Рабочие группы и проекты	Рабочие группы, проекты, участники и скрам
Календарь	Календари, события и ресурсы
Структура компании	Подразделения компании
Учет рабочего времени	Рабочее время, расписания и контроль времени
Пользователи	Пользователи и пользовательские поля

КоммуникацииКоммуникации

Раздел	Описание
Чаты	Чаты, сообщения, файлы, пользователи и уведомления
Бот-платформа	Чат-боты, команды, сообщения и события ботов
Открытые линии	Открытые линии, сессии, операторы, чаты и коннекторы
Телефония	Телефония, звонки и линии Voximplant
Провайдеры сообщений, СМС-провайдеры	Провайдеры сообщений и СМС-провайдеры
Лента новостей	Новости, комментарии и события ленты
Почтовые сервисы	Почтовые сервисы

Данные, файлы и контентДанные, файлы и контент

Раздел	Описание
Диск	Файлы, папки, хранилища, версии и права доступа
Как работать с файлами	Форматы передачи файлов в REST API
Хранилище данных	Хранилища и элементы данных приложения
Универсальные списки	Списки, разделы, поля и элементы
Сайты и магазины	Сайты, страницы, блоки, шаблоны и права
Онлайн-запись	Ресурсы, бронирования, лист ожидания, клиенты и события
Опросы, голосования	Опросы и голосования
Пользовательские соглашения	Пользовательские соглашения

Платформенные возможностиПлатформенные возможности

Раздел	Описание
Виджеты	Точки встраивания интерфейса приложения в Битрикс24
BIconnector	Источники, коннекторы и датасеты BI-аналитики
BitrixGPT	AI-возможности Битрикс24
Вайб	Виджеты и интерактивные элементы Вайба