最初のカスタム統合を開発する

以下でサポートされています。

このドキュメントでは、統合開発環境（IDE）で商用統合と同じ構造のカスタム統合を作成する方法について説明します。カスタム統合はコンテンツ ハブに表示され、ハンドブック、手動アクション、リモート エージェントで使用するさまざまな環境用に構成できます。他の IDE アイテムと同様に、インポートとエクスポートも可能です。

このカスタム統合の例では、WHOIS XML API プロダクトのカスタム統合を構築します。まず、WHOIS プロダクトへの登録プロセスを含む最初の統合を作成します。これには、プロダクトへの登録と必要な API キーの作成が含まれます。

統合するプロダクトを選択する

  1. この例では、WHOIS XML API プロダクトと統合します。これは、登録者の名前、組織、メールアドレス、登録住所、登録機関の情報、ドメインの作成日、有効期限、更新日、ドメインの可用性、年齢などのドメインデータへの API アクセスを提供する無料のオープンソース ツールです。
  2. WHOIS XML API にアクセスして登録します。
  3. ログインしたら、アカウント ページ（https://user.whoisxmlapi.com/products）から API キーを取得します。
  4. この API キーを統合パラメータで使用します。

IDE で最初のカスタム インテグレーションを作成する

IDE で最初のカスタム統合を作成する手順は次のとおりです。

  1. [Response > IDE] ページで、 add [追加] をクリックして、新しい IDE アイテムを追加します。
  2. [統合] ラジオボタンを選択し、統合の名前を入力します。
  3. [作成] をクリックします。統合がカスタム統合アイコンとともに表示されます。
  4. [ 設定] をクリックします。
  5. 統合ダイアログで、[Icon]、[Description]、[Python Dependencies]、[Integration Parameters] を定義します。
    この例では、次の詳細が表示されます。
    • WhoisXML API のロゴの画像がアップロードされています。この画像は、統合された Content Hub に表示されます。
    • IDE の統合の横に SVG アイコンが追加され、簡単な説明と 1 つのパラメータ（API キー）が表示されます。これは、Who Is XML API プロダクトが統合の構成に必要とするパラメータです。
    • この統合に追加の Python ライブラリは必要ありません。デフォルトでは、統合は Python 3.7 で実行されるように設定されています。バージョンは [設定] で変更できます。

デフォルトのインスタンスを構成する

統合を作成すると、Google SecOps のレスポンス統合で表示できます（検索バーで統合名を検索するか、統合タイプを [カスタム統合] でフィルタします）。統合用に定義した画像、説明、パラメータが表示されます。

  1. [設定] > [デフォルト インスタンスを構成] をクリックします。
  2. API キーを入力して [Save] をクリックします。
  3. 省略可: 別の環境（デフォルト環境以外）の統合を構成するには、[構成] タブをクリックして、そのインスタンスのパラメータを設定します。

Ping アクションを作成する

  1. [レスポンス > IDE] で、 追加 [追加] > [新しい IDE 項目を追加] をクリックします。
  2. [アクション] ラジオボタンを選択し、名前を入力して、統合を選択します。
  3. [作成] をクリックします。生成されたコード テンプレートを確認します。
  4. Ping アクションの次のコードをコピーします。Ping アクションは、統合用に構成した API Key パラメータを使用し、テスト目的でプロダクトから提供された URL に配置します。詳細については、カスタム アクションを作成するをご覧ください。
    5. 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 のプロフェッショナルから回答を得ることができます。