建立第一個自訂整合項目

支援的國家/地區：

Google SecOps SOAR

本文說明如何在整合式開發環境 (IDE) 中建立自訂整合，並採用與商業整合相同的結構。自訂整合項目會顯示在 Google Security Operations Marketplace 中，您可以在這裡為不同環境設定整合項目，以便在應對手冊、手動動作和遠端代理程式中使用。您也可以匯入及匯出這些項目，就像其他 IDE 項目一樣。

在這個自訂整合範例中，您將為 WHOIS XML API 產品建構自訂整合項目。首先，請建立第一個整合項目，包括向 WHOIS 產品註冊的程序，例如註冊產品及建立必要的 API 金鑰。

選擇要整合的產品

1. 在本例中，您將整合 WHOIS XML API 產品，這項免費的開放原始碼工具提供網域資料的 API 存取權，包括註冊者姓名、機構、電子郵件地址、註冊地址、註冊機構資訊、網域建立、到期和更新日期、網域可用性及網域年齡。
2. 前往 WHOIS XML API 並註冊。
3. 登入後，請前往帳戶頁面取得 API 金鑰： https://user.whoisxmlapi.com/products
4. 在整合參數中使用這組 API 金鑰。

在 IDE 中建立第一個自訂整合項目

如要在 IDE 中建立第一個自訂整合，請按照下列步驟操作：

1. 在「回應」>「IDE」頁面中，按一下「新增」 ，新增 IDE 項目。
2. 選取「整合」單選按鈕，然後輸入整合名稱。
3. 點按「Create」(建立)。整合項目會顯示自訂整合圖示。
4. 按一下「設定」。
5. 在整合對話方塊中，定義「圖示」、「說明」、「Python 依附元件」和「整合參數」。
   在這個範例中，系統會顯示下列詳細資料：
• 上傳 WhoisXML API 標誌的圖片。這張圖片會與整合項目一起顯示在 Google SecOps Marketplace 中。
• IDE 中整合項目旁邊新增了 SVG 圖示，並附上簡短說明和一個參數 (API 金鑰)。這是Who Is XML API 產品整合設定所需的參數。
• 整合時不需要額外的 Python 程式庫。根據預設，整合功能會以 Python 3.7 執行，您可以在「設定」中變更版本。
注意：指令碼依附元件是自訂整合項目必須匯入的 Python 程式庫。您可以新增 Wheel 檔案 (`WHL`)、tarball (`TAR`)、Gzip 封存檔 (`GZ`) 或 Python 檔案 (`PY`) 等格式的整合項目。每個整合項目都會在各自的虛擬環境中執行，因此即使系統已安裝其他版本，您仍可納入特定程式庫版本。舉例來說，如果您需要特定版本的 requests 程式庫，請從受信任的來源 (例如 PyPI 或 GitHub) 下載，然後新增至指令碼依附元件。如果依附元件不在虛擬環境中，整合功能會改用系統安裝的版本。

設定預設執行個體

建立整合後，您可以在 Google SecOps 的「Response Integrations」(回應整合) 中查看整合 (在搜尋列中搜尋整合名稱，或依「Integration type」(整合類型) 篩選 Custom Integrations)，其中會顯示您為整合定義的圖片、說明和參數。

1. 依序點按「設定」>「設定預設執行個體」。
2. 輸入 API 金鑰，然後按一下「儲存」。
3. 選用：如要為其他環境 (非預設環境) 設定整合功能，請按一下「設定」分頁，然後設定該執行個體的參數。
注意： 您必須先建立 Ping 動作，內建的「測試」按鈕才能運作。

建立 Ping 動作

1. 在「回應」> IDE 中，依序點選「新增」 「新增」>「新增 IDE 項目」。
2. 選取「動作」單選按鈕，輸入名稱，然後選取整合服務。
3. 點按「Create」(建立)。查看生成的程式碼範本。
4. 複製「Ping」動作的下列程式碼。「Ping」動作會使用您為整合設定的 API Key 參數，並將其放入產品提供的網址中，以進行測試。詳情請參閱「建立自訂動作」。

from SiemplifyAction import SiemplifyAction
from SiemplifyUtils import output_handler
import requests

INTEGRATION_NAME = "My first Integration - Whois XML API"
SCRIPT_NAME = "Whois XML API Ping"

@output_handler
def main():
    siemplify = SiemplifyAction()
    siemplify.script_name = SCRIPT_NAME

    api_key = siemplify.extract_configuration_param(provider_name=INTEGRATION_NAME,
                                                    param_name="API Key")
    url = "https://www.whoisxmlapi.com/whoisserver/WhoisService?apiKey={api_key}&domainName=google.com".format(api_key=api_key)

    res = requests.get(url)
    res.raise_for_status()

    if "ApiKey authenticate failed" in res.content.decode("utf-8"):
        raise Exception("Error, bad credentials")

    siemplify.end("Successful Connection", True)
if __name__ == "__main__":
    main() 

5. 按一下動作上方的切換鈕，然後按一下「儲存」，測試與產品的連線。
6. 前往 Google SecOps Marketplace，按一下「設定預設執行個體」，然後確認整合功能已設定並儲存。
7. 按一下「測試」即可測試整合功能。連線成功會顯示綠色勾號；連線失敗則會顯示 X 和相關錯誤。
8. 完成驗證後，請在自訂整合中建立第一個自訂動作。詳情請參閱「建立自訂動作」。

還有其他問題嗎？向社群成員和 Google SecOps 專業人員尋求答案。