Webhook Service 使用要求

Webhook Service 設定要求

SP 可依據開發需求，使用 NextDrive Callback Service 取得 Service 開發所需的相關資訊。
SP 若希望使用 NextDrive Callback Service，應建立一個 webhook Service 並完成佈署，以滿足執行要求（Fulfillment）。
為滿足執行要求，SP 的 webhook Service 必須符合下列設定要求，以接受 JSON 請求（request）與回覆（responses）：

• 需支援 HTTPS 請求（不支援 HTTP）。

• 必須使用 JSON 主體（Body）處理 POST 請求。

• 必須使用 JSON 主體（Body）回覆 Webhook 請求。

• 必須是可公開訪問的 URL。

Webhook Service 回覆要求

當 SP 的 Webhook Service 收到 Webhook 請求時，需發送 HTTP 狀態代碼作為回覆。
請確保 Webhook Service 回覆的 HTTP 狀態代碼保持 200 OK。
若未能回覆 200 OK，可能導致 SP 的 Webhook Service 被停用。
若 SP 的 Webhook Service 遇到錯誤，應從下列 HTTP 狀態代碼中擇一回覆：

• 400 Bad Request（請求無效）

• 401 Unauthorized（未授權）

• 403 Forbidden（禁止訪問）

• 404 Not found（無法找到檔案）

• 500 Server fault（內部伺服器錯誤）

• 503 Service Unavailable（服務不可用）

Webhook Request

當執行要求的意圖（Intent）被滿足時，IoE Platform 將以 HTTPS 對 SP 的 Webhook Service 送出 POST 請求。
Webhook Service 支援的事件與執行要求如下表說明。欲了解請求主體（request body）的細節定義，請參考「相關說明」欄位連結內容。