REST Активити Б24

---

Установка приложения в Битрикс24

Для того чтобы начать использовать приложение «REST Активити Б24» на вашем портале Битрикс24, необходимо скачать его по ссылке или выполнить следующие действия:

1. Поиск приложения

Перейдите в раздел Маркет вашего портала Битрикс24, в строке поиска введите название «REST Активити Б24» и выберите его из предложенного списка.

2. Открытие страницы приложения

После выбора приложения вы попадете на страницу с его описанием, где можно ознакомиться c функционалом и возможностями.

3. Установка приложения 

Нажмите кнопку «Установить», поставьте галочки в чекбоксах условий соглашения, а затем снова нажмите на кнопку «Установить».

4. Доступ к приложению

После завершения установки приложение будет доступно в главном меню вашего портала Битрикс24.

Права доступа

1. Администратор портала — неограниченный доступ к функционалу приложения, доступны все имеющиеся вкладки.

2. Обычный пользователь — доступны лишь две вкладки приложения: «Информация» и «Проверка запросов».

Интерфейс в Битрикс24

Нажав на приложение в главном меню вашего портала Битрикс24, откроется окно, вверху которого будут прописаны добавленные роботы.

Ниже представлено несколько вкладок, разберем их более подробно:

1. Информация

В данной вкладке представлена общая информация о приложении «REST Активити Б24»:

1) Описание приложения.

2) Интерфейс и функционал приложения.

3) Задачи, которые можно решить с помощью данного приложения.

4) Полезные ссылки на документацию.

2. Проверка запросов 

Данная вкладка предоставляет возможность проверить работу любого необходимого вам запроса перед тем, как использовать его непосредственно в Роботах или Бизнес-процессах. Для этого:

1) В поле «REST-метод» найдите метод, который вас интересует.

2) При необходимости задайте параметры запроса в соответствующем поле.

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

3) Нажмите кнопку «Выполнить».

В крайнем правом поле отобразится ответ на ваш запрос:

• зеленое поле, если выполнение прошло успешно;

• красное поле (ошибка), если выполнение прошло не успешно.

В самом низу страницы представлен список последних проверенных запросов.

3. Статистика запросов

В данной вкладке отображается статистика выполненных запросов за определенный период.

4. Очередь запросов

В данной вкладке фиксируется история выполнения всех запросов, которые использует приложение «REST Активити Б24».

5. Настройки

В данной вкладке можно выбрать режим работы приложения и настроить логирование. 

Функционал приложения

Бизнес-процессы

1. В конструкторе бизнес-процессов появится блок «Действия приложений» (в него можно перейти с помощью стрелочку в самом конструкторе, а также через правую панель), откуда можно выбрать любое из действий приложения: SnapApi, Вебхук, Получить параметр или Получить пользователя.

2. В настройке параметра действия можно ввести REST-запрос в любом из доступных форматов: json, yaml, xml или toml. Выберите метод в поле «REST-метод» и введите запрос. 

Обратите внимание, если в настройке параметров действий в поле «Списочный метод» из раскрывающегося списка выбрать «Нет», то будет включено ограничение — за один раз можно получить не более 50 записей. Если выбрать «Да», то за один раз можно получить неограниченное количество записей.

Роботы

1. Перейдите в роботы → «Другие роботы», выберите необходимый и нажмите «Добавить».

2. Заполните запрос аналогично действию бизнес-процесса.

Результат можно использовать в следующем роботе, который находится на той же стадии. Для этого перейдите в «Роботы», нажмите на кнопку «+» на нужной стадии. Затем выберите необходимого робота из списка и нажмите «Добавить». В появившемся окне рядом с полем «Текст сообщения» нажмите на троеточие, выберите из выпадающего списка робота и нажмите «Сохранить».