REST API Битрикс24

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

Также было показано, как использовать обработчики событий на стороне приложений, в случае изменений происходящих в Битрикс24.

Для полной интерактивности в приложениях нам осталось познакомиться с одним сценарием: как эффективно обновлять пользовательский интерфейс приложения, открытого в Битрикс24, если изменения происходят на серверной стороне приложения.

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

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

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

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

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

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

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

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

Итак, мы понимаем, что во фрейме слайдера Битрикс24 прямо сейчас открыт наш index.php.

Откроем еще один браузер и откроем в его адресной строке файл из примера external.php. Фактически, этот файл представляет собой демонстрацию некой внешней системы, которая через REST сможет взаимодействовать с нашим порталом Битрикс24. Мы можем нажать на любую ячейку таблицы и перекрасить ее. В реальном режиме времени происходит обновление статуса аналогичной ячейки таблицы в отрытом слайдере приложения!

Давайте посмотрим, как работает эта магия.

Для начала посмотрим, что происходит в файле external. В нем живет очень простой обработчик клика на ячейку таблицы, который, с одной стороны переключает ее класс, а с другой стороны, делает ajax-вызов файла inform_app.php, передавая ему идентификатор и состояние нажатой ячейки таблицы.