《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:// 開頭
活動
須選擇至少一項資源或其他活動
附註:選擇「儲存」後,系統會傳送電郵至該 URL 來驗證相關連接。
選擇「儲存」。
選擇「複製」,以將用户端密鑰複製到剪貼簿。
與 Webhook 管理員分享用户端密鑰。
在管理員確認收到用户端密鑰 (Secret) 後,選擇「完成」。
編輯 Webhook
在 Apple Business,以職務為「機構管理員」或「市場推廣管理員」的用户登入。
如要查看職務和權限,請參閱「職務與權限簡介」。
選擇 API。
選取「管理 Webhook」旁的
,然後從列表中選取 Webhook。你可以更改以下項目:
Webhook 的名稱
Webhook 的狀態
用户名稱,該用户在連接失敗時負責聯絡你的團隊
承載 URL
如有需要,選擇「建立新的用户端密鑰」,然後選擇「建立」。
附註:用户端密鑰 (Secret) 是單次憑證,在工作階段結束後就無法擷取,因此必須手動分享並確認。
與 Webhook 管理員分享用户端密鑰。
在「機構管理員」確認收到用户端密鑰 (Secret) 後,選擇「完成」。
選擇所有你想接收通知的資源和活動。
附註:同一 Webhook 環境中使用的資源,無法供多個 Webhook 使用。
選擇「儲存」。