Перейти к основному содержимому

Создание веб-перехватчиков для рабочих процессов

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

Свойства веб-перехватчика

Чтобы создать веб-перехватчик, необходимо настроить свойства веб-перехватчика и конечной точки, а затем выбрать типы событий Qlik Sense.

Свойства веб-перехватчика
Свойство Описание
Имя Имя веб-перехватчика.
Описание (необязательно) Описание веб-перехватчика.
URL-адрес URL-адрес для конечной точки веб-перехватчика. URL-адрес (конечная точка веб-перехватчика) должен быть полностью определенным именем домена (FDQN) и использовать протокол HTTPS. Конечная точка не может быть IP-адресом.
Секрет (необязательно) Секрет для проверки подлинности веб-перехватчика. Длина секрета не должна быть короче 32 символов и длиннее 64 символов. Если создается секрет веб-перехватчика, он является частью хэша, который добавляется к запросу HTTP как qlik-подпись.
Заголовки (необязательно)

Заголовки, которые могут быть добавлены к запросу HTTP.

Для каждого веб-перехватчика настраивается один или несколько типов событий.

Типы событий для веб-перехватчиков
Ресурс Типы события
Приложения Создано, Удалено, Данные обновлены, Перезагружено, Опубликовано, Экспортировано
Примечание: Событие обновления данных относится к обновляемым данным. Событие перезагрузки относится к приложению Qlik Sense и связанным перезагружаемым таблицам данных.
Пользователи Создано, Удалено

Веб-перехватчик ожидает одного из событий, и когда оно случается, то данные о событии передаются конечной точке веб-перехватчика. Данные передаются на URL-адрес конечной точки в виде запроса JSON.

Примечание: Для получения дополнительной информации о полезных нагрузках события см. раздел Портал разработчиков Qlik: события API.

Пример: Запрос JSON для типа события «приложение удалено»

Request URL https://api.blendr.io/v1/widgets/F502987A-AF89-4992-8127-F28794C5A74A?X-Execution-Token=xxxxx Headers {     "Content-Type": "application/json",     "Qlik-Signature": "446bd5e3f5b635f491d17557e4bec6ebc61b7bd2bc9cc7b612e4e",     "User-Agent": "Qlik Webhook" } Body {     "cloudEventsVersion": "0.1",     "source": "com.qlik/engine",     "contentType": "application/json",     "eventId": "e65c1481-e8a-4be-a5ca-27dfcde077d7",     "eventTime": "2021-03-08T14:51:29Z",     "eventTypeVersion": "1.0.0",     "eventType": "com.qlik.v1.app.deleted",     "extensions": {         "ownerId": "vNRGrDZIypJzauw59BbpvkRhqbmI",         "tenantId": "oZcMPa_1PwH4FUdrh6839YHHdEJN",         "userId": "vNRGrDZIypJtcGTzauw59BbpqbmI"     },     "data": {         "attributes": {             "id": "0984fec4-aa8c-4253-b1d1-4fd4f9c78",             "name": "New App",             "createdDate": "2021-03-08T14:51:28.888Z",             "modifiedDate": "2021-03-08T14:51:29.316Z",             "owner": "auth0|b62a17c577a4abe6e807b07d18c4d82286352542d633d120100b03fb11",             "ownerId": "vNRGrDZIypJtcGTzauw59BbpvbmI",             "published": false,             "hasSectionAccess": false         }     } }

Создание веб-перехватчика

Чтобы создать веб-перехватчик, в Management Console выберите Интеграция > Веб-перехватчики.

Примечание: Можно создать не более 100 веб-перехватчиков для каждого клиента.
  1. В правом верхнем углу щелкните Создать.

  2. В диалоговом окне Создание веб-перехватчика введите имя для веб-перехватчика.

  3. Добавьте необязательное описание.

  4. Введите URL-адрес для стороннего приложения интеграции.

  5. Дополнительно укажите секрет для добавления к запросу HTTP.

  6. Дополнительно укажите заголовки HTTP для добавления к запросу.

  7. В разделе События выберите тип события для веб-перехватчика.

  8. По окончании щелкните Создать.

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

Таблица веб-перехватчиков Management Console
Подсказка: Чтобы включить или выключить веб-перехватчик, нажмите кнопку Значок троеточия в пользовательском интерфейсе, открывающий меню параметров для веб-перехватчика в конце строки веб-перехватчика и выберите Включить веб-перехватчик или Отключить веб-перехватчик. Веб-перехватчики по умолчанию включены.
Подсказка: Можно выполнять сортировку или поиск веб-перехватчиков в таблице, щелкая значок Значок стрелки вверх и вниз для сортировки значений столбца над любым столбцом для изменения порядка сортировки или значок фильтра Значок фильтра вверху столбца каждого веб-перехватчика над каждым столбцом для поиска вручную. Фильтр поиска находит полные и частичные соответствия.

Изменение веб-перехватчика

Чтобы изменить веб-перехватчик, в Management Console выберите Интеграция > Веб-перехватчики.

  1. Нажмите кнопку Значок троеточия в пользовательском интерфейсе, открывающий меню параметров для веб-перехватчика в конце строки веб-перехватчика, который требуется изменить.

  2. Щелкните Изменить.

    Откроется панель редактирования с параметрами для изменения конфигурации веб-перехватчика.

  3. Внесите необходимые изменения и нажмите кнопку Сохранить.

Удаление веб-перехватчика

Чтобы удалить веб-перехватчик, в Management Console выберите Интеграция > Веб-перехватчики.

  1. Выберите веб-перехватчик для удаления.

  2. В правом верхнем углу щелкните Удалить.

  3. Всплывающее диалоговое окно откроется для подтверждения выбора. Щелкните команду Удалить.

Просмотр истории веб-перехватчиков

Чтобы просмотреть историю веб-перехватчиков, в Management Console выберите Интеграция > Веб-перехватчики.

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

    Отобразится история веб-перехватчика.

    История веб-перехватчиков Management Console

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

  • Чтобы просмотреть содержание ответа на событие, нажмите кнопку Значок стрелки вниз в пользовательском интерфейсе для разворачивания меню «Полезная нагрузка события» в конце строки события.

    Информация о полезной нагрузке типа события веб-перехватчика Management console