Crea tu primera integración personalizada

Compatible con:

En este documento, se explica cómo crear una integración personalizada en el entorno de desarrollo integrado (IDE) con la misma estructura que las integraciones comerciales. Las integraciones personalizadas aparecen en Google Security Operations Marketplace, donde puedes configurarlas para diferentes entornos y usarlas en guías, acciones manuales y agentes remotos. También puedes importarlos y exportarlos, como otros elementos del IDE.

En este ejemplo de integración personalizada, compilarás una integración personalizada para el producto de la API de WHOIS XML. Comienza por crear tu primera integración, incluido el proceso de registro en el producto WHOIS, que incluye el registro en el producto y la creación de la clave de API requerida.

Elige el producto con el que deseas realizar la integración

  1. En este ejemplo, realizarás la integración con el producto API de WHOIS en XML, una herramienta de código abierto gratuita que proporciona acceso a la API de datos de dominios, incluidos el nombre del registrante, la organización, la dirección de correo electrónico, la dirección de registro, la información del registrador, las fechas de creación, vencimiento y actualización del dominio, la disponibilidad y la antigüedad del dominio.
  2. Ve a WHOIS XML API/ y regístrate.
  3. Después de acceder, obtén tu clave de API en la página de tu cuenta: https://user.whoisxmlapi.com/products
  4. Usa esta clave de API en los parámetros de integración.

Crea la primera integración personalizada en el IDE

Para crear tu primera integración personalizada en el IDE, sigue estos pasos:

  1. En la página Response > IDE, haz clic en add Agregar para agregar un nuevo elemento de IDE.
  2. Selecciona el botón de opción Integración y, luego, ingresa un nombre para la integración.
  3. Haz clic en Crear. La integración aparecerá con un ícono de integración personalizado.
  4. Haz clic en Configuración.
  5. En el diálogo de integración, define el ícono, la descripción, las dependencias de Python y los parámetros de integración.
    En este ejemplo, aparecen los siguientes detalles:
    • Se subió una imagen del logotipo de la API de WhoisXML. Esta imagen aparece en Google SecOps Marketplace con la integración.
    • Se agregó un ícono SVG junto a la integración en el IDE con una breve descripción y un parámetro, la clave de API. Este es el parámetro que requiere el producto de la API de Whois en XML para la configuración de la integración.
    • No necesitas bibliotecas de Python adicionales para esta integración. De forma predeterminada, la integración se configura para ejecutarse en Python 3.7, y puedes cambiar la versión en Configuración.

Configura la instancia predeterminada

Una vez que crees la integración, podrás verla en tus Integraciones de respuesta de Google SecOps (busca el nombre de la integración en la barra de búsqueda o filtra el tipo de integración por Integraciones personalizadas) con la imagen, la descripción y el parámetro que definiste para la integración.

  1. Haz clic en Configuración > Configurar una instancia predeterminada.
  2. Ingresa tu clave de API y haz clic en Guardar.
  3. Opcional: Para configurar la integración en otro entorno (que no sea el predeterminado), haz clic en la pestaña Configurar y establece los parámetros para esa instancia.

Crea una acción de Ping

  1. En Response > IDE, haz clic en add Add > Add New IDE Item.
  2. Selecciona el botón de selección Action, ingresa un nombre y selecciona la integración.
  3. Haz clic en Crear. Revisa la plantilla de código generada.
  4. Copia el siguiente código para la acción Ping. La acción Ping usa el parámetro API Key que configuraste para la integración y lo coloca en la URL que proporciona el producto con fines de prueba. Para obtener más información, consulta Crea acciones personalizadas. 
    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. Haz clic en el botón de activación sobre la acción y, luego, en Guardar para probar la conexión al producto.
  6. Ve a Google SecOps Marketplace, haz clic en Configurar instancia predeterminada y asegúrate de que la integración esté configurada y guardada.
  7. Haz clic en Probar para probar la integración. Una conexión exitosa muestra una marca de verificación verde, mientras que una conexión fallida muestra una X con el error asociado.
  8. Después de completar la autenticación, crea tu primera acción personalizada en la integración personalizada. Para obtener más información, consulta Cómo crear acciones personalizadas.

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.