Apple 商務使用手冊

在「Apple 商務」中設定 Webhook
具備 API 存取權限的第三方合作夥伴可以透過 Webhook 接收推播通知,以得知涉及不同資源與事件的狀態變更。透過 Webhook 接收的通知類型,與 Notifications API 提供的通知相同。
【注意】在開始使用 Webhook 之前,你必須先具備「Apple 商務」的 API 存取權限,且每個環境都必須經過 Apple 的核准。請參閱〈申請 API 存取權限〉。
建立你的第一個 Webhook
在「Apple 商務」中,以具備「機構管理員」職務的使用者身分登入。
若要檢視職務與權限,請參閱〈職務與權限簡介〉。
選取「API」。
選取「新增 Webhook」旁邊的
,然後輸入以下資訊:資訊
說明
Webhook
可以包含字母、數字與符號,但不包含以下字元:
;(分號)
’(標點符號撇號)
[(左方括號)
](右方括號)
<(小於符號)
>(大於符號)
團隊成員
當連線失敗時負責聯絡的團隊成員,職務需為「管理員」或「開發者」。
環境
限制:
設定 Webhook 後無法更改環境。
同一個活動在同一個環境中只能使用一次。
承載資料 URL
必須以 https:// 開頭。
活動
至少需要選取一個資源或其他活動。
【注意】當 Webhook 資訊新增完成後,系統會向該 URL 傳送 ping 以驗證連線。
選取「儲存」。
選取「拷貝」以將用戶端密鑰拷貝到剪貼板。
與 Webhook 的管理員共享客戶端密鑰。
管理員確認已收到用戶端密鑰後,請選取「完成」。
編輯 Webhook
在「Apple 商務」中,以具備「機構管理員」職務的使用者身分登入。
若要檢視職務與權限,請參閱〈職務與權限簡介〉。
選取「API」。
選擇「管理 Webhook」旁邊的
,然後從列表中選取一個 Webhook。你可以變更下列項目:
Webhook 的名稱
Webhook 的狀態
連線失敗時負責聯絡的團隊成員姓名
承載資料 URL
如有需要,請選取「建立新的用戶端密鑰」,然後選取「建立」。
與 Webhook 的管理員共享客戶端密鑰。
管理員確認已收到用戶端密鑰後,請選取「完成」。
選取你要收到通知的所有資源和活動。
【注意】在同一 Webhook 環境中使用的資源不得用於多個 Webhook。
選取「儲存」。