Обработка-помощник для работы с REST API Битрикс24.
Текущий функционал:
- Работа через входящий вебхук или приложение
- Быстрый выбор выполняемого метода из списка
- Возможность указания дат в параметрах и отборах в человекочитаемом формате
- Возможность указания параметров произвольной сложности в формате JSON
- Хранение истории параметров в разрезе выполняемых методов
- Просмотр возвращаемых данных в виде строки JSON или дерева
- Удобное редактирование отбора и порядка для списочных методов
- Быстрый выбор полей отбора и порядка из списка для некоторых сущностей
- Возможность просмотра, добавления и удаления обработчиков событий (в режиме приложения)
- Удобный просмотр очереди офлайн-событий (в режиме приложения)
Как пользоваться:
1. Указать адрес вашего Битрикс24 в формате example.bitrix24.ru (без части https://)
2. Выбрать протокол для отправки запросов - HTTP или HTTPS
3.1. Для работы в режиме "Вебхук" необходимо указать код вебхука и ID пользователя вебхука.
Эти данные можно взять из адреса вебхука:
https://[Ваш Битрикс24]/rest/[ID пользователя]/[Код вебхука]/
Подробнее о том, как создать входящий вебхук или получить его адрес, можно посмотреть здесь.
После заполнения необходимых данных можно проверить подключение.
3.2. Для работы в режиме "Приложение" необходимо указать логин и пароль пользователя Битрикс24, от лица которого будут выполняться запросы, а также код приложения (client_id) и ключ приложения (client_secret). Подробнее о том, как создать приложение или получить его данные, можно посмотреть здесь.
Если вы создаёте приложение только для работы через данную обработку, то достаточно указать любой путь обработчика (например, https://example.com/), поставить галочку "Использует только API" и выбрать хотя бы одну область прав доступа (скоуп).
После заполнения необходимых данных необходимо выполнить авторизацию.
4. Если авторизация/проверка подключения успешны, можно приступать к работе. В случае возникновения ошибки при авторизации/проверке подключения следует внимательно проверить корректность заполнения всех необходимых для выбранного режима полей, доступность вашего Битрикс24 из текущей сети, а также наличие интернет-соединения.
Возможные проблемы:
- После обновления состава прав доступа (скоупов) приложения для вступления изменений в силу следует выполнить повторную авторизацию.
- Состав полей сущностей Битрикс24 кешируется. В случае обновления состава полей сущностей Битрикс24 для их корректного отображения в списках выбора отбора и порядка следует выполнить повторную авторизацию.
- Получение слишком большого количества записей очереди событий (десятки тысяч) может привести к превышению лимитов REST API Битрикс24. Не рекомендуется указывать слишком большое число получаемых записей очереди событий.
- Не все списочные методы Битрикс24 поддерживают полный список видов сравнения отбора. При этом поведение Битрикс24 при указании недоступного для этого метода вида сравнения может отличаться для разных методов. В случае наблюдения неожиданного результата запроса стоит обратиться к описанию метода в официальной документации REST API Битрикс24.
Обработка тестировалась на версии платформы 8.3.25.1520.
Вступайте в нашу телеграмм-группу Инфостарт