開發第一個自訂整合項目

支援：

Google SecOps SOAR

重要事項：本文件說明如何使用內建 IDE 建構自訂整合。雖然仍支援快速原型，但這被視為舊版工作流程。目前的最佳做法是使用自己的 IDE 在本機開發整合項目，並透過 GitHub 進行管理。如要進一步瞭解新式 GitOps 工作流程，請參閱「建構自訂整合」。

本文說明如何在整合式開發環境 (IDE) 中，建立與商業整合項目結構相同的自訂整合項目。自訂整合項目會顯示在內容中心，您可以在該處為不同環境設定這些項目，以便在應對手冊、手動動作和遠端代理中使用。您也可以像其他 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. 在「Response」 > 「IDE」頁面，按一下「 add 新增」，新增 IDE 項目。
2. 選取「Integration」(整合) 圓形按鈕，然後輸入整合作業的名稱。
3. 點選「建立」。整合項目會顯示自訂整合圖示。
4. 按一下「 設定」。
5. 在整合對話方塊中，定義「圖示」、「說明」、「Python 依附元件」和「整合參數」。
   在這個範例中，會顯示下列詳細資料：
• 上傳 WhoisXML API 標誌的圖片。這張圖片會顯示在整合後的內容中心。
• IDE 中的整合項目旁新增了 SVG 圖示，並附有簡短說明和一個參數 (API 金鑰)。這是 Who Is XML API 產品設定整合時所需的參數。
• 這項整合不需要額外的 Python 程式庫。根據預設，整合項目會設為在 Python 3.11 上執行，您可以在「設定」中變更版本。
注意：指令碼依附元件是自訂整合項目必須匯入的 Python 程式庫。您可以新增 Wheel 檔案 (`WHL`)、tarball (`TAR`)、Gzip 封存檔 (`GZ`) 或 Python 檔案 (`PY`) 等格式。每項整合都會在專屬的虛擬環境中執行，因此即使系統已安裝其他版本，您仍可加入特定程式庫版本。舉例來說，如果您需要特定版本的 requests 程式庫，請從 PyPI 或 GitHub 等可信任的來源下載，並新增至指令碼依附元件。如果虛擬環境中沒有依附元件，整合功能會改用系統安裝的版本。

設定預設執行個體

建立整合項目後，您可以在 Google SecOps 回應整合項目中查看 (在搜尋列中搜尋整合項目名稱，或依「自訂整合項目」篩選整合項目類型)，並查看您為整合項目定義的圖片、說明和參數。

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

建立 Ping 動作

1. 在 「Response」 > 「IDE」中，依序點選 「add」 「Add」 > 「Add New IDE Item」。
2. 選取「Action」(動作) 圓形按鈕，輸入名稱，然後選取整合項目。
3. 點選「建立」。查看生成的程式碼範本。
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 專業人員尋求解答。