Интерфейс и функционал приложения Rest Activity


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

По умолчанию бизнес-процессы в Битрикс24 используют формат JSON при задании параметров для REST-запросов. Синтаксис JSON довольно сложный, и поскольку поля в параметрах бизнес-процессов не имеют проверки на корректность записи, искать опечатки и ошибки достаточно не удобно. Приложение REST Активити Б24 от IT-Solution позволяет использовать при заполнении параметров бизнес-процессов не только JSON, но и форматы с более простым синтаксисом: YAML, TOML, XML.

Для работы приложения потребуются как минимум роботы, соответственно, тариф портала Битрикс24, на который устанавливается приложение, может быть любым, начиная с Базового. Приложение распространяется по Подписке на Маркет и имеет ограничение в 3000 запросов в месяц. Запросы обнуляются 1-го числа каждого месяца. Чтобы уточнить стоимость снятия такого ограничения, обращайтесь в чат поддержки.


Интерфейс приложения 

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


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



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



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



Вы также можете использовать данное активити в роботах, заполняя запрос аналогично действию бизнес-процесса. 


Результат можно использовать в следующем роботе, который находится на той же стадии.



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

Вы сможете использовать приложение для решения самых разных задач. Вот несколько примеров:

 

Для простых операций "Вытащить все элементы первого уровня вложенности" можно использовать простую конструкцию: $[*]."Имя ключа".  

Ниже приведем пример с $[*].name

{
    "name": "Vlad"
},
{    
    "name": "Dima"
}


Результат:

Совпадение #1:

Vlad

Совпадение #2:

Dima


Полезные ссылки 

1. Работа с бизнес-процессам в Битрикс24
2.
Документация по REST 
3. Плейлист по настройкам приложения на YouTube 




На какие вопросы отвечает эта статья:

1. Какой формат используют бизнес-процессы в Битрикс24 при задании параметров для REST-запросов?

2. Какие форматы позволяет использовать приложение REST-Активити от IT-Solution при заполнении параметров бизнес-процессов?

3. Что понадобится для установки приложения REST-Активити?

4. Какое ограничение по запросам имеет приложение REST-Активити?

5. Когда происходит обнуление счетчика количества запросов в REST-Активити?

6. Для решения каких задач можно использовать приложение REST-Активити?


Теги: rest rest activity