REST и вебхуки в 1С-Битрикс - вызовы снаружи и события
REST и вебхуки - подтема на 20 вопросов из собранных. Здесь собраны решения по вызовам снаружи и отправке событий наружу.
Что общего у этих задач
Вебхук - это ключ, привязанный к пользователю. Все действия через него выполняются от имени того, кто его создал, и ограничены правами этого человека. Отсюда первое следствие: вебхук уволенного сотрудника перестаёт работать вместе с его учётной записью.
Права выдаются по областям, а не по методам. Вебхук получает доступ к разделу целиком: к задачам, к CRM, к каталогу. Метод из невыданной области вернёт отказ, и по тексту ошибки это видно не всегда.
Исходящий вебхук - обратное направление. Не внешняя система зовёт сайт, а сайт зовёт её при наступлении события. Тайм-аут и отказ приёмника при этом не отменяют событие: платформа повторит вызов ограниченное число раз, а потом забудет о нём.
Решения подтемы
-
Вебхуки и вызовы REST: настройка, права, разбор ошибок - входящий и исходящий вебхук, права, ошибки вызова, повторы.
-
Приём вебхука от внешнего сервиса: точка входа, подпись, повторы - своя точка входа, проверка подписи, повторы, быстрый ответ.
-
Уведомления команде в мессенджер: вебхук, шаблон, ошибки - токен в настройках, отправка из события, фон, повторы.
-
Запрос к внешнему сервису не проходит: разбор причин - доступ наружу, сертификат, токен, лимит запросов.
-
Вызов внешнего сервиса из кода: таймауты, повторы, журнал - таймауты, разбор ответа, вынос из запроса посетителя, журнал.
-
Своё API для приложения: контроллер, токен, версии - контроллер, токен вместо сессии, формат ответа и версии.
-
Очередь обмена со сторонней системой: задания, повторы, сверка - задание вместо прямого вызова, повторы и сверка.
-
Заказы сайта в Битрикс24: вебхук, сопоставление, дубли - вебхук портала, поля сделки, дубли, очередь, статусы.
-
Очередь сообщений: фоновая обработка задач в ядре - сообщение и обработчик, брокер, режимы разбора, ограничения.
-
Вебхук от сервиса не доходит: разбор причин - код ответа и переадресация, защита, подпись, формат тела.
-
Мониторинг интеграций: что проверять, пороги, оповещение - метрики потока данных, пороги тишины, сводка и тревога команде.
-
Свои действия по REST: включение, ограничение, контекст - витрина модуля по REST, закрытие лишних действий, контекст вызова.
-
Веб-сервис SOAP на сайте: описание, WSDL и авторизация - описание сервиса, WSDL по адресу, авторизация Basic, картинки в Base64.
Частые вопросы
Чем вебхук отличается от приложения?
Вебхук - простой ключ для одного проекта, работает от имени создавшего его пользователя. Приложение проходит авторизацию с обновляемым токеном и подходит для решений, устанавливаемых на разные порталы.
Почему метод возвращает отказ по правам?
Область, к которой относится метод, не выдана вебхуку либо её нет у пользователя-владельца. Права вебхука не могут быть шире прав человека, от чьего имени он работает.
Куда приходят ошибки вызова?
В ответ самого вызова: код и текст ошибки возвращаются вместе с ответом. Отдельного журнала неудачных обращений в платформе нет.
Что будет, если приёмник исходящего вебхука недоступен?
Платформа повторит вызов несколько раз и прекратит попытки. Гарантии доставки у механизма нет, поэтому критичные события дублируют своей очередью.
Связанные темы
- Обмен с 1С и HTTP - устройство интеграций целиком
- Обмен: выгрузка товаров - штатный обмен вместо своего кода
- Мгновенные сообщения и push - другой способ доставки событий
- Раздел Интеграции