С чего начать

Документация по REST API Битрикс24 описывает методы API, примеры запросов и сценарии интеграции для разработки приложений и внешних сервисов.

Ниже — рекомендуемая последовательность изучения документации, которая поможет:

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

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

Как выбрать маршрутКак выбрать маршрут

Выберите маршрут по задаче:

• если нужно быстро проверить REST API, начните с разделов Доступ к REST API и Первый запрос к API
• если нужно встроить REST API в свой проект, изучите Настройку REST API, Примеры кода, SDK от Битрикс24 и Справочник API
• если нужно создать решение для своего Битрикс24 без публикации в Маркетплейсе, перейдите к Локальным интеграциям
• если нужно подготовить приложение для публикации и монетизации, изучите Тиражные приложения
• если нужно повторить готовый сценарий, откройте Готовые сценарии
• если нужно работать с AI-агентом, выберите AI-инструменты

Что подготовить перед началомЧто подготовить перед началом

Перед началом убедитесь, что:

• у вас есть Битрикс24, в котором доступна работа с REST API. Если доступа нет, начните со статьи Как получить доступ к REST API
• выбран способ подключения: входящий вебхук, локальное приложение или тиражное приложение. Настройки описаны в разделе Настройка и использование REST API
• у интеграции настроены права доступа к нужным инструментам Битрикс24. Какие скоупы нужны, зависит от методов, которые будет вызывать интеграция. Скоуп открывает доступ к группе методов, но не расширяет права пользователя, от имени которого выполняется запрос
• секреты вебхуков, токены и ключи приложения не попадают в публичный код и логи
• для интеграции учтены лимиты REST API на количество запросов

Доступ к REST APIДоступ к REST API

В разделе Как получить доступ к REST API описано, как активировать пробный период и получить доступ к REST API Битрикс24. Здесь же есть информация о NFR-ключах для партнерских разработок.

AI-инструментыAI-инструменты

Раздел AI-инструменты посвящен разработке с AI-агентами. С помощью Битрикс24 Вайбкод можно создать приложение по описанию задачи без знания языков программирования, а MCP-сервер подключает агента к официальной REST-документации прямо в среде разработки.

Настройка REST APIНастройка REST API

Раздел Настройка и использование REST API посвящен параметрам, которые влияют на работу интеграций:

• домены авторизации
• разрешения доступа
• особенности вызова методов
• конфигурация окружения
• ограничения на количество запросов

В разделе также есть статья Настройка доступов: облачная и коробочная версии, где описано, как настроить сетевой доступ для входящих и исходящих запросов и как добавить IP-адреса в список разрешенных.

Первый запрос к APIПервый запрос к API

Раздел Как выполнить свой первый запрос к API объясняет, как создать входящий вебхук и выполнить первый вызов метода REST API.

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

https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/profile.json

Данные метода приходят в поле result, служебная информация о запросе — в поле time. Полный ответ с описанием полей есть на странице метода profile, а здесь он сокращен:

{
    "result": {
        "ID": "1",
        "NAME": "Вадим",
        "LAST_NAME": "Валеев"
    },
    "time": {
        "duration": 0.0401120185852051
    }
}

Такой ответ значит, что вебхук работает. Какие скоупы нужны другим методам, указано на странице каждого метода.

Если вместо result пришли поля error и error_description, запрос не выполнился. Например, при ошибке в коде вебхука или ID пользователя Битрикс24 вернет:

{
    "error": "INVALID_CREDENTIALS",
    "error_description": "Invalid request credentials"
}

В этом случае сверьте ID пользователя и код с адресом вебхука в Битрикс24. Что означают другие коды, описано в статье Коды ошибок.

Примеры кодаПримеры кода

В разделе Как использовать примеры в документации описано, как устроен блок «Примеры кода» на страницах методов. Статья поможет выбрать вкладку под свою среду и способ авторизации, подставить значения вместо меток вида **put_your_webhook_here** и добавить код подключения. Там же есть чек-лист причин, по которым скопированный пример может не сработать.

SDK от Битрикс24SDK от Битрикс24

В разделе SDK для разработки под Битрикс24 описаны готовые библиотеки для разработки, которые ускоряют подключение и упрощают создание приложений для Битрикс24.

Локальные интеграцииЛокальные интеграции

Раздел Обзор инструментов для локальных интеграций посвящен инструментам для создания интеграций, которые работают с одним Битрикс24 и не требуют публикации в Маркетплейсе. В разделе есть примеры работы с локальными вебхуками и приложениями для автоматизации задач и обмена данными.

Готовые сценарииГотовые сценарии

Раздел Туториалы: готовые сценарии использования REST API содержит пошаговые руководства и готовые сценарии использования REST API Битрикс24. Например, как создать и настроить обработчик кассы или как получить адрес клиента из CRM. Примеры можно использовать как основу для собственных решений.

Тиражные приложенияТиражные приложения

В разделе Обзор тиражных приложений описаны принципы работы с тиражными приложениями из Битрикс24 Маркетплейс, а также возможности их монетизации и продвижения.

Справочник APIСправочник API

Раздел Справочник API содержит описание методов и возможностей REST API Битрикс24. Материал помогает ориентироваться в API и подбирать методы под конкретный функционал. Две версии API — старая и REST 3.0 — работают одновременно. Как выбрать между ними, описано в блоке Какую версию API выбрать.