Просмотров: 192318
Дата последнего изменения: 21.12.2023
Сложность урока:
3 уровень - средняя сложность. Необходимо внимание и немного подумать.
1
2
3
4
5
Описание
Краткое описание механизма вебхуков: через пользовательский интерфейс Битрикс24 можно получить и зафиксировать ключ авторизации. Этот ключ в дальнейшем можно использовать для вызова методов REST, и при этом данный ключ не ограничивается по сроку действия (в отличие от токенов авторизации протокола OAuth 2.0).
Это делает вебхуки исключительно простым и удобным механизмом для работы с REST, но при этом надо понимать, что эта простота имеет и свои недостатки:
Для формирования вебхука требуется участие пользователя (вы не сможете генерировать вебхуки автоматически);
Поскольку срока действия у вебхука нет, то любая "утечка" URL вебхука чревата получением доступа к вашему Битрикс24 в рамках прав конкретного вебхука. Именно поэтому данный механизм годится для "внутренних" интеграций, но не подходит для тиражных вариантов использования;
Ряд методов REST недоступен для работы через вебхуки, поскольку их логика требует "контекста" приложения, а никакого приложения в терминах Битрикс24 для вебхуков нет (в частности, методы встраивания приложений в интерфейс Битрикс24, события телефонии, часть событий чат-ботов и т.д.).
Но несмотря на эти ограничения, для подавляющего большинства задач интеграции в рамках конкретного проекта вебхуки представляются идеальным вариантом работы с REST API.
Внимание! До версии 22.300.0 модуля REST невозможно обратиться к модулям в названии которых присутствует точка. Например: zenden.shop, zenden.exchange и подобное.
Создание Входящего вебхука
Входящий вебхук используется для работы с данными вашего Битрикс24 через API.
Создать входящий вебхук можно из раздела
Разработчикам
Начиная с версии модуля REST 20.5.0, доступен новый раздел Разработчикам (Приложения > Разработчикам), в котором собраны удобные инструменты для облегчения работы по интеграции и доработке вашего Битрикс24.
в генераторе запросов выберите метод REST API (можно прочитать описание метода и скачать готовый пример кода с необходимыми параметрами для выполнения запросов);
проверьте работу вебхука, нажав на кнопку Выполнить;
укажите права доступа, разрешив выполнять запросы только определенным инструментам Битрикс24.
В генераторе запросов будет представлен образец URL, который нужно использовать при отправке данных из сторонней системы в Битрикс24
URL состоит из:
doc-test-b24.bitrix24.ru - адрес вашего Битрикс24
/rest - указание на то, что работа ведётся через rest с вебхуками
Внимание! Данный код является конфиденциальной информацией. Его необходимо держать в секрете.
Секретные коды чужих вебхуков недоступны даже администратору. Если администратор отредактирует чужой вебхук, то секретный код будет сброшен, и владельцем этого вебхука станет администратор.
/crm.contact.get - вызываемый метод
REST APIБитрикс24 - программный продукт в виде облачного сервиса, а также коробочной версии, созданный компанией "1С-Битрикс".
Разработчики могут создавать собственные приложения или интеграции для Битрикс24, используя открытый REST API, который работает как с облачным, так и с коробочным Битрикс24, а также с "1С-Битрикс: Управление сайтом" начиная с версии 16.6.0.
Подробнее...
. В данном случае - метод, возвращающий контакт по идентификатору
.json - необязательный параметр ("транспорт"). При создании новых вебхуков можно не указывать (по умолчанию будет использоваться .json). В конструкторе готовых решений .json подставляется явно
?ID=42 - параметры, необходимые для конкретного метода. В данном случае - идентификатор. Параметры указываются после вопросительного знака и разделяются символом &
Создание входящих вебхуков до версии модуля REST 20.5.0
В выпадающем меню Добавить вебхук выберите Входящий вебхук.
В открывшейся форме заполните поля:
Название и Описание - произвольные данные.
Права доступа - укажите, к каким модулям вебхук должен иметь доступ. Доступен множественный выбор.
После сохранения появится код для авторизации вебхука:
Внимание! Данный код является конфиденциальной информацией. Его необходимо держать в секрете.
Вместе с кодом будет представлен образец URL, который нужно использовать при отправке данных из сторонней системы в Битрикс24: https://********.bitrix24.ru/rest/1/83te1pjdphsa9u15/profile/
где:
******** - имя вашего портала;
/rest/ - указание системе на то, что данный адрес относится в вебхукам;
/1/ - идентификатор пользователя, создавшего вебхук. Под правами этого пользователя будет работать этот вебхук.
/83te1pjdphsa9u15/ - секретный код;
/profile/ - метод REST, который вы хотите выполнить, обращаясь к вебхуку. Разработчик должен сам подобрать метод из REST API в зависимости от целей создания вебхука.
Обратиться из сторонней системы по указанному адресу на Битрикс24.
Рассмотрим пример такого обращения с задачей создать лид из формы. Необходимо URL вебхука заполнить в константе C_REST_WEB_HOOK_URL файла settings.php, сформировать параметры для создания лида в переменной $queryData и разместить код из примера ниже в файле index.php SDK CRest.
Внимание! Данный пример работает на основе SDK CRest. Перед использованием примера необходимо открыть через браузер файл checkserver.php и проверить корректность настроек вашего сервера. Подробнее.
Внимание! Для работы исходящего вебхука в коробочной версии Битрикс24 обязательна активная лицензия, на демо-порталах исходящий вебхук работать не будет.
Исходящий вебхук используется для получения информации о событиях, происходящих в вашем Битрикс24.
Создать исходящий вебхук можно из раздела
Разработчикам
Начиная с версии модуля REST 20.5.0, доступен новый раздел Разработчикам (Приложения > Разработчикам), в котором собраны удобные инструменты для облегчения работы по интеграции и доработке вашего Битрикс24.
укажите URL вашего обработчика - страницу на стороннем ресурсе, куда будет обращаться вебхук;
выберите событие, на которое будет инициализироваться вебхук.
При создании исходящего вебхука будет выведен токен в виде строки из случайных знаков. Этот код позволит внутри обработчика проверить, действительно ли обработчик вызван вашим Битрикс24.