API

了解 OpsIQ API 功能和 SDK 參考

OpsIQ API 是否支持冪等性?
是的,開發者模型包括冪等重放保護用於寫入。此功能包括一個文檔化的24小時冪等性窗口用於支持的操作。客戶在網絡故障後重試相同的預期寫入時應重用相同的密鑰。對於真正的新操作,應創建一個新密鑰。 相關文章 開發者 API、Webhook 和連接器建構器 — OpsIQ OpsIQ 文檔與開發者文檔 — OpsIQ Portal Studio 管理員和開發者指南 — OpsIQ 我如何對OpsIQ一般API進行身份驗證? 通過 OpsIQ…
3,102
通過OpsIQ一般API可用多少個操作?
當前的開發者和整合頁面描述了1,558個名為一般API操作的,受62個最小權限範圍的約束。操作註冊表確保API行為、操作文檔、範圍和驗證保持一致。整合應僅調用他們實際需要的操作。 相關文章 開發者 API、Webhook 和連接器建構器 — OpsIQ OpsIQ 文檔與開發者文檔 — OpsIQ Portal Studio 管理員和開發者指南 — OpsIQ 我如何對OpsIQ一般API進行身份驗證? OpsIQ API…
3,002
OpsIQ 的外發網絡鉤子是如何簽名的?
OpsIQ 使用 HMAC-SHA256 對原始請求主體簽署外發網絡鉤子有效負載。它還包括交付元數據,例如時間戳和事件。接收者應遵循以下步驟: 從精確的原始主體計算簽名。 以恆定時間比較計算出的簽名。 驗證時間戳。 以冪等方式處理重複的交付。 相關文章 簽署的 Webhooks 和 API 操作以實現自動化 — OpsIQ 整合、API 與連接器建構器 — OpsIQ OpsIQ 能否與我們已經使用的工具連接? OpsIQ…
2,990
OpsIQ API 是否支援 dry-run 請求?
是的,OpsIQ API 支援 dry_run 請求。支援的操作可以利用這個行為,允許整合者在不提交寫入的情況下驗證意圖和參數。這個功能對於高影響力的自動化和測試特別有用。然而,重要的是要注意,dry run 並不取代階段,因為並非每個外部副作用都可以安全地重現。 相關文章 開發者 API、Webhook 和連接器建構器 — OpsIQ OpsIQ 文檔與開發者文檔 — OpsIQ Portal Studio 管理員和開發者指南 —…
2,948
OpsIQ 提供什麼 SDK 和 API 參考格式?
OpsIQ 提供一個 OpenAPI 3.0.3 描述,Postman 資源,以及用於 PHP、Node.js 和 Python 的輔助模式。這使得團隊能夠與他們偏好的技術堆疊集成,而不是依賴單一的專有 SDK。然而,檢查生成的客戶端在秘密處理、超時、重試和冪等性等方面是很重要的。 相關文章 API 限速在 OpsIQ 中是如何運作的? 自定義結帳如何將轉換發送到 OpsIQ?
2,708
我可以在不刪除的情況下暫時禁用一個 API 令牌嗎?
是的,API Tokens 支援禁用並在稍後重新啟用一個令牌。當整合應該暫時停止使用它時,您可以禁用一個令牌。請記住,在該令牌被禁用時,連接的整合將無法通過身份驗證。 相關文章 OpsIQ 的出站網絡鉤子是如何簽名的? 我如何對OpsIQ一般API進行身份驗證? 通過 OpsIQ 一般 API 可用多少操作? OpsIQ API 是否支持乾跑請求? OpsIQ API 是否支持冪等性? OpsIQ 提供哪些 SDK 和 API…
2,614
API 限制在 OpsIQ 中是如何運作的?
OpsIQ 根據每個密鑰應用 API 限制,並在響應標頭中返回限制信息。當超過限制時,客戶端會收到 HTTP 429 狀態碼,並附帶有關何時重試的指導,通過 Retry-After 標頭。 整合應該實施退避策略,而不是立即重試。重要的是要記住,計劃限制分別適用於密鑰、操作、網絡鉤子、整合和觸發器。 相關文章 OpsIQ 提供哪些 SDK 和 API 參考格式? 自定義結帳如何將轉換發送到 OpsIQ?
2,598
為什麼我不能再次看到我的 API 令牌密鑰?
該令牌密鑰僅在創建時顯示。帳戶儲存所需的內容以驗證未來的令牌使用,而不是為了後續顯示而重複使用的明文副本。如果您丟失了密鑰,您需要創建一個替代令牌並禁用或刪除丟失的那個。 相關文章 OpsIQ 的出站網絡鉤子是如何簽名的? 我如何對OpsIQ一般API進行身份驗證? 通過 OpsIQ 一般 API 可用多少操作? OpsIQ API 是否支持乾跑請求? OpsIQ API 是否支持冪等性? OpsIQ 提供哪些 SDK 和 API…
2,586
我可以看到有關API令牌的哪些信息?
API Tokens 頁面提供有關每個令牌的各種詳細信息,包括: 令牌名稱 公共識別碼 授予的權限 當前狀態 使用信息(例如,最後使用的時間) 請注意,秘密本身在創建後不會重新顯示。 相關文章 OpsIQ 的出站網絡鉤子是如何簽名的? 我如何對OpsIQ一般API進行身份驗證? 通過 OpsIQ 一般 API 可用多少操作? OpsIQ API 是否支持乾跑請求? OpsIQ API 是否支持冪等性? OpsIQ 提供哪些 SDK 和…
2,540
我如何驗證到 OpsIQ 一般 API?
驗證到 OpsIQ 一般 API OpsIQ 的一般 API 使用範圍 Bearer API 金鑰。這些金鑰僅應分配必要的最低權限範圍以執行其功能。此外,它們必須安全地儲存為秘密,並且不應包含在公共瀏覽器代碼或存儲庫中。 開發者網站提供詳細資訊: 62 個可用範圍 一個常見的 API 入口點 速率限制標頭 穩定的操作合約 相關文章 開發者 API、Webhook 和連接器建構器 — OpsIQ OpsIQ 文檔與開發者文檔 —…
2,450
當我刪除一個 API 令牌時會發生什麼?
刪除一個令牌會永久移除該客戶令牌的活躍使用。任何仍然配置的整合將停止驗證,如果仍然需要訪問,必須使用新的令牌進行更新。如果您想要可逆的暫停而不是永久移除,請先禁用該令牌。 相關文章 OpsIQ 的出站網絡鉤子是如何簽名的? 我如何對OpsIQ一般API進行身份驗證? 通過 OpsIQ 一般 API 可用多少操作? OpsIQ API 是否支持乾跑請求? OpsIQ API 是否支持冪等性? OpsIQ 提供哪些 SDK 和 API…
2,441
OpsIQ 中的客戶 API 令牌是什麼?
客戶 API 令牌允許您在不分享帳戶密碼的情況下授權受支持的客戶範圍整合。這些令牌可以攜帶有限的權限,用於受支持的帳戶、許可證、計費或支持操作,具體取決於創建令牌時提供的範圍。重要的是只給整合實際需要的權限。 相關文章 OpsIQ 的出站網絡鉤子是如何簽名的? 我如何對OpsIQ一般API進行身份驗證? 通過 OpsIQ 一般 API 可用多少操作? OpsIQ API 是否支持乾跑請求? OpsIQ API 是否支持冪等性?…
2,423
我該如何創建一個 OpsIQ 客戶 API 令牌?
要創建一個 OpsIQ 客戶 API 令牌,請按照以下步驟進行: 打開 API 令牌部分。 創建一個具有描述性名稱的令牌。 選擇適當的可用權限。 在令牌創建後,立即複製密鑰並安全存儲。完整的密鑰僅顯示一次。OpsIQ 保留一個受保護的表示以供驗證目的,並不會再次顯示原始密鑰。 相關文章 OpsIQ 的出站網絡鉤子是如何簽名的? 我如何對OpsIQ一般API進行身份驗證? 通過 OpsIQ 一般 API 可用多少操作? OpsIQ…
2,397
我可以使用 OpsIQ API 令牌來替代我的帳戶密碼進行集成嗎?
是的,您可以使用一個OpsIQ API 令牌來替代您的帳戶密碼,以進行支持的客戶 API 操作。這種方法比提供與您的互動帳戶密碼的集成更可取,因為該令牌可以獲得命名、範圍、監控、禁用和獨立替換。保持令牌的秘密並避免將其包含在瀏覽器 URL、工單和日誌中是很重要的。 相關文章 OpsIQ 的出站網絡鉤子是如何簽名的? 我如何對OpsIQ一般API進行身份驗證? 通過 OpsIQ 一般 API 可用多少操作? OpsIQ API…
2,013
仍然需要幫助嗎?

如果您找不到所需的內容,我們的團隊在這裡幫助您。

聯繫支持