6  /  44

Серверное локальное приложение без интерфейса в Битрикс24

Просмотров: 18663

Установка

Пример состоит из SDK CRest и PHP-файла с примером, которые вы должны разместить на своем веб-сервере до добавления приложения в свой Битрикс24. Приложение умеет получать авторизацию пользователя Битрикс24 и используя ее, находясь при этом вне Битрикс24, обращаться к REST API, получая ФИО пользователя, установившего приложение.

Внимание! Данный пример работает на основе SDK CRest. Перед использованием примера необходимо открыть через браузер файл checkserver.php и проверить корректность настроек вашего сервера. Подробнее.

Скачать архив:

Для установки локального приложения нужно перейти по цепочке: Приложения 1 - Добавить приложение 2 - Добавить приложение 3:

Нажмите на рисунок, чтобы увеличить

В открывшейся форме заполнить базовые поля и указать необходимые для приложения права (для нашего примера нужны права на управление пользователями), указав URL приложения (это означает, что ваше приложение уже должно быть физически доступно по URL по протоколу HTTPS до того, как вы станете добавлять его в ваш Битрикс24)

Необходимо включить опцию Приложение использует только API - именно она указывает Битрикс24, что ваше приложение не будет показывать пользовательский интерфейс внутри Битрикс24. В этом случае, как вы увидите, в форме будут скрыты поля, в которых обычно указывается название пункта меню для вызова приложения из Битрикс24. Приложения, у которых включена опция "Приложение использует только API" либо предоставляют пользовательский интерфейс по какому-то своему URL, либо вообще не предоставляют пользовательский интерфейс:

Нажмите на рисунок, чтобы увеличить

Обратите также внимание на то, что мы заполнили поле Укажите ссылку-callback для события установки, указав install.php из архива с примером. Этот URL вызывается только один раз при сохранении формы локального приложения. Именно этот URL служит обработчиком события ONAPPINSTALL, в котором мы и сохраняем токены пользователя установившего приложение. Если вы захотите обновить сохранённые токены в ручную можно в списке приложений у приложения выбрать пункт "Переустановить".

После сохранения вы останетесь в форме добавления приложения, но Битрикс24 вам сразу покажет ключи авторизации для протокола OAuth 2.0, которые вам потребуются внутри кода приложения:

Поскольку приложение без интерфейса работает "вне" Битрикс24, то оно должно реализовывать полный протокол авторизации OAuth 2.0. Откройте из примера файл settings.php и заполните константы с кодом приложения C_REST_CLIENT_ID1 и секретным ключом C_REST_CLIENT_SECRET2 полученными при сохранении формы.

Загрузите измененный пример на свой сервер.

В Битрикс24 можно перейти в список "Мои приложения" и убедиться в появлении нового приложения в списке локальных приложений в вашем Битрикс24:

Нажмите на рисунок, чтобы увеличить

Использование

Внимание! Данный пример работает на основе SDK CRest. Перед использованием примера необходимо открыть через браузер файл checkserver.php и проверить корректность настроек вашего сервера. Подробнее.

Откройте файл index.php из примера в браузере по вашему URL:

Запущенное приложение выведет ФИО пользователя установившего приложение, получая его по REST API с использованием авторизационных данных сохраненных при создании приложения и автоматически продлевая токены, если при запросе окажется что они недействительны.


5
Курсы разработаны в компании «1С-Битрикс»

Если вы нашли неточность в тексте, непонятное объяснение, пожалуйста, сообщите нам об этом в комментариях.
Развернуть комментарии