Локальные приложения

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

Приложения делятся на статичные и серверные — по тому, где выполняется код. Серверные различаются наличием интерфейса, поэтому вариантов три:

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

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

Быстрый переход: как выбрать вид приложения

Пользовательская документация: Разработчикам: как создать вебхуки и приложения для Битрикс24

Связь с другими объектамиСвязь с другими объектами

Раздел Разработчикам. Локальные приложения создают и находят в разделе Приложения > Разработчикам. Что еще собрано в этом разделе, описано в статье Раздел Разработчикам в Битрикс24.

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

События и виджеты. Серверное приложение подписывается на события и добавляет виджеты в интерфейс Битрикс24.

Как начать работуКак начать работу

1. Проверьте условия. Локальное приложение работает, только если у Битрикс24 есть доступ к REST API — по подписке BitrixGPT + Маркетплейс или в пробном режиме. Создать приложение может администратор Битрикс24 или сотрудник, которому выдано право на создание приложений.

2. Определите, нужен ли приложению интерфейс внутри Битрикс24 и свой сервер. От этого зависит вид приложения — выберите его в таблице Как выбрать вид приложения.

3. Подготовьте код: для статичного приложения — архив со страницей на HTML и JS, для серверного — страницу или обработчик, доступный по HTTPS до того, как вы добавите приложение в Битрикс24.

4. Откройте форму локального приложения: Приложения > Разработчикам, вкладка Готовые сценарии, далее Другое > Локальное приложение.

5. Заполните форму: название, права доступа и поля выбранного вида — архив со страницей, адрес обработчика или адрес для первоначальной установки.

6. Сохраните приложение. Оно появится в списке Приложения > Разработчикам > Интеграции.

7. Перенесите в код на своем сервере код приложения и секретный ключ — Битрикс24 показывает их после сохранения формы. Если интерфейс приложению не нужен, оставьте поля Название пункта меню пустыми: тогда приложение не появится в левом меню.

Если пункта Локальное приложение нет, значит право на создание приложений закрыто. Попросите администратора настроить доступ к созданию приложений.

Как настроить доступ к созданию приложений для сотрудниковКак настроить доступ к созданию приложений для сотрудников

Сотрудник без прав администратора не может сам выдать себе доступ. Администратор может разрешить создание приложений всем сотрудникам или отдельным пользователям.

1. Откройте Настройки > Настройки Битрикс24. Раздел доступен только сотрудникам с правами администратора.
2. В новом окне перейдите в Безопасность > Интеграции Битрикс24.
3. Настройте права:
   • в поле Кому разрешить создавать приложения для всех нажмите Добавить и выберите всех сотрудников или отдельных пользователей
   • в поле Кому разрешить создавать свои приложения нажмите Добавить и выберите всех сотрудников или отдельных пользователей

Что важно учитыватьЧто важно учитывать

• Авторизация. Статичное приложение работает в интерфейсе Битрикс24, и JS SDK получает авторизацию открывшего его сотрудника автоматически. Серверное приложение с интерфейсом использует упрощенный вариант OAuth 2.0: приложение работает от имени сотрудника, который его открыл, а токены Битрикс24 передает странице приложения в POST-запросе — запрашивать их отдельно не нужно. Серверное приложение без интерфейса реализует полный протокол OAuth 2.0: оно само сохраняет токены в обработчике события ONAPPINSTALL и само их продлевает.
• Секреты. Код приложения, секретный ключ и полученные по ним токены храните на своем сервере. Не размещайте их в клиентском коде, который загружается в браузер, и не сохраняйте в репозитории.
• Права. Набор прав приложения — scope — выбирают при создании. Приложение работает в пределах выбранного scope и прав того сотрудника, который его создал: метод вернет ошибку, если нужного scope нет или у сотрудника нет прав на объект. Коды прав перечислены в статье Доступные скоупы Битрикс24.
• События. Статичное приложение события не получает: у него нет серверного обработчика, которому Битрикс24 мог бы их передать. Если приложение должно реагировать на изменение данных, выбирайте серверное или исходящий вебхук.

Как выбрать вид приложенияКак выбрать вид приложения

Продолжите изучениеПродолжите изучение

• Раздел Разработчикам в Битрикс24
• Входящие и исходящие вебхуки
• Локальные интеграции: сценарии использования
• Установка локальных приложений: обзор сценариев