Как получить доступ к REST API

Выберите инструмент для разработки с AI-агентом:

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

Получить доступ к REST API можно тремя способами:

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

Постоянный доступ

Чтобы работать с REST API без ограничений пробного периода, оформите подписку Маркетплейс. Она доступна на платных тарифах Битрикс24, стоимость зависит от тарифа.

Проверьте текущий тариф в разделе Мой тариф в главном меню Битрикс24. Если Битрикс24 на бесплатном тарифе — выберите и активируйте подходящий тариф.
Оформите подписку Маркетплейс. Перейдите в Мой тариф > Подписка на BitrixGPT + Маркетплейс и нажмите Купить подписку.

Пробный доступ

Перед оформлением платной подписки вы можете активировать пробную версию Маркетплейса. В этот период REST API будет доступен для тестирования и разработки.

Чтобы включить пробный режим:

Перейдите в виджет Мой тариф в верхнем меню Битрикс24.
В разделе BitrixGPT + Маркетплейс нажмите Включить демо.

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

Пробная подписка Маркетплейс

Доступ для технологических партнеров

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

Чтобы получить NFR-ключ:

Зарегистрируйтесь как технологический партнер. Заполните анкету на сайте кабинета разработчика и нажмите кнопку Стать партнером.
После получения доступа в кабинет разработчика отправьте заявку на NFR-ключ через внутренний чат поддержки.

Что влияет на выполнение запросов

После активации доступа результат запроса зависит от прав пользователя, scope и сетевых настроек Битрикс24.

Права пользователя

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

Чтобы получить максимальный доступ, используйте учетную запись администратора.

Ограничения через scope

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