開發者 API、Webhook 和連接器建構器 — OpsIQ

開發者 API、Webhook 和連接器建構器 — OpsIQ

OpsIQ 提供一個強大的平台，用於通過其開發者 API、Webhook 和連接器建構器構建受管的整合。這使開發者能夠創建以 AI 可操作的應用程序，重點放在安全性和可靠性上。

主要功能

• 範圍限制的 Bearer 金鑰：生成具有最小權限訪問的 API 金鑰，以確保整合僅擁有所需的權限。
• 合約生成的操作：通過單一 API 訪問 1,558 個命名操作，並內建驗證和重放安全寫入。
• HMAC Webhook：訂閱具有加密證明的事件，確保安全且可追蹤的事件交付。
• OpenAPI 和 Postman 支援：利用機器可讀的 API 合約進行簡單的整合和測試。

整合過程

1. 獲取金鑰：註冊並生成範圍限制的 Bearer API 金鑰。
2. 發現與驗證：使用 API 讀取可用操作並利用乾運行功能驗證寫入。
3. 執行與訂閱：使用冪等金鑰執行操作並訂閱必要的事件。

事件處理

OpsIQ 允許開發者從其平台發出標準事件，這些事件可以被各種組件如 AI 大腦和自動化規則訂閱。事件以確定性順序發送，確保關鍵操作被優先處理。

操作合約

每個操作都受到合約的約束，該合約指定其範圍、風險和確認政策。這確保 AI 只能提出已註冊的操作，保持對可執行內容的控制。

Webhook 安全性

OpsIQ 使用 HMAC-SHA256 來簽署 webhook 負載，允許開發者驗證傳入事件的真實性。這包括可追蹤的交付 ID 和自動重試失敗的交付。

SDK 和客戶端生成

開發者可以使用直接的 HTTP 調用或在各種編程語言中生成客戶端，包括 PHP、Node.js 和 Python。完整的 API 在 OpenAPI 3.0.3 中有文檔，並作為 Postman 集合提供。

連接器建構器

連接器建構器允許開發者通過六個階段的過程創建受管的包，確保在發布之前執行所有必要的驗證和檢查。這包括定義身份、身份驗證、操作、觸發器和審查階段。

與 DIY 整合的比較

OpsIQ 提供一個全面的解決方案，包括乾運行寫入、操作合約註冊和確認政策等功能，這些在 DIY 整合中通常實施起來繁瑣。該平台的結構化方法確保了可靠性和安全性，使其成為開發者的首選。

常見問題

• 身份驗證：API 調用需要 Bearer 令牌，Webhook 包含特定的標頭以進行驗證。
• AI 操作批准：AI 只能提出在操作註冊中預先批准的操作。
• Webhook 驗證：開發者可以通過重新計算 HMAC 簽名並將其與提供的簽名進行比較來驗證 Webhook。

如需更多信息，開發者可以訪問文檔並立即開始使用 OpsIQ 構建整合。