Создание вебхуков

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

Предварительные условия, необходимые для создания вебхуков

Прежде чем создавать вебхуки, обратите внимание на следующее:

Чтобы использовать вебхуки, ваша организация должна использовать ArcGIS Enterprise версии 10.7 или новее. Для использования вебхуков сервиса ваша организация должна использовать ArcGIS Enterprise 11.0 или новее.
Чтобы создавать вебхуки организации и управлять ими, вам необходимы либо права Вебхуки организации, либо использовать роль администратора по умолчанию.
Чтобы создавать вебхуки сервиса геообработки и управлять ими, вам необходимы либо права Геообработка, либо использовать роль администратора по умолчанию.

Примечание:

Пользователям, которым назначены права Геообработка, также потребуется добавить к их пользовательской роли права Публикация серверных слоев.
Чтобы создавать вебхуки сервиса объектов и управлять ими, вам необходимы либо права Сервис объектов, либо использовать роль администратора по умолчанию.
{data-pivot='os-linux'} Приемники вебхуков должны быть настроены для связи по HTTPS. Существует несколько поддерживаемых вариантов для приемников, таких как сторонние веб-сервисы (Microsoft Power Automate, Zapier и IFTTT), пользовательские веб-сервисы, ArcGIS Notebook Server и ArcGIS Workflow Manager. Примеры того, как можно создать пользовательские веб-сервисы или начать использовать сторонние приемники, см. в Репозиторий вебхука. Чтобы узнать больше о создании вебхуков Notebook Server и Workflow Manager, см. Автоматизация рабочих процессов с помощью ArcGIS Notebooks и Создание заданий с помощью вебхуков, соответственно.
{data-pivot='os-windows'} Приемники вебхуков должны быть настроены для связи по HTTPS. Существует несколько поддерживаемых вариантов для приемников, таких как сторонние веб-сервисы (Microsoft Power Automate, Zapier и IFTTT), пользовательские веб-сервисы, ArcGIS Notebook Server и ArcGIS Workflow Manager. Примеры того, как можно создать пользовательские веб-сервисы или начать использовать сторонние приемники, см. в Репозиторий вебхука. Чтобы узнать больше о создании вебхуков Notebook Server и Workflow Manager, см. Автоматизация рабочих процессов с помощью ArcGIS Notebooks и Создание заданий с помощью вебхуков, соответственно.
Чтобы настроить вебхуки для размещенного сервиса объектов, этот сервис должен поддерживать возможность редактирования, и у него должна быть включена функция отслеживания изменений без синхронизации.
Чтобы настроить вебхуки для неразмещенного сервиса объектов, данные многопользовательской базы геоданных, на которую ссылается этот сервис, должны отвечать требованиям, установленным для отслеживания изменений, и соответствовать одному из следующих условий:
- Это - неверсионный сервис объектов с включенным архивированием и с глобальными идентификаторами.
- Это - сервис-ориентированная версия сервиса объектов с отключенной функцией Управления версиями, когда изменения применяются непосредственно к объектам версии по умолчанию.
- Это - сервис-ориентированная версия сервиса объектов с включенной функцией Управления версиями. Когда поддерживается возможность Управления версиями, сервис может создавать вебхук с триггером событий FeaturesPosted, который будет вызывать вебхук всякий раз, когда на данном сервисе будет выполняться операция закрепления.
Примечание:

Поддержка сервис-ориентированных версий сервисов объектов была добавлена в ArcGIS Enterprise 11.3.
Чтобы настроить вебхуки для сервиса геообработки, сервис должен быть асинхронным.

Настройка вебхуков организации

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

Создание вебхука организации

Чтобы создать вебхук организации через веб-сайт портала ArcGIS Enterprise, выполните следующие шаги:

Убедитесь, что вы вошли под учетной записью администратора по умолчанию или участника с пользовательской ролью, имеющей права Вебхуки организации.
Перейдите к Организация > Настройки > Вебхуки.
В разделе Вебхуки организации щелкните Создать вебхук.
В окне Создать вебхук сделайте следующее:
1. Введите уникальное имя вебхука в текстовом окне Имя.
2. Выберите тип вебхука из ниспадающего меню Тип.
  - При выборе Все вы будете подписаны на все поддерживаемые триггеры событий. Вы будете получать уведомления о каждом событии, как только оно произойдет.
  - Выбор Элементы, Пользователи, Группы или Роли позволяет вручную определить, на какие триггеры событий вы хотите подписаться.
3. Если вы выберете тип вебхук, отличный от Все, появится дополнительное ниспадающее меню, зависящее от выбранного типа вебхука. Например, если вы выбрали Элементы в качестве типа вебхука, появится ниспадающее меню Элементы, где можно выбрать определенный элемент, который вебхук будет отслеживать.
4. Выберите триггеры событий в ниспадающем меню События. Например, если вы хотите, чтобы вебхук вызывался при публикации определенного элемента, выберите /items//publish.
5. Выберите тип приемника вебхука.
  - Если вы выбрали URL-адрес приемника вебхука, укажите целевой URL для приемника вебхука. Пример целевого URL-адреса показывается ниже:
  https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow
  - Если вы выбрали Блокнот, выберите блокнот, который будет запускаться при срабатывании вебхука.
    
    Примечание:
    
    Если опция Блокнот недоступна, значит, Notebook Server не настроен на работу с вашим порталом. Если опция доступна, но ее невозможно выбрать, значит, у вас нет блокнотов, подходящих для настройки вебхуков. У вас должен быть элемент блокнота, который будет использоваться для вебхука.
6. При необходимости установите секретное значение для вебхука в текстовом поле Секретный ключ (дополнительно). Секретное значение будет использоваться для создания подписи, которая будет включена в заголовки полезной нагрузки вебхука. Получатель вебхука может использовать эту подпись, чтобы определить, следует ли доверять сообщению.
Щелкните Создать вебхук.

Настройка дополнительных параметров для вебхуков организации

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

Для настройки дополнительных параметров через веб-сайт портала ArcGIS Enterprise, выполните следующее:

Войдите под учетной записью администратора по умолчанию или участника с пользовательской ролью, имеющей права Вебхуки организации.
Перейдите к Организация > Настройки > Вебхуки.
В разделе Вебхуки организации щелкните Дополнительные настройки.
В окне Дополнительные настройки сделайте следующее:
1. Установите значение для Количество попыток доставки.
  
  Это значение указывает количество попыток доставки полезных данных вебхука. По умолчанию ArcGIS Enterprise будет пытаться доставить полезные данные 3 раза. Значение для попыток должно быть задано целым числом от 0 до 5.
2. Установите значение для Время ожидания уведомления.
  
  Это значение указывает длительность времени в секундах, в течение которого ArcGIS Enterprise будет ожидать ответ от получателя. По умолчанию ArcGIS Enterprise будет ждать 10 секунд. Значение количества секунд ожидания должно быть целым числом в диапазоне от 0 до 60 секунд.
3. Установите значение для Время, прошедшее с момента уведомления.
  
  Это значение показывает продолжительность, в секундах, между каждой попыткой доставки полезных данных. По умолчанию ArcGIS Enterprise попытается доставить другие полезные данные через 5 секунд, если предыдущая попытка не удалась, пока не будет достигнуто количество попыток, указанное в поле Количество попыток доставки.
Щелкните Сохранить.

Обновленные свойства будут применены ко всем настроенным вебхукам организации.

Настройка вебхуков сервиса

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

Создание вебхука сервиса

Для создания вебхука сервиса геообработки или сервиса объектов выполните следующие шаги:

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

Примечание:

Участники, которым назначена роль издателя (publisher), не смогут создавать вебхуки сервиса или управлять ими из организации, и им необходимо будет выполнять эти рабочие процессы с помощью административного API.
Перейдите к Организация > Настройки > Вебхуки.
В разделе Слой объектов и веб-хуки сервиса щелкните Создать вебхук.
В окне Создать вебхук сделайте следующее:
1. Введите уникальное имя вебхука в текстовом окне Имя.
2. Выберите сервис в ниспадающем меню Элемент.
  
  Примечание:
  
  Если вы выбрали сервис геообработки, событие будет задано как Сервис завершен. Если вы выбрали сервис объектов, вы увидите ниспадающее меню События.
3. При выборе вебхука сервиса объектов выберите триггер события в ниспадающем меню События. Например, если вы хотите, чтобы вебхук вызывался при добавлении в редактирование нового вложения, выберите созданные вложения AttachmentsCreated.
4. Выберите тип приемника вебхука.
  - Если вы выбрали URL-адрес приемника вебхука, укажите целевой URL для приемника вебхука. Пример целевого URL-адреса показывается ниже:
  https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow
  - Если вы выбрали Приемник вебхуков блокнота, выберите блокнот, который будет запускаться при срабатывании вебхука.
    
    Примечание:
    
    Если опция Блокнот недоступна, значит, Notebook Server не настроен на работу с вашим порталом. Если опция доступна, но ее невозможно выбрать, значит, у вас нет блокнотов, подходящих для настройки вебхуков. У вас должен быть элемент блокнота, который будет использоваться для вебхука.
5. При необходимости установите секретное значение для вебхука в текстовом поле Секретный ключ (дополнительно). Секретное значение будет использоваться для создания подписи, которая будет включена в заголовки полезной нагрузки вебхука. Получатель вебхука может использовать эту подпись, чтобы определить, следует ли доверять сообщению.
Щелкните Создать вебхук.

Настройка дополнительных параметров для вебхуков сервиса

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

Для настройки расширенных свойств выполните следующее:

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

Примечание:

Участники, которым назначена роль издателя (publisher), не смогут создавать вебхуки сервиса или управлять ими из организации, и им необходимо будет выполнять эти рабочие процессы с помощью административного API.
Перейдите к Организация > Настройки > Вебхуки.
В разделе Слой объектов и веб-хуки сервиса щелкните Дополнительные настройки.
В окне Дополнительные настройки сделайте следующее:
1. Установите значение для Количество попыток доставки.
  
  Это значение указывает количество попыток доставки полезных данных вебхука. По умолчанию система будет пытаться доставить полезные данные 3 раза. Значение для попыток должно быть задано целым числом от 0 до 5.
2. Установите значение для Время ожидания уведомления.
  
  Это значение указывает длительность времени в секундах, в течение которого система будет ожидать ответ от получателя. По умолчанию система будет ожидать 10 секунд. Значение должно быть целым числом в диапазоне от 0 до 60 секунд.
3. Установите значение для Время, прошедшее с момента уведомления.
  
  Это значение показывает продолжительность, в секундах, между каждой попыткой доставки полезных данных. По умолчанию система попытается доставить еще одну полезную нагрузку через 5 секунд, если предыдущая попытка не удалась, пока не будет достигнуто количество попыток, указанное в поле Количество попыток доставки.
4. Установите значение для Прошедшее количество дней.
  
  Это значение определяет количество дней, в течение которых может произойти определенное число сбоев, прежде чем вебхук будет деактивирован. По умолчанию система будет принимать определенное количество сбоев (указанное в поле Максимальное число сбоев) в течение 5 дней. Значение должно быть целым числом от 1 до 30.
5. Установите значение для Максимального число сбоев.
  
  Это значение определяет число сбоев, которые могут произойти в течение определенного количества дней, прежде чем вебхук будет деактивирован. По умолчанию система зафиксирует 5 сбоев в течение определенного количества дней (указанного в поле Прошедшее количество дней), прежде чем вебхук будет деактивирован. Значение должно быть задано целым числом от 1 до 10.
Щелкните Сохранить.

Обновленные свойства будут применены ко всем настроенным вебхукам сервиса.