创建您的首个自定义集成

支持的平台：

Google SecOps SOAR

本文档介绍了如何在集成开发环境 (IDE) 中创建与商业集成具有相同结构的自定义集成。自定义集成会显示在 Google Security Operations Marketplace 中，您可以在其中针对不同环境配置这些集成，以便在 playbook、手动操作和远程代理中使用。您还可以像其他 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. 点击创建。集成会显示自定义集成图标。
4. 点击 设置。
5. 在集成对话框中，定义图标、说明、Python 依赖项和集成参数。
   在此示例中，系统会显示以下详细信息：
• 上传了 WhoisXML API 徽标的图片。此图片会与集成一起显示在 Google SecOps Marketplace 中。
• 在 IDE 中，集成旁边添加了一个 SVG 图标，其中包含简要说明和一个参数（即 API 密钥）。这是 Whois XML API 产品在配置集成时所需的参数。
• 此集成不需要其他 Python 库。默认情况下，集成设置为在 Python 3.7 上运行，您可以在设置中更改版本。
注意：脚本依赖项是自定义集成必须导入的 Python 库。您可以添加 Wheel 文件 (`WHL`)、tarball (`TAR`)、Gzip 归档 (`GZ`) 或 Python 文件 (`PY`) 等格式的集成。每个集成都在自己的虚拟环境中运行，即使系统上已安装其他版本的库，您也可以包含特定版本的库。例如，如果您需要特定版本的 requests 库，请从可信来源（例如 PyPI 或 GitHub）下载该库，并将其添加到脚本依赖项中。如果依赖项不在虚拟环境中，集成会改用系统安装的版本。

配置默认实例

创建集成后，您可以在 Google SecOps 的“响应集成”中查看该集成（在搜索栏中搜索集成名称，或按自定义集成过滤集成类型），其中包含您为该集成定义的图片、说明和参数。

1. 依次点击 Settings（设置）> Configure a default Instance（配置默认实例）。
2. 输入您的 API 密钥，然后点击保存。
3. 可选：如需为其他环境（而非默认环境）配置集成，请点击配置标签页，然后为相应实例设置参数。
注意： 您必须先创建 Ping 操作，然后内置的测试按钮才能正常工作。

创建 Ping 操作

1. 在回答 > IDE 中，依次点击 添加 添加 > 添加新的 IDE 项。
2. 选择操作单选按钮，输入名称，然后选择集成。
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 专业人士那里获得解答。