Серверное публичное приложение, встраиваемое в интерфейс Битрикс24
Просмотров: 33735
Дата последнего изменения: 21.12.2023
Сложность урока:
3 уровень - средняя сложность. Необходимо внимание и немного подумать.
1
2
3
4
5
Создание
Архив с примером содержит SDK CRest и два файла, которые представлят собой готовое приложение. Приложение обращается к REST API, встраивает всплывающие диалоги в списки контактов и компаний CRM и выводит данные объекта CRM, выбранного пользователем.
Внимание! Данный пример работает на основе SDK CRest. Перед использованием примера необходимо открыть через браузер файл checkserver.php и проверить корректность настроек вашего сервера. Для реального тиражного приложения необходимо пронаследовать класс CRest, переопределив методы getSettingData/setSettingData, которые занимаются получением/сохранением токенов авторизации в текстовый файл. Эти методы не предназначены для эксплуатации приложения на нескольких Битрикс24 одновременно. Подробнее.
Скачать архив:
Для создания решения, которое в дальнейшем может быть опубликовано в каталоге Битрикс24.Маркет, необходимо в кабинете разработчика решений открыть
Добавить приложение
, далее выбрать регион публикации. В открывшейся форме необходимо
выбрать или добавить
версию приложения:
Заполните доступные разделы системы (1) для данного примера значениями "CRM", "Пользователи", "Встраиваемые приложения". Ознакомьтесь с правилами публикации (2). Это необходимо для понимая требований, которые накладываются на тиражные решения.
В отличие от локальных приложений, тиражные решения состоят из версий. Каждая версия в дальнейшем подается на модерацию. (При модерации версии проверяется и карточка приложения). На этапе разработки и тестирования модерация не нужна, вы сами занимаетесь разработкой и доведением своего решения до полнофункционального состояния, включая
тестовые установки
на своих Битрикс24, и только потом подаете решение на модерацию.
После добавления версии приложения необходимо заполнить название (1) код приложения (2), категории (3), описание приложения (4), ценовую политику (5) и протестировать (6):
Описание обязательных полей (Нажмите на плюсик)
Смысл части обязательных полей понятен из названия, поясним то, что может вызвать затруднения.
В отличие от локальных приложений, у каждого тиражного решения необходимо задать уникальный символьный код. Код состоит из двух частей: вашего уникального символьного кода партнера (указывается в партнерской карточке) и части, которую вы присваиваете конкретному создаваемому приложению (2 на рис. выше).
Примечание: с самого начала задавайте вменяемые значения кода. Именно этот символьный код в дальнейшем будет присутствовать в публичном адресе вашего решения в каталоге Битрикс24.Маркет и заменить его в дальнейшем уже не получится.
Для простоты стоит указать, что приложение бесплатное (5). Перед подачей на модерацию вы сможете поменять этот и другие описательные параметры своего приложения.
Заполните описание решения на необходимых языках (4) и заполните обязательные поля с описаниями, а также прикрепить логотип решения и хотя бы один скриншот. На этапе разработки не обязательно вносить реальные и подробные описания, а также реальные скриншоты приложения. Но в дальнейшем, когда вы решите подавать готовое отлаженное решение на модерацию для публикации в каталоге, эти поля необходимо будет заполнить актуальной и полной информацией.
Можно сразу привязать его к нужной категории решений (3). Эти категории служат для навигации пользователей по
каталогу решений
.
Сохраните карточку приложения, заполнив все необходимые поля. Первый шаг сделан - фактически, вы подготовили описательную часть вашего будущего приложения. Теперь необходимо сформировать ту часть, которая отвечает за техническую реализацию.
Тестирование приложения
Для тестирования приложения, необходимо открыть
Тестировать в версии приложения
или
Протестировать в приложении
:
Укажите адрес вашего тестового Битрикс24 (1) и нажмите кнопку "Установить" (2). После установки приложения Битрикс24 выдаст сообщение "Приложение не найдено". Это нормальная ситуация, поскольку у нашего примера включена опция "Использовать только API" и оно ещё не опубликовано в публичном каталоге. Когда ваше приложение будет доступно в каталоге Битрикс24.Маркет, то Битрикс24 после установки будет оставлять пользователя на странице с описанием приложения.
Перейдите в список контактов или компаний. В контекстном меню любого контакта или компании в подменю "Приложения" теперь доступен пункт
"Public embedded form"
, при нажатии на который откроется слайдер с приложением.
Приложение
выведет отладочную информацию
о передаваемых авторизационных данных текущего пользователя, а также данные контакта (или компании, если его вызвать из списка компаний CRM), получая их по REST API с использованием этих авторизационных данных. Поскольку это приложение работает в интерфейсе Битрикс24 и использует авторизацию текущего пользователя, который открыл приложение, то оно действует исключительно только в рамках прав этого пользователя.
)
)
)
)
)
)
)
)
)
)
