資安服務

Cloud CNM SecuReporter

Zyxel SecuReporter OpenAPI

尋找資源以利於自動化並使用適用於Zyxel SecuReporter平台的API快速建立自訂應用程式。

存取裝置資料與 SecuReporter OpenAPI 服務

SecuReporter 支援介面讓軟體直接與 SecuReporter 雲端平台互動。
這些 API 使 SecuReporter 用戶能夠使用 API 憑證檢索過去 31 天的裝置日誌。

使用 SecuReporter OpenAPI,您可以使用任何程式語言或 cURL 命令,透過 HTTP 輕鬆存取裝置資料。要使用此服務,請確保您的裝置有有效的 SecuReporter 授權和 OpenAPI 憑證。這些憑證對於驗證和授權您的 API 請求是必要的。

了解 SecuReporter OpenAPI 憑證的優勢

SecuReporter OpenAPI 支援手動與自動化流程,可精簡您的工作流程,提升擴展性並實現無縫自動化。快來體驗安全、高效且用戶友善的存取防火牆日誌文件的流程。

便利且效率

使用任何程式語言或 cURL 命令,不用登入入口網站,直接透過 HTTP 請求存取您的防火牆日誌。這簡化了您的工作流程,非常適合需要定期檢索日誌的自動化系統或腳本。

擴展性

OpenAPI 憑證使得存取防火牆日誌的有較佳擴展性,為不同的用戶或系統生成多個憑證,確保靈活性又可控管。

自動化能力

使用 API 憑證可無縫結合其他系統和軟體。自動檢索防火牆日誌並將這些數據結合到您的安全信息和事件管理(SIEM)系統中,不須手動進行這些作業。

為何整合 SecuReporter 的 OpenAPI 憑證?

SecuReporter 提供了安全、高效且用戶友善的存取防火牆日誌文件的方法。支援手動和自動化流程並同時保持高安全標準。想了解更多關於 SecuReporter OpenAPI 整合的詳細訊息,請前往我們的 GitHub。

Zyxel GitHub

無縫整合常見問題

有問題都不用擔心!在您摸索如何將 OpenAPI 與 SecuReporter 整合時,這裡有實用的提示和常見問題解答,幫助您完成整個過程。

歸檔日誌服務是 SecuReporter OpenAPI 提供的第一個開放服務。它讓用戶能夠使用 API 憑證檢索追溯到前 31 天的防火牆日誌。每個 API 憑證每小時最多允許 50 次 API 請求。敬請期待即將推出的服務。

請聯繫您當地的 Zyxel 業務或業務工程師,以驗證您的功能請求對其的影響。

前提:

確保您的防火牆設備有一個有效的SecuReporter授權,並且SecuReporter服務已啟用。如果您的授權已過期,請聯繫設備所有者或從 Zyxel marketplace購買新的授權,以訪問 OpenAPI 服務。

在 SecuReporter 上產生 OpenAPI 憑證的步驟:

步驟1:選擇具有有效SecuReporter授權的設備並點擊“API訪問(API Access)”按鈕。

步驟2:點擊“建立新 API 憑證(Create New API Token)”按鈕。

步驟3:複製 OpenAPI 憑證。

有兩種方法可測試 OpenAPI:cURL 和 Python。

[1] 使用 cURL 測試

  • 設置:要檢查是否安裝了cURL,請打開命令提示字元或終端並輸入curl。如果收到錯誤消息,說明未找到cURL,請按照 cURL GitHub 儲存庫上的安裝說明進行操作。
  • 進行首次 OpenAPI 請求:打開命令提示字元/終端並使用以下命令。將 yyyy-MM-dd 替換為過去 31 天內的某個日期(不包括當前日期),格式為 yyyy-mm-dd。將 mydir 替換為您電腦上實際的下載文件夾路徑。

macOS

curl -X POST \

https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download \

-H "Content-Type: application/json" \

-H "X-Authorization: Bearer $OPEN_API_TOKEN" \

-d "{\"device_date\":\"yyyy-MM-dd\"}" \

-o mydir/archive.tar

Windows

curl -X POST ^

https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download ^

-H "Content-Type: application/json" ^

-H "X-Authorization: Bearer %OPEN_API_TOKEN%" ^

-d "{\"device_date\":\"yyyy-MM-dd\"}" ^

-o mydir\archive.tar

將“https://api.example.com/endpoint”替換為實際的API端點,“your_api_token”替換為您的API憑證。

[2] 使用 Python 測試

  • 驗證Python安裝:要檢查是否安裝了Python,請打開命令提示字元或終端並輸入“python”。如果收到錯誤消息,說明未找到Python,您可以按照 官方Python網站上的說明進行安裝。確保您已安裝Python 3.8或更新版本,以使用Requests函式庫。
  • 建立並啟用虛擬環境:
    建立項目目錄和虛擬環境:按照官方Python venv文件的說明,在項目目錄中建立您的虛擬環境。

macOS

source your-virtual-environment-path/bin/activate

Windows

your-virtual-environment-path\Scripts\activate

將 your-virtual-environment-path 替換為虛擬環境目錄的實際路徑。

每個站點可以生成一個 API 憑證,可以由多個系統或軟體應用程式使用。然而,每個 API 憑證每小時的使用限制為 50 次請求。