Konfigurowanie webhooków w usłudze Apple Business Connect
Partner zewnętrzny z dostępem do interfejsu API może otrzymywać powiadomienia push za pomocą webhooka dla zmian stanu, które dotyczą różnych zasobów i zdarzeń. Typy powiadomień otrzymywanych przy użyciu webhooka są takie same jak te z interfejsu API powiadomień.
Uwaga: Zanim zaczniesz używać webhooka, musisz mieć dostęp API do usługi Apple Business Connect, a każde środowisko musi zostać zatwierdzone przez Apple. Zobacz Proszenie o dostęp do interfejsu API.
Tworzenie pierwszego webhooka
Jeśli nie zostało to wcześniej zrobione, zaloguj się do usługi Apple Business Connect jako użytkownik z rolą Administrator.
Jeśli jesteś administratorem więcej niż jednego przedsiębiorstwa, wybierz odpowiednie przedsiębiorstwo z listy przedsiębiorstw
.Wybierz przedsiębiorstwo na pasku bocznym, a następnie wybierz opcję API poniżej nazwy przedsiębiorstwa.
Wybierz opcję
obok opcji Dodaj webhooka, a następnie wprowadź następujące informacje:Informacje
Opis
Webhook
Może zawierać litery, cyfry i symbole, z wyjątkiem następujących:
; (średnik)
' (apostrof interpunkcyjny)
[ (lewy nawias kwadratowy)
] (prawy nawias kwadratowy)
< (znak mniejsze niż)
> (znak większe niż)
Członek zespołu
Członek zespołu z rolą Administrator lub Deweloper, z którym należy się skontaktować w przypadku niepowodzenia połączenia.
Środowisko
Ograniczenia:
Po skonfigurowaniu webhooka nie można zmieniać środowisk
Zdarzenie może być użyte tylko raz w danym środowisku
URL pakietu danych
Musi zaczynać się od https://
Zdarzenia
Należy wybrać co najmniej jeden zasób lub inne zdarzenie
Uwaga: Po dodaniu informacji o webhooku na adres URL wysyłany jest ping w celu zweryfikowania połączenia.
Wybierz przycisk Zachowaj.
Wybierz przycisk Kopiuj, aby skopiować klucz tajny klienta do schowka.
Udostępnij klucz tajny klienta administratorowi webhooka.
Gdy administrator potwierdzi, że otrzymał klucz tajny klienta, wybierz przycisk Gotowe.
Edytowanie webhooka
Jeśli nie zostało to wcześniej zrobione, zaloguj się do usługi Apple Business Connect jako użytkownik z rolą Administrator.
Jeśli jesteś administratorem więcej niż jednego przedsiębiorstwa, wybierz odpowiednie przedsiębiorstwo z listy przedsiębiorstw
.Wybierz przedsiębiorstwo na pasku bocznym, a następnie wybierz opcję API poniżej nazwy przedsiębiorstwa.
Wybierz opcję
obok opcji Zarządzaj webhookami, a następnie wybierz webhooka z listy.Możesz zmienić następujące informacje:
Nazwa webhooka
Status webhooka
Imię i nazwisko członka zespołu, z którym można się skontaktować w przypadku niepowodzenia połączenia.
URL pakietu danych
W razie potrzeby wybierz opcję Utwórz nowy klucz tajny klienta, a następnie wybierz opcję Utwórz.
Udostępnij klucz tajny klienta administratorowi webhooka.
Gdy administrator potwierdzi, że otrzymał klucz tajny klienta, wybierz przycisk Gotowe.
Wybierz wszystkie zasoby i wydarzenia, o których chcesz otrzymywać powiadomienia.
Uwaga: Zasoby używane w tym samym środowisku webhooka nie są dostępne dla więcej niż jednego webhooka.
Wybierz przycisk Zachowaj.
Wyświetlanie lub zmiana statusu webhooka
Jeśli nie zostało to wcześniej zrobione, zaloguj się do usługi Apple Business Connect jako użytkownik z rolą Administrator.
Jeśli jesteś administratorem więcej niż jednego przedsiębiorstwa, wybierz odpowiednie przedsiębiorstwo z listy przedsiębiorstw
.Wybierz przedsiębiorstwo na pasku bocznym, a następnie wybierz opcję API poniżej nazwy przedsiębiorstwa.
Wybierz opcję
obok opcji Zarządzaj webhookami, a następnie wyświetl listę webhooków.Zmień status webhooka, aby go włączyć lub wyłączyć.
Wyłączenie webhooka zatrzymuje dostarczanie do niego powiadomień.
Usuwanie webhooka
Jeśli nie zostało to wcześniej zrobione, zaloguj się do usługi Apple Business Connect jako użytkownik z rolą Administrator.
Jeśli jesteś administratorem więcej niż jednego przedsiębiorstwa, wybierz odpowiednie przedsiębiorstwo z listy przedsiębiorstw
.Wybierz przedsiębiorstwo na pasku bocznym, a następnie wybierz opcję API poniżej nazwy przedsiębiorstwa.
Wybierz opcję
obok opcji Zarządzaj webhookami, a następnie wyświetl listę webhooków.Wybierz webhooka, a następnie przewiń w dół i wybierz opcję Usuń webhooka.
Wybierz opcję Usuń, a następnie wybierz opcję Zachowaj.