本部分說明
透過 API 與 Webhooks 實現自動化。請妥善保管 API 金鑰、驗證 Webhook 簽章，並先在非正式專案中測試。
API 與整合指南
透過 REST API 與 Webhook 連接 CMMS、ERP、資料平台或內部入口。以下主題涵蓋驗證、端點參考、事件裝載、表單類型 JSON 架構與上線最佳實務。
VIP 要求
正式環境 API 與 Webhook 需要 VIP——在專案中開啟「商店」或聯絡客戶成功／商務窗口。
速覽
- 基礎 URL
- https://api.ecpermit.com/v1（僅 HTTPS）。
- 驗證
- 於 Authorization 標頭帶入 API 金鑰——詳見「API 認證」。
- 資料格式
- 預設為 JSON 請求與回應，除非端點另有說明。
建議閱讀順序
- API 認證 —— 建立、限縮權限並輪換金鑰。
- 端點參考 —— 路由、分頁、排序與篩選。
- Webhook —— 事件、簽章、重試與快速回 200。
- 表單類型 JSON 架構 —— 程式建立範本前先驗證裝載。
- 最佳實踐 —— 速率限制、冪等、錯誤處理與可觀測性。
互動式偵錯
若專案提供 Swagger UI，可於開發者或整合入口開啟，以沙箱資料試打後再切換正式流量。