本部分說明

透過 API 與 Webhooks 實現自動化。請妥善保管 API 金鑰、驗證 Webhook 簽章,並先在非正式專案中測試。

Webhooks 集成

當 EC-Permit 中發生事件時接收即時通知。 Webhook 將資料推送到您的伺服器,而不需要您進行輪詢。

可用的活動

EC-Permit 介面:可用的活動
可用的活動

表單建立

— 建立了一個新表格

表單更新

— 修改了表單數據

表單已提交

— 表格已提交審批

表格已批准

— 表格已獲批准

表格被拒絕

— 表格被拒絕

表單.status_changed

— 表單狀態已變更(任何操作)

表格已刪除

— 表格已刪除

用戶.邀請

— 使用者被邀請參與項目

用戶.加入

— 用戶接受邀請

用戶.已刪除

— 使用者已從項目中刪除

Webhook 負載

EC-Permit 介面:Webhook 負載
Webhook 負載

所有 Webhook 有效負載都遵循以下結構:

簽名驗證

EC-Permit 介面:簽名驗證
簽名驗證

驗證 Webhook 簽章以確保請求來自 EC-Permit:

拒絕時間戳早於 5 分鐘的 Webhook,以防止重播攻擊。

響應 Webhook

EC-Permit 介面:響應 Webhook
響應 Webhook

返回

200 好

確認收貨

30秒內回覆

非 2xx 響應觸發重試

對長時間操作進行非同步處理

重試行為

EC-Permit 介面:重試行為
重試行為

失敗的 webhook 將透過指數退避重試:

第一次重試:1 分鐘

第二次重試:5 分鐘

第三次重試:30 分鐘

第四次重試:2小時

第5次重試:24小時

5 次失敗後:Webhook 已停用,已發送電子郵件通知

範例處理程序 (Node.js)

EC-Permit 介面:範例處理程序 (Node.js)
範例處理程序 (Node.js)

端點參考

表單類型架構

後續步驟

建議繼續閱讀: