Erste benutzerdefinierte Integration entwickeln

Unterstützt in:

In diesem Dokument wird erläutert, wie Sie in der integrierten Entwicklungsumgebung (Integrated Development Environment, IDE) eine benutzerdefinierte Integration mit derselben Struktur wie kommerzielle Integrationen erstellen. Benutzerdefinierte Integrationen werden im Content Hub angezeigt. Dort können Sie sie für verschiedene Umgebungen konfigurieren, um sie in Playbooks, manuellen Aktionen und Remote-Agents zu verwenden. Wie andere IDE-Elemente können Sie sie auch importieren und exportieren.

In diesem Beispiel für eine benutzerdefinierte Integration erstellen Sie eine benutzerdefinierte Integration für das Produkt WHOIS XML API. Erstellen Sie zuerst Ihre erste Integration einschließlich des Registrierungsprozesses für das WHOIS-Produkt. Dazu gehört die Registrierung für das Produkt und die Erstellung des erforderlichen API-Schlüssels.

Produkt für die Integration auswählen

  1. In diesem Beispiel wird das Produkt WHOIS XML API integriert. Dabei handelt es sich um ein kostenloses Open-Source-Tool, das API-Zugriff auf Domaindaten bietet, einschließlich des Namens des Registranten, der Organisation, der E-Mail-Adresse, der Registrierungsadresse, der Registrarinformationen, des Erstellungs-, Ablauf- und Aktualisierungsdatums der Domain, der Verfügbarkeit und des Alters der Domain.
  2. Rufen Sie die WHOIS XML API auf und registrieren Sie sich.
  3. Nachdem Sie sich angemeldet haben, rufen Sie Ihren API-Schlüssel auf Ihrer Kontoseite ab: https://user.whoisxmlapi.com/products
  4. Verwenden Sie diesen API-Schlüssel in Ihren Integrationsparametern.

Erste benutzerdefinierte Integration in der IDE erstellen

So erstellen Sie Ihre erste benutzerdefinierte Integration in der IDE:

  1. Klicken Sie auf der Seite Antwort > IDE auf Hinzufügen Hinzufügen, um ein neues IDE-Element hinzuzufügen.
  2. Wählen Sie das Integration Optionsfeld aus und geben Sie einen Namen für die Integration ein.
  3. Klicken Sie auf Erstellen. Die Integration wird mit einem benutzerdefinierten Integrationssymbol angezeigt.
  4. Klicken Sie auf Einstellungen.
  5. Definieren Sie im Dialogfeld „Integration“ das Symbol, die Beschreibung, die Python-Abhängigkeiten und die Integrationsparameter.
    In diesem Beispiel werden die folgenden Details angezeigt:
    • Ein Bild des WhoisXML API-Logos wird hochgeladen. Dieses Bild wird im Content Hub mit der Integration angezeigt.
    • Neben der Integration in der IDE wurde ein SVG-Symbol mit einer kurzen Beschreibung und einem Parameter, dem API-Schlüssel, hinzugefügt. Dies ist der Parameter, der für die Konfiguration der Integration für das Produkt Whois XML API erforderlich ist.
    • Für diese Integration sind keine zusätzlichen Python-Bibliotheken erforderlich. Standardmäßig wird die Integration unter Python 3.7 ausgeführt. Sie können die Version unter Einstellungen ändern.

Standardinstanz konfigurieren

Nachdem Sie die Integration erstellt haben, können Sie sie in Ihren Google SecOps Response-Integrationen sehen. Suchen Sie dazu in der Suchleiste nach dem Namen der Integration oder filtern Sie den Integrationstyp nach Benutzerdefinierte Integrationen. Die Integration wird mit dem Bild, der Beschreibung und dem Parameter angezeigt, die Sie für sie definiert haben.

  1. Klicken Sie auf Einstellungen > Standardinstanz konfigurieren.
  2. Geben Sie Ihren API-Schlüssel ein und klicken Sie auf Speichern.
  3. Optional: Wenn Sie die Integration für eine andere Umgebung als die Standardumgebung konfigurieren möchten, klicken Sie auf den Tab Konfigurieren und legen Sie Parameter für diese Instanz fest.

Ping-Aktion erstellen

  1. Klicken Sie unter Antwort > IDE auf „Hinzufügen“ add Hinzufügen > Neues IDE-Element hinzufügen.
  2. Wählen Sie das Optionsfeld Aktion aus, geben Sie einen Namen ein und wählen Sie die Integration aus.
  3. Klicken Sie auf Erstellen. Prüfen Sie die generierte Codevorlage.
  4. Kopieren Sie den folgenden Code für die Ping -Aktion. Die Ping -Aktion verwendet den API Key Parameter, den Sie für die Integration konfiguriert haben, und fügt ihn zu Testzwecken in die vom Produkt bereitgestellte URL ein. Weitere Informationen finden Sie unter Benutzerdefinierte Aktionen erstellen. 
    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. Klicken Sie auf den Schalter über der Aktion und dann auf Speichern , um die Verbindung zum Produkt zu testen.
  6. Rufen Sie den Google SecOps Marketplace auf, klicken Sie auf Standardinstanz konfigurieren und prüfen Sie, ob die Integration konfiguriert und gespeichert wurde.
  7. Klicken Sie auf Testen , um die Integration zu testen. Bei einer erfolgreichen Verbindung wird ein grünes Häkchen angezeigt. Bei einer fehlgeschlagenen Verbindung wird ein X mit dem zugehörigen Fehler angezeigt.
  8. Nachdem Sie die Authentifizierung abgeschlossen haben, erstellen Sie Ihre erste benutzerdefinierte Aktion in der benutzerdefinierten Integration. Weitere Informationen finden Sie unter Benutzerdefinierte Aktionen erstellen.

Benötigen Sie weitere Hilfe? Sie können sich an Community-Mitglieder und Google SecOps-Experten wenden.