Nastavení webhooků v Apple Business Connectu
Partnerská třetí strana s přístupem přes API může pomocí webhooků dostávat oznámení o změnách stavu, které zahrnují různé prostředky a události. Druhy oznámení přijímaných pomocí webhooků jsou shodné s těmi z API oznámení.
Poznámka: K používání webhooků potřebujete přístup k API Apple Business Connectu a každé prostředí musí být schválené společností Apple. Viz Žádost o API přístup.
Vytvoření prvního webhooku
Pokud ještě nejste v Apple Business Connectu přihlášení, přihlaste se jako uživatel s funkcí administrátora.
Pokud jste administrátorem více než jedné firmy, vyberte v seznamu společností požadovanou firmu
.Na bočním panelu vyberte svou společnost a pod jejím názvem vyberte API.
Vedle volby Přidat webhook vyberte
a poté zadejte následující informace:Informace
Popis
Webhook
Může obsahovat písmena, číslice a symboly kromě následujících:
; (středník)
’ (interpunkční apostrof)
[ (levá hranatá závorka)
] (pravá hranatá závorka)
< (znaménko menší než)
> (znaménko větší než)
Člen týmu
Člen týmu s rolí administrátora nebo vývojáře, který je kontaktován v případě selhání připojení.
Prostředí
Omezení prostředí:
Po nastavení webhooku již nemůžete prostředí měnit
Každá událost se v jednom prostředí dá použít jenom jednou
Payload URL
Musí začínat na https://
Události
Musí být vybraný aspoň jeden zdroj nebo jiná událost
Poznámka: Po doplnění údajů webhooku se na URL odešle ping na ověření spojení.
Zvolte Uložit.
Tlačítkem Kopírovat zkopírujte tajný klíč klienta do schránky.
Tajný klíč klienta nasdílejte administrátorovi webhooku.
Jakmile vám administrátor potvrdí, že tajný klíč klienta dostal, zvolte Hotovo.
Úprava webhooku
Pokud ještě nejste v Apple Business Connectu přihlášení, přihlaste se jako uživatel s funkcí administrátora.
Pokud jste administrátorem více než jedné firmy, vyberte v seznamu společností požadovanou firmu
.Na bočním panelu vyberte svou společnost a pod jejím názvem vyberte API.
Vedle volby Správa webhooků vyberte
a poté vyberte webhook ze seznamu.Můžete změnit následující:
Název webhooku
Stav webhooku
Jméno člena týmu, který je kontaktován v případě selhání připojení
Payload URL
V případě potřeby zvolte Vytvořit nový tajný klíč klienta a poté zvolte Vytvořit.
Tajný klíč klienta nasdílejte administrátorovi webhooku.
Jakmile vám administrátor potvrdí, že tajný klíč klienta dostal, zvolte Hotovo.
Vyberte všechny prostředky a události, o kterých chcete být informováni.
Poznámka: Prostředky používané ve stejném prostředí webhooků nejsou dostupné více než jednomu webhooku.
Zvolte Uložit.
Zobrazení nebo změna stavu webhooku
Pokud ještě nejste v Apple Business Connectu přihlášení, přihlaste se jako uživatel s funkcí administrátora.
Pokud jste administrátorem více než jedné firmy, vyberte v seznamu společností požadovanou firmu
.Na bočním panelu vyberte svou společnost a pod jejím názvem vyberte API.
Vedle volby Správa webhooků zvolte
a poté si zobrazte seznam webhooků.Změnou stavu webhook zapněte nebo vypněte.
Vypnutím webhooku zastavíte doručování oznámení pro daný webhook.
Odebrání webhooku
Pokud ještě nejste v Apple Business Connectu přihlášení, přihlaste se jako uživatel s funkcí administrátora.
Pokud jste administrátorem více než jedné firmy, vyberte v seznamu společností požadovanou firmu
.Na bočním panelu vyberte svou společnost a pod jejím názvem vyberte API.
Vedle volby Správa webhooků zvolte
a poté si zobrazte seznam webhooků.Vyberte webhook a poté posuňte zobrazení dolů a zvolte Odebrat webhook.
Vyberte Odebrat a poté vyberte Uložit.