Créer votre première intégration personnalisée

Compatible avec :

Ce document explique comment créer une intégration personnalisée dans l'environnement de développement intégré (IDE) avec la même structure que les intégrations commerciales. Les intégrations personnalisées s'affichent sur la place de marché Google Security Operations, où vous pouvez les configurer pour différents environnements à utiliser dans les playbooks, les actions manuelles et les agents à distance. Vous pouvez également les importer et les exporter, comme d'autres éléments de l'IDE.

Dans cet exemple d'intégration personnalisée, vous allez créer une intégration personnalisée pour le produit API WHOIS XML. Commencez par créer votre première intégration, y compris le processus d'enregistrement au produit WHOIS, en vous inscrivant au produit et en créant la clé API requise.

Choisissez le produit à intégrer.

  1. Dans cet exemple, vous allez intégrer le produit WHOIS XML API, un outil Open Source gratuit qui fournit un accès API aux données de domaine, y compris le nom du titulaire, l'organisation, l'adresse e-mail, l'adresse d'enregistrement, les informations sur le bureau d'enregistrement, les dates de création, d'expiration et de mise à jour du domaine, la disponibilité et l'âge du domaine.
  2. Accédez à l'API XML WHOIS et inscrivez-vous.
  3. Une fois connecté, récupérez votre clé API sur la page de votre compte : https://user.whoisxmlapi.com/products
  4. Utilisez cette clé API dans vos paramètres d'intégration.

Créer la première intégration personnalisée dans l'IDE

Pour créer votre première intégration personnalisée dans l'IDE, procédez comme suit :

  1. Sur la page Réponse > IDE, cliquez sur add Ajouter pour ajouter un élément IDE.
  2. Sélectionnez le bouton radio Intégration et saisissez un nom pour l'intégration.
  3. Cliquez sur Créer. L'intégration s'affiche avec une icône d'intégration personnalisée.
  4. Cliquez sur Paramètres.
  5. Dans la boîte de dialogue d'intégration, définissez l'icône, la description, les dépendances Python et les paramètres d'intégration.
    Dans cet exemple, les informations suivantes s'affichent :
    • Une image du logo de l'API WhoisXML est importée. Cette image apparaît dans Google SecOps Marketplace avec l'intégration.
    • Une icône SVG a été ajoutée à côté de l'intégration dans l'IDE, avec une brève description et un paramètre (la clé API). Il s'agit du paramètre requis par le produit Whois XML API pour la configuration de l'intégration.
    • Vous n'avez pas besoin de bibliothèques Python supplémentaires pour cette intégration. Par défaut, l'intégration est configurée pour s'exécuter sur Python 3.7. Vous pouvez modifier la version dans Paramètres.

Configurer l'instance par défaut

Une fois l'intégration créée, vous pouvez l'afficher dans les intégrations de réponse Google SecOps (recherchez le nom de l'intégration dans la barre de recherche ou filtrez le type d'intégration par Intégrations personnalisées) avec l'image, la description et le paramètre que vous avez définis pour l'intégration.

  1. Cliquez sur Paramètres > Configurer une instance par défaut.
  2. Saisissez votre clé API, puis cliquez sur Enregistrer.
  3. Facultatif : Pour configurer l'intégration pour un autre environnement (pas l'environnement par défaut), cliquez sur l'onglet Configurer et définissez les paramètres de cette instance.

Créer une action Ping

  1. Dans Réponse > IDE, cliquez sur add Ajouter > Ajouter un élément IDE.
  2. Sélectionnez le bouton radio Action, saisissez un nom et sélectionnez l'intégration.
  3. Cliquez sur Créer. Examinez le modèle de code généré.
  4. Copiez le code suivant pour l'action Ping. L'action Ping utilise le paramètre API Key que vous avez configuré pour l'intégration et le place dans l'URL fournie par le produit à des fins de test. Pour en savoir plus, consultez Créer des actions personnalisées. 
    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. Cliquez sur le bouton bascule au-dessus de l'action, puis sur Enregistrer pour tester la connexion au produit.
  6. Accédez au Google SecOps Marketplace, cliquez sur Configurer l'instance par défaut, puis assurez-vous que l'intégration est configurée et enregistrée.
  7. Cliquez sur Tester pour tester l'intégration. Une coche verte indique que la connexion a réussi, tandis qu'une croix X accompagnée de l'erreur associée indique qu'elle a échoué.
  8. Une fois l'authentification terminée, créez votre première action personnalisée dans l'intégration personnalisée. Pour en savoir plus, consultez Créer des actions personnalisées.

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.