Документация и база знаний UtiClock

Настройка интеграции с Битрикс24

Данное руководство предназначено для администраторов Битрикс24. В нём описаны пункты, подразумевающие наличие соответствующих прав доступа к продукту и компетенций.

Требования к Битрикс24:
– Наличие подписки Битрикс24.Маркет Плюс
– Отдельный системный пользователь с правами администратора (рекомендуется)

Шаг 1. Установка модуля в Битрикс24

Архитектурная реализация REST API у компании Битрикс предполагает установку отдельного модуля на ваш Битрикс24.

Для установки модуля, пожалуйста, напишите нам на почту support@uticlock.ru (или в телеграмм @uticlock_support) письмо в свободной форме с указанием адреса вашего Битрикс24. В ответ мы пришлём ссылку на установку модуля. Запрос ссылки на установку модуля Битрикс24 в телеграм чате

Перейдите по ссылке и нажмите "Установить". Модуль UtiClock Assist в Битрикс24

Шаг 2. Создание переговорной комнаты

Здесь самым правильным решением будет смотреть официальную документацию Битрикс24 – Переговорные комнаты: как создать и забронировать.

Шаг 2.1. Получение ID переговорной комнаты

Получить ID переговорной комнаты можно через консоль разработчика в браузере.

Откройте список переговорных комнат в Битрикс24.
Выберите нужную комнату и кликните по названию правой кнопкой мыши.
В выпадающем списке нажмите "Посмотреть код" или "Исследовать элемент" (в разных браузерах может называться по разному).
Нам нужно найти HTML тег:

<li class="calendar-list-slider-item" data-bx-calendar-section="22"> ID вашей переговорной комнаты хранится в атрибуте data-bx-calendar-section. В примере это 22. У вас будет свой ID. Как получить ID переговорной в Битрикс24

Запишите его куда-нибудь. Он потребуется нам позже.

Шаг 3. Создание системного пользователя

Архитектура REST API Битрикс24 подразумевает, что все API запросы с планшета UtiClock в Битрикс24 должны выполняются от имени какого-то пользователя с соответствующими правами этого пользователя. Вы можете использовать любого текущего пользователя или создать нового пользователя.

В теории, можно использовать любого текущего пользователя, но мы рекомендуем создать отдельного системного «бота». Смотрите в официальной документации – Как пригласить сотрудников в Битрикс24.

Шаг 3.1. Настройка прав доступа

У «бота» должны быть следующие права:

  • Права на чтение и запись событий в календаре переговорной комнаты
  • Права на чтение ФИО и Email всех сотрудников
  • Права на чтение и запись событий в календарях сотрудников

Так он сможет оценить занятость переговорной и сотрудников при создании новых событий.

Самый простой способ настроить права – назначить этого "бота" администратором Битрикс24 (см. Как назначить администраторов). Если это не противоречит политики вашей компании, то мы рекомендуем именно этот вариант.

Если для вас это слишком просто, смотрите в официальной документации – Права доступа к календарю.

Шаг 3.2. Создать первое событие в календаре

Авторизуйтесь на компьютере в браузере под созданной учетной записью "бота" и забронируйте созданную переговорную комнату. Это нужно, чтобы проинициализировать все объекты и переменные.

Шаг 4. Подключение Битрикс24 на планшете

Перейдите на планшете в настройки UtiClock, откройте раздел интеграции и выберите Битрикс24.
*см. раздел Как открыть настройки UtiClock.

Заполните все поля и нажмите "Сохранить"

Если всё сделано правильно, события из переговорной Битрикс24 будут выводиться на планшете UtiClock.

Техническая схема работы с Битрикс24 в общих чертах

  • В Битрикс24 создаётся отдельный пользователь с соответствующими правами.
  • В Битрикс24 создаётся переговорная комната.
  • На планшете UtiClock вводится ID переговорной комнаты и логин/пароль пользователя из-под которого будут выполняться API запросы. Запросы в Битрикс24 должны идти от какого-то пользователя, поскольку так у них реализован REST.
  • При сохранении настроек на планшете UtiClock выполняется один запрос с передачей логина и пароля в Битрикс24, после чего Битрикс24 выдаёт специальные ключи доступа – Access и Refresh токены. Далее уже с помощью токенов происходит дальнейший обмен запросами.
  • Планшет делает REST API запрос на получение событий из календаря переговорной комнаты.
  • Битрикс24 возвращает информацию в формате JSON.
  • Планшет обрабатывает эти данные и на их основе выводит текущий статус и ближайшие события.

Никакие данные сотрудников и событий не передаются третьим лицам или на сторонние ресурсы.

Подробнее про работу REST API c Битрикс24 можно прочитать здесь: https://dev.1c-bitrix.ru/rest_help/rest_sum/index.php

Читайте так же