REST API Битрикс24

Чаще всего, приложения для Битрикс24 имеют пользовательский интерфейс, открываемый по клику в левом меню. Именно поэтому, при добавлении приложения в кабинете разработчика, оно создается с некоторыми настройками «по умолчанию».

Зайдем в кабинет разработчика и создадим новое приложение, как мы это делали в предыдущем уроке.

Нажмем кнопку «Добавить приложение». Выберем, как и ранее, основной регион для будущей публикации решения. В карточке приложения нажмем на кнопку «Создать» и укажем тип «Использовать REST API».

Обратите внимание на пункт «Добавлять свою страницу и пункт в главном меню». Если он отмечен, то при установке приложения в Битрикс24 в левое меню будет добавлен пункт, по клику на который будет открываться слайдер с интерфейсом приложения.

Где находится пользовательский интерфейс приложения? Его формирует тот самый URL, который мы указываем в поле «Ссылка на приложение» и который открывается внутри фрейма в слайдере.

Откуда берется название пункта левого меню? Мы должны задать его в описаниях приложения. Сделать это можно на нескольких языках. Как минимум, это необходимо сделать на базовом языке того региона, в котором будет в дальнейшем опубликовано приложение.

Очевидно, что для региона RU это русский язык.

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

Скопируем значения из полей client_id, client_secret и вставим их в соответствующие константы в файле settings.php.

Вернемся в кабинет разработчика. Текущая страница позволит нам установить приложение на наш Битрикс24 и протестировать его до публикации в Битрикс24.Маркет.

Укажем адрес своего Битрикс24, на котором мы являемся администратором и нажмем Установить.

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

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

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

Такой способ существует и основан на механизме встройки виджетов. Мы расскажем о нем подробнее в соответствующем уроке!