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