Jako administrator instytucji możesz skonfigurować elementy webhook dla wdrożenia oprogramowania ArcGIS Enterprise, aby otrzymywać powiadomienia o wystąpieniu określonych zdarzeń. W poniższych sekcjach omówiono sposób konfigurowania instytucji i elementów webhook usług.
Wymagania wstępne dotyczące tworzenia elementów webhook
Przed utworzeniem elementów webhook rozważ następujące kwestie:
- Aby móc używać elementów webhook instytucji, Twoja instytucja musi korzystać z oprogramowania ArcGIS Enterprise w wersji 10.7 lub nowszej. Aby móc używać elementów webhook usługi, Twoja instytucja musi korzystać z oprogramowania ArcGIS Enterprise w wersji 11.0 lub nowszej.
- Aby tworzyć elementy webhook instytucji i zarządzać nimi, musisz mieć przypisane uprawnienie Elementy webhook instytucji lub mieć przypisaną rolę administratora domyślnego.
- Aby tworzyć elementy webhook usługi geoprzetwarzania i zarządzać nimi, musisz mieć przypisane uprawnienie Geoprzetwarzanie lub mieć przypisaną rolę administratora domyślnego.
Notatka:
Użytkownicy, którym przypisano uprawnienie Geoprzetwarzanie, będą musieli również wymagać dodania do swojej roli niestandardowej uprawnienia Publikowanie warstw z serwera.
- Aby tworzyć elementy webhook usługi obiektowej i zarządzać nimi, musisz mieć przypisane uprawnienie Warstwa obiektowa lub mieć przypisaną rolę administratora domyślnego.
- Odbiorniki elementów webhook muszą być skonfigurowane pod kątem komunikacji przez protokół HTTPS. Istnieje kilka opcji obsługiwanych dla odbiorników, takich jak odbiorniki usług internetowych innych producentów (Microsoft Power Automate, Zapier i IFFT), niestandardowe usługi internetowe, ArcGIS Notebook Server i ArcGIS Workflow Manager. Aby zapoznać się z przykładami tworzenia niestandardowych usług internetowych lub aby rozpocząć korzystanie z odbiorników innych producentów, zapoznaj się z tematem Repozytorium elementów webhook. Aby dowiedzieć się więcej o tworzeniu elementów webhook Notebook Server i Workflow Manager, zapoznaj się z tematami Tworzenie zadań za pomocą elementów webhook i Automatyzacja procedur wykonywania zadań za pomocą notatników ArcGIS.
- Aby można było skonfigurować elementy webhook dla hostowanej usługi obiektowej, usługa ta musi mieć możliwość edycji i mieć włączone śledzenie zmian bez synchronizacji.
- Aby skonfigurować elementy webhook dla niehostowanej usługi obiektowej, dane geobazy przedsiębiorstwa, do których odwołuje się usługa, muszą spełniać wymagania dotyczące śledzenia zmian i być zgodne z jednym z poniższych wzorców:
- Jest to nie wersjonowana usługa obiektowa z włączoną archiwizacją i globalnymi identyfikatorami.
- Jest to wersjonowana według gałęzi usługa obiektowa bez włączonej funkcji zarządzania wersjami, w której zmiany są stosowane bezpośrednio do obiektów w wersji domyślnej.
- Jest to wersjonowana według gałęzi usługa obiektowa z włączoną funkcją zarządzania wersjami. Gdy funkcja zarządzania wersjami jest włączona, usługa może utworzyć element webhook, który ma wyzwalacz zdarzenia FeaturesPosted wywołujący element webhook za każdym razem, gdy operacja post jest wykonywana w usłudze.
Notatka:
W oprogramowaniu ArcGIS Enterprise 11.3 dodano obsługę usług obiektowych z wersjonowaniem według gałęzi.
- Aby można było skonfigurować elementy webhook dla usługi geoprzetwarzania, usługa musi być asynchroniczna.
Tworzenie elementu webhook instytucji
Elementy webhook instytucji umożliwiają subskrybowanie wyzwalaczy dla zdarzeń powiązanych z elementami, grupami i użytkownikami portalu ArcGIS Enterprise.
Notatka:
Elementy webhook instytucji mogą być tworzone za pomocą witryny internetowej portalu ArcGIS Enterprise lub aplikacji ArcGIS Portal Directory. Aby zapoznać się z przykładowym żądaniem POST, które tworzy element webhook dotyczący zdarzeń związanych z użytkownikami, grupami i elementami, zapoznaj się z dokumentacją tworzenia elementu webhook (Create Webhook) interfejsu API REST.
Tworzenie elementu webhook instytucji w aplikacji ArcGIS Portal Directory
Aby utworzyć element webhook instytucji za pomocą aplikacji ArcGIS Portal Directory, wykonaj następujące czynności:
- Przejdź do aplikacji ArcGIS Portal Directory i zaloguj się jako członek z rolą administratora.
Elementy webhook instytucji mogą być tworzone i zarządzane tylko przez administratorów z uprawnieniem Elementy webhook instytucji lub członków, którym przypisano rolę administratora domyślnego.
https://machine.domain.com/webadaptor/sharing/rest
Gdy się zalogujesz, zostanie wyświetlona strona zasobów Użytkownik dla Twojego konta.
- Kliknij hiperłącze ID instytucji lub utwórz żądanie w poniższej postaci, aby przejść do strony zasobów Portale > Własny.
https://machine.domain.com/webadaptor/sharing/rest/portals/self
- Przewiń do dołu strony zasobów Własny i kliknij opcję Element webhook > Utwórz element webhook, aby uzyskać dostęp do operacji Utwórz element webhook.
- W punkcie końcowym Utwórz element webhook podaj następujące informacje:
- Podaj niepowtarzalną nazwę elementu webhook w polu tekstowym Nazwa.
- W polu tekstowym Adres URL ładunku podaj adres URL ładunku dla odbiornika elementu webhook, który zostanie sprawdzony podczas tworzenia elementu webhook, aby zapewnić pomyślne nawiązanie połączenia między odbiornikiem a portalem ArcGIS Enterprise.
Przykładowy adres URL ładunku pokazano poniżej:
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
- Opcjonalnie ustaw klucz tajny elementu webhook, który może służyć do uwierzytelniania komunikatów elementu webhook w odbiorniku. Wprowadź zdefiniowany przez użytkownika ciąg alfanumeryczny w polu tekstowym Klucz tajny (opcjonalnie).
- Opcjonalnie określ informacje o dezaktywacji elementu webhook w polu tekstowym Właściwości konfiguracji.
Domyślnie element webhook zostaje zdezaktywowany, jeśli w ciągu pięciu dni wystąpiło pięć niepowodzeń.
- W obszarze Które zdarzenia ma wyzwalać ten element webhook wybierz opcję Pozwól mi zdefiniować ręcznie lub opcję Wysyłaj mi wszystko.
- Jeśli wybierzesz opcję Pozwól mi zdefiniować ręcznie, w polu tekstowym Wysyłaj mi zmiany dla tych zdarzeń rozdzielanych przecinkami wypisz zdarzenia wyzwalające, które będą używane dla tego elementu webhook. Jeśli na przykład chcesz subskrybować wszystkie zdarzenia dotyczące określonej grupy w instytucji, wprowadź zdarzenie wyzwalające podobne do pokazanego poniżej, gdzie [groupID] reprezentuje niepowtarzalny identyfikator powiązany z określoną grupą:
Aby zobaczyć listę wszystkich obsługiwanych wyzwalaczy zdarzeń dla elementów webhook instytucji, zapoznaj się z tematem Wyzwalacze zdarzeń./groups/[groupID]/update
- Jeśli wybierzesz opcję Wysyłaj mi wszystko, subskrybujesz wszystkie obsługiwane zdarzenia wyzwalające. Będziesz otrzymywać powiadomienia o wszystkich zdarzeniach w miarę ich występowania.
- Jeśli wybierzesz opcję Pozwól mi zdefiniować ręcznie, w polu tekstowym Wysyłaj mi zmiany dla tych zdarzeń rozdzielanych przecinkami wypisz zdarzenia wyzwalające, które będą używane dla tego elementu webhook. Jeśli na przykład chcesz subskrybować wszystkie zdarzenia dotyczące określonej grupy w instytucji, wprowadź zdarzenie wyzwalające podobne do pokazanego poniżej, gdzie [groupID] reprezentuje niepowtarzalny identyfikator powiązany z określoną grupą:
- Po skonfigurowaniu powyższych parametrów kliknij opcję Utwórz element webhook, aby przesłać żądanie.
Po ukończeniu operacji do Twojej instytucji zostanie dodany nowy element webhook.
Tworzenie elementu webhook instytucji w witrynie internetowej portalu ArcGIS Enterprise
Aby utworzyć element webhook instytucji za pomocą witryny internetowej portalu ArcGIS Enterprise, wykonaj następujące czynności:
- Sprawdź, czy jesteś zalogowany jako administrator domyślny lub za pomocą niestandardowej roli z uprawnieniem Elementy webhook instytucji.
- Wybierz opcję Instytucja > Ustawienia > Elementy webhook.
- Kliknij opcję Utwórz element webhook.
- W oknie Utwórz element webhook wykonaj następujące czynności:
- Podaj niepowtarzalną nazwę elementu webhook w polu tekstowym Nazwa.
- Wybierz typ elementu webhook z rozwijanego menu Typ.
- Wybranie opcji Wszystkie oznacza subskrypcję wszystkich obsługiwanych wyzwalaczy zdarzeń. Będziesz otrzymywać powiadomienia o wszystkich zdarzeniach w miarę ich występowania.
- Wybranie opcji Elementy, Użytkownicy, Grupy lub Role umożliwia ręczne określenie, które zdarzenia wyzwalacza mają być subskrybowane.
- Jeśli wybierzesz typ elementu webhook inny niż Wszystkie, pojawi się dodatkowe menu rozwijane odnoszące się do wybranego typu elementu webhook. Jeśli na przykład wybranym typem elementu webhook jest Elementy, pojawi się menu rozwijane Elementy, gdzie możesz wybrać konkretny element, który element webhook będzie monitorował.
- Wybierz zdarzenie wyzwalacza z menu rozwijanego Zdarzenia. Jeśli na przykład chcesz, aby element webhook był wywoływany, gdy określony element zostanie opublikowany, wybierz /items/<ID elementu>/publish.
- Wybierz typ odbiornika elementu webhook.
- Jeśli wybierzesz opcję Adres URL elementu webhook, podaj adres URL ładunku dla odbiornika elementu webhook. Przykładowy adres URL ładunku pokazano poniżej:
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
- Jeśli wybierzesz opcję Notatnik, wybierz notatnik, który będzie uruchamiany, gdy element webhook zostanie wyzwolony.
Notatka:
Jeśli opcja Notatnik nie jest dostępna, oznacza to, że w portalu nie został skonfigurowany serwer Notebook Server. Jeśli opcja ta jest dostępna, ale nie można jej wybrać, oznacza to, że nie jesteś właścicielem żadnych notatników odpowiednich do konfigurowania elementów webhook. Musisz być właścicielem elementu notatnika, który będzie użyty przez element webhook.
- Jeśli wybierzesz opcję Adres URL elementu webhook, podaj adres URL ładunku dla odbiornika elementu webhook. Przykładowy adres URL ładunku pokazano poniżej:
- Opcjonalnie ustaw wartość tajną dla elementu webhook w polu tekstowym Tajny (opcjonalnie). Tajna wartość będzie zawarta w ładunku elementu webhook i użyta do uwierzytelnienia komunikatów webhook z odbiornikiem.
- Kliknij opcję Utwórz element webhook.
Konfigurowanie parametrów zaawansowanych dla elementów webhook instytucji
Ustawienia zaawansowane zastosowane do elementów webhook instytucji umożliwiają dalsze dostosowywanie działania elementów webhook, na przykład określanie liczby prób dostarczenia, czasu powiadomienia oraz czasu między próbami dostarczenia.
Notatka:
Elementy webhook instytucji mogą mieć modyfikowane zaawansowane właściwości przez witrynę internetową portalu ArcGIS Enterprise lub aplikację ArcGIS Portal Directory. Aby zobaczyć przykładowe żądanie POST, które konfiguruje te właściwości zaawansowane, zapoznaj się z dokumentacją aktualizowania ustawień elementów webhook (Update Webhook Settings) interfejsu API REST.
Konfigurowanie parametrów zaawansowanych w aplikacji ArcGIS Portal Directory
Aby skonfigurować zaawansowane właściwości za pomocą aplikacji ArcGIS Portal Directory, wykonaj następujące czynności:
- Przejdź do aplikacji ArcGIS Portal Directory i zaloguj się jako członek z rolą administratora.
Elementy webhook instytucji mogą być tworzone i zarządzane tylko przez członków, którym przypisano rolę administratora domyślnego, lub członków, którym przypisano uprawnienie Elementy webhook instytucji.
https://machine.domain.com/webadaptor/sharing/rest
Gdy się zalogujesz, zostanie wyświetlona strona zasobów Użytkownik dla Twojego konta.
- Kliknij hiperłącze ID instytucji lub utwórz żądanie w poniższej postaci, aby przejść do strony zasobów Portale > Własny.
https://machine.domain.com/webadaptor/sharing/rest/portals/self
- Przewiń do dołu strony zasobów Własny i kliknij opcję Element webhook > Ustawienia > Aktualizuj, aby uzyskać dostęp do operacji Aktualizuj element webhook.
- W punkcie końcowym Aktualizuj element webhook podaj następujące informacje:
- Ustaw wartość ustawienia Liczba prób powiadomienia.
Ta wartość określa liczbę prób, które zostaną wykonane w celu dostarczenia ładunku elementu webhook. Domyślnie portal ArcGIS Enterprise spróbuje dostarczyć ładunek trzy razy. Wartość liczby prób musi być liczbą całkowitą z zakresu od 0 do 5.
- Ustaw wartość ustawienia Limit czasu powiadomienia w sekundach.
Ta wartość określa czas w sekundach, przez który portal ArcGIS Enterprise będzie czekać na odpowiedź z odbiornika. Domyślnie portal ArcGIS Enterprise czeka 10 sekund. Wartość określająca liczbę sekund oczekiwania portalu ArcGIS Enterprise musi być liczbą całkowitą z zakresu od 0 do 60 sekund.
- Ustaw wartość ustawienia Czas między powiadomieniami w sekundach.
Ta wartość określa czas w sekundach między poszczególnymi próbami dostarczenia ładunku. Domyślnie portal ArcGIS Enterprise będzie próbować dostarczyć kolejny ładunek po 5 sekundach, jeśli poprzednia próba się nie powiedzie, aż do osiągnięcia liczby prób określonej w ustawieniu Liczba prób powiadomienia.
- Ustaw wartość ustawienia Liczba prób powiadomienia.
- Po skonfigurowaniu powyższych parametrów kliknij opcję Aktualizuj ustawienia elementu webhook, aby przesłać żądanie.
Po ukończeniu operacji zaktualizowane właściwości zostaną zastosowane do każdego skonfigurowanego elementu webhook instytucji.
Konfigurowanie parametrów zaawansowanych w witrynie internetowej portalu ArcGIS Enterprise
Aby skonfigurować zaawansowane właściwości za pomocą witryny internetowej portalu ArcGIS Enterprise, wykonaj następujące czynności:
- Zaloguj się do instytucji jako administrator domyślny lub za pomocą niestandardowej roli z uprawnieniem Elementy webhook instytucji.
- Kliknij przycisk Instytucja znajdujący się w górnej części witryny, a następnie kliknij kartę Ustawienia.
- Kliknij opcję Elementy webhook po lewej stronie.
- Kliknij opcję Zaawansowane ustawienia elementów webhook.
- W oknie Zaawansowane ustawienia elementów webhook wykonaj następujące czynności:
- Ustaw wartość parametru Liczba prób dostarczenia.
Ta wartość określa liczbę prób, które zostaną wykonane w celu dostarczenia ładunku elementu webhook. Domyślnie portal ArcGIS Enterprise spróbuje dostarczyć ładunek trzy razy. Wartość liczby prób musi być liczbą całkowitą z zakresu od 0 do 5.
- Ustaw wartość parametru Limit czasu powiadamiania.
Ta wartość określa czas w sekundach, przez który portal ArcGIS Enterprise będzie czekać na odpowiedź z odbiornika. Domyślnie portal ArcGIS Enterprise czeka 10 sekund. Wartość określająca liczbę sekund oczekiwania portalu ArcGIS Enterprise musi być liczbą całkowitą z zakresu od 0 do 60 sekund.
- Ustaw wartość parametru Czas między powiadomieniami.
Ta wartość określa czas w sekundach między poszczególnymi próbami dostarczenia ładunku. Domyślnie portal ArcGIS Enterprise będzie próbować dostarczyć kolejny ładunek po 5 sekundach, jeśli poprzednia próba się nie powiedzie, aż do osiągnięcia liczby prób określonej w ustawieniu Liczba prób dostarczenia.
- Ustaw wartość parametru Liczba prób dostarczenia.
- Po skonfigurowaniu powyższych ustawień kliknij opcję Zapisz.
Zaktualizowane właściwości zostaną zastosowane do każdego skonfigurowanego elementu webhook instytucji.
Tworzenie elementu webhook usługi geoprzetwarzania
Elementy webhook usług geoprzetwarzania umożliwiają subskrybowanie określonych wyzwalaczy zdarzeń związanych z usługami geoprzetwarzania.
Notatka:
Elementy webhook usługi geoprzetwarzania można tworzyć tylko za pomocą aplikacji ArcGIS Server Administrator Directory. Przykładowe żądanie POST, które tworzy element webhook usługi geoprzetwarzania, zawiera dokumentacja REST API Tworzenie elementów webhook .
Aby utworzyć element webhook dla usługi geoprzetwarzania, wykonaj następujące czynności:
- Przejdź do aplikacji ArcGIS Server Administrator Directory i zaloguj się jako członek z przypisanymi odpowiednimi uprawnieniami.Elementy webhook mogą być tworzone i zarządzane tylko przez członków z przypisanym uprawnieniem Geoprzetwarzanie lub rolą administratora domyślnego.
Notatka:
Użytkownicy, którym przypisano uprawnienie Geoprzetwarzanie, będą musieli również wymagać dodania do swojej roli niestandardowej uprawnienia Publikowanie warstw z serwera.
https://machine.domain.com/webadaptor/admin
- Po zalogowaniu się przejdź do zasobu Elementy webhook dla usługi geoprzetwarzania, klikając opcję Usługi > [ServiceName] > Elementy webhook > Utwórz, gdzie [ServiceName] oznacza usługę, dla której zostanie utworzony element webhook. W przypadku usług znajdujących się w określonych folderach kliknij opcję Usługi > [FolderName] > [ServiceName] > Elementy webhook > Utwórz, gdzie [FolderName] oznacza folder, w którym znajduje się usługa.
Uwaga:
Aby można było skonfigurować elementy webhook dla usługi geoprzetwarzania, ta usługa musi być asynchroniczna.
- W punkcie końcowym Utwórz element webhook podaj następujące informacje:
- Podaj niepowtarzalną nazwę elementu webhook w polu tekstowym Nazwa. Podana nazwa może zawierać tylko wartości alfanumeryczne. Użycie znaków specjalnych spowoduje zwrócenie komunikatu o błędzie.
- Opcjonalnie ustaw klucz tajny elementu webhook, który może służyć do uwierzytelniania komunikatów elementu webhook w odbiorniku. Wprowadź zdefiniowany przez użytkownika ciąg alfanumeryczny w polu tekstowym Klucz podpisu.
Elementy webhook usług wykorzystują weryfikację podpisu, aby zapewnić integralność i bezpieczeństwo ładunków webhook wysyłanych z oprogramowania ArcGIS Enterprise do odbiornika elementów webhook. Alfanumeryczny ciąg znakowy wprowadzony do pola tekstowego Klucz podpisu jest traktowany jako tajny klucz, który jest znany i przechowywany niezależnie przez oprogramowanie ArcGIS Enterprise i odbiornik elementów webhook. Gdy wyzwalane jest zdarzenie elementu webhook, tajny klucz i ładunek są przetwarzane przy użyciu algorytmu tworzenia skrótów HMAC-SHA256, tworząc podpis. Podpis jest następnie przekazywany w żądaniu elementu webhook jako wartość nagłówka x-esriHook-Signature. Gdy element webhook zostanie dostarczony do odbiornika, odbiornik wykorzystuje tajny klucz i ładunek do utworzenia własnego podpisu przy użyciu tego samego algorytmu HMAC-SHA256, który został użyty przez oprogramowanie ArcGIS Enterprise. Jeśli podpis zawarty w nagłówku żądania jest zgodny z przeliczoną wartością utworzoną przez odbiornik elementów webhook, ładunek elementu webhook może być traktowany jako zaufany przez odbiornik. W przeciwnym razie odbiornik może zdecydować się na odrzucenie przychodzącego ładunku elementu webhook.
- W polu tekstowym Adres URL elementu hook podaj adres URL ładunku dla odbiornika elementu webhook, który zostanie sprawdzony podczas tworzenia elementu webhook, aby zapewnić pomyślne nawiązanie połączenia między odbiornikiem a serwerem ArcGIS Server wdrożenia. Przykładowy ładunek pokazano poniżej:
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
- Opcjonalnie określ typ nośnika. Z menu rozwijanego Typ zasobów wybierz jedną z następujących opcji:
- application/json (domyślne)
- application/x-www-form-urlencoded
- Opcjonalnie zdefiniuj format ładunków. Z menu rozwijanego Format ładunku wybierz jedną z następujących opcji:
- JSON (domyślne)
- PJSON
- Opcjonalnie użyj parametru Aktywne, aby wyłączyć lub włączyć wywołania zwrotne w przypadku wyzwolenia elementu webhook. Aby włączyć, wybierz opcję Prawda. Aby wyłączyć, wybierz opcję Fałsz.
Domyślnie wywołania zwrotne są włączone.
- Po skonfigurowaniu powyższych parametrów kliknij opcję Utwórz, aby przesłać żądanie.
Po ukończeniu operacji do określonej usługi geoprzetwarzania zostanie zastosowany nowy element webhook.
Notatka:
W przeciwieństwie do elementów webhook instytucji i usług obiektowych elementy webhook usług geoprzetwarzania nie mają wyzwalaczy zdarzeń zdefiniowanych przez użytkownika. Elementy webhook usług geoprzetwarzania dostarczają ładunki po ukończeniu zadania geoprzetwarzania. Aby uzyskać więcej informacji na temat ładunków dostarczanych dla usług geoprzetwarzania, zapoznaj się z tematem Ładunki.Tworzenie elementu webhook usługi obiektowej
Elementy webhook usług obiektowych umożliwiają subskrybowanie określonych wyzwalaczy zdarzeń związanych z usługami obiektowymi.
Notatka:
Elementy webhook usługi obiektowej można tworzyć tylko za pomocą aplikacji ArcGIS Server Administrator Directory. Przykładowe żądanie POST, które tworzy element webhook usługi obiektowej, zawiera dokumentacja REST API Tworzenie elementów webhook .
Aby utworzyć element webhook dla usługi obiektowej, wykonaj następujące czynności:
- Przejdź do aplikacji ArcGIS Server Administrator Directory i zaloguj się jako członek z przypisanymi odpowiednimi uprawnieniami.Elementy webhook mogą być tworzone i zarządzane tylko przez członków z przypisanym uprawnieniem Warstwa obiektowa lub rolą administratora domyślnego.
https://machine.domain.com/webadaptor/admin
- Po zalogowaniu się przejdź do zasobu Elementy webhook dla usługi obiektowej, klikając opcję Usługi > [ServiceName] > Elementy webhook > Utwórz, gdzie [ServiceName] oznacza usługę, dla której zostanie utworzony element webhook. W przypadku usług znajdujących się w określonych folderach kliknij opcję Usługi > [FolderName] > [ServiceName] > Elementy webhook > Utwórz, gdzie [FolderName] oznacza folder, w którym znajduje się usługa.
- W punkcie końcowym Utwórz element webhook podaj następujące informacje:
- Podaj niepowtarzalną nazwę elementu webhook w polu tekstowym Nazwa. Podana nazwa może zawierać tylko wartości alfanumeryczne. Użycie znaków specjalnych spowoduje zwrócenie komunikatu o błędzie.
- Podaj wyzwalacze zdarzeń, które będą używane dla tego elementu webhook, w polu tekstowym Typ zmiany. Aby na przykład wywoływać element webhook za każdym razem, gdy tworzona jest usługa obiektowa, użyj następującego wyzwalacza zdarzeń:
Aby zobaczyć listę wszystkich wyzwalaczy zdarzeń obsługiwanych przez elementy webhook usług obiektowych, zapoznaj się z tematem Wyzwalacze zdarzeń.Przykład
FeaturesCreated
- Opcjonalnie ustaw klucz tajny elementu webhook, który może służyć do uwierzytelniania komunikatów elementu webhook w odbiorniku. Wprowadź zdefiniowany przez użytkownika ciąg alfanumeryczny w polu tekstowym Klucz podpisu.
Elementy webhook usług wykorzystują weryfikację podpisu, aby zapewnić integralność i bezpieczeństwo ładunków webhook wysyłanych z oprogramowania ArcGIS Enterprise do odbiornika elementów webhook. Alfanumeryczny ciąg znakowy wprowadzony do pola tekstowego Klucz podpisu jest traktowany jako tajny klucz, który jest znany i przechowywany niezależnie przez oprogramowanie ArcGIS Enterprise i odbiornik elementów webhook. Gdy wyzwalane jest zdarzenie elementu webhook, tajny klucz i ładunek są przetwarzane przy użyciu algorytmu tworzenia skrótów HMAC-SHA256, tworząc podpis. Podpis jest następnie przekazywany w żądaniu elementu webhook jako wartość nagłówka x-esriHook-Signature. Gdy element webhook zostanie dostarczony do odbiornika, odbiornik wykorzystuje tajny klucz i ładunek do utworzenia własnego podpisu przy użyciu tego samego algorytmu HMAC-SHA256, który został użyty przez oprogramowanie ArcGIS Enterprise. Jeśli podpis zawarty w nagłówku żądania jest zgodny z przeliczoną wartością utworzoną przez odbiornik elementów webhook, ładunek elementu webhook może być traktowany jako zaufany przez odbiornik. W przeciwnym razie odbiornik może zdecydować się na odrzucenie przychodzącego ładunku elementu webhook.
- W polu tekstowym Adres URL elementu hook podaj adres URL ładunku dla odbiornika elementu webhook, który zostanie sprawdzony podczas tworzenia elementu webhook, aby zapewnić pomyślne nawiązanie połączenia między odbiornikiem a serwerem ArcGIS Server wdrożenia. Przykładowy ładunek pokazano poniżej:
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
- Opcjonalnie określ typ nośnika. Z menu rozwijanego Typ zasobów wybierz jedną z następujących opcji:
- application/json (domyślne)
- application/x-www-form-urlencoded
- Opcjonalnie zdefiniuj format ładunków. Z menu rozwijanego Format ładunku wybierz jedną z następujących opcji:
- JSON (domyślne)
- PJSON
- Opcjonalnie użyj parametru Aktywne, aby wyłączyć lub włączyć wywołania zwrotne w przypadku wyzwolenia elementu webhook. Aby włączyć, wybierz opcję Prawda. Aby wyłączyć, wybierz opcję Fałsz.
Domyślnie wywołania zwrotne są włączone.
- Dostosuj harmonogram dla elementów webhook, modyfikując informacje Sekundy w polu tekstowym Harmonogram. W przypadku usług obiektowych, które są często edytowane, zmniejsz wartość Sekundy, aby odbierać częstsze elementy webhook z mniejszą ilością informacji o zdarzeniach w ładunku. W przypadku usług obiektowych, które nie są często zmieniane, zwiększ wartość właściwości Sekundy, aby odbierać rzadsze elementy webhook z większą ilością informacji o zdarzeniach w ładunku.
Minimalna i domyślna wartość harmonogramu to 20 sekund.
- Po skonfigurowaniu powyższych parametrów kliknij opcję Utwórz, aby przesłać żądanie.
Po ukończeniu operacji do określonej usługi obiektowej zostanie zastosowany nowy element webhook.