《Apple Business 用户手冊》

在 Apple Business 設定 Webhook
具備 API 取用權限的第三方合作夥伴可以使用 Webhook,針對涉及不同資源和活動的狀態更改接收推播通知。使用 Webhook 接收的通知類型,與 Notifications API 的通知類型相同。
附註:使用 Webhook 之前,你必須具備 Apple Business 的 API 取用權限,且每個環境都必須獲得 Apple 核准。請參閱「申請 API 取用權限」。
建立你的第一個 Webhook
在 Apple Business,以具有「機構管理員」職務的用户登入。
如要查看職務和權限,請參閱「職務與權限簡介」。
選擇 API。
選擇「加入 Webhook」旁的
,然後輸入以下資料:資料
描述
Webhook
可包含字母、數字和符號,以下除外:
; (分號)
’ (撇號)
[ (左方括號)
] (右方括號)
< (小於符號)
> (大於符號)
團隊成員
具備「管理員」或「開發者」職務,並將在連結失敗時聯絡的團隊成員
環境
限制:
設定 Webhook 後,你將無法更改環境
一項活動在每個環境中只能使用一次
承載 URL
須以 https:// 開頭
活動
須選擇至少一項資源或其他活動
附註:加入 Webhook 資料後,將向該 URL 傳送 ping 以驗證連線。
選擇「儲存」。
選擇「複製」,以將用户端密鑰複製到剪貼簿。
與 Webhook 管理員分享用户端密鑰。
在管理員確認收到用户端密鑰 (Secret) 後,選擇「完成」。
編輯 Webhook
在 Apple Business,以具有「機構管理員」職務的用户登入。
如要查看職務和權限,請參閱「職務與權限簡介」。
選擇 API。
選取「管理 Webhook」旁的
,然後從列表中選取 Webhook。你可以更改以下項目:
Webhook 的名稱
Webhook 的狀態
連結失敗時將聯繫的團隊成員名稱
承載 URL
如有需要,選擇「建立新的用户端密鑰」,然後選擇「建立」。
與 Webhook 管理員分享用户端密鑰。
在管理員確認收到用户端密鑰 (Secret) 後,選擇「完成」。
選擇所有你想接收通知的資源和活動。
附註:同一 Webhook 環境中使用的資源,無法供多個 Webhook 使用。
選擇「儲存」。