Crear tu primera integración personalizada

Disponible en:

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, crearás una integración personalizada para el producto API XML de WHOIS. Empieza creando tu primera integración, incluido el proceso de registro en el producto WHOIS, que consiste en registrarse en el producto y crear la clave de API necesaria.

Elige el producto con el que quieres integrar

  1. En este ejemplo, integrarás el producto API XML de WHOIS, una herramienta gratuita de código abierto que proporciona acceso a la API de datos de dominio, como el nombre del titular, 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, caducidad y actualización del dominio, la disponibilidad y la antigüedad del dominio.
  2. Ve a API XML de WHOIS y regístrate.
  3. Después de iniciar sesión, obtenga su clave de API en la página de su cuenta: https://user.whoisxmlapi.com/products
  4. Usa esta clave de API en los parámetros de integración.

Crear 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 Respuesta > IDE, haz clic en Añadir Añadir para añadir un nuevo elemento del IDE.
  2. Seleccione el botón de radio Integración e introduzca un nombre para la integración.
  3. Haz clic en Crear. La integración aparece con un icono de integración personalizada.
  4. Haz clic en Configuración.
  5. En el cuadro de diálogo de integración, define el Icono, la Descripción, las Dependencias de Python y los Parámetros de integración.
    En este ejemplo, se muestran los siguientes detalles:
    • Se ha subido una imagen del logotipo de la API WhoisXML. Esta imagen aparece en Google SecOps Marketplace con la integración.
    • Se ha añadido un icono 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 API XML de Whois para configurar la integración.
    • No necesitas bibliotecas de Python adicionales para esta integración. De forma predeterminada, la integración se ejecuta en Python 3.7, pero puedes cambiar la versión en Configuración.

Configurar la instancia predeterminada

Una vez que hayas creado la integración, podrás verla en 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 hayas definido para la integración.

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

Crear una acción Ping

  1. En Respuesta > IDE, haz clic en add Añadir > Añadir nuevo elemento de IDE.
  2. Seleccione el botón de radio Acción, introduzca un nombre y seleccione 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 has configurado para la integración y lo coloca en la URL proporcionada por el producto con fines de prueba. Para obtener más información, consulta el artículo sobre cómo crear 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 interruptor situado encima de la acción y, a continuación, en Guardar para probar la conexión con el producto.
  6. Ve a Google SecOps Marketplace, haz clic en Configurar instancia predeterminada y comprueba que la integración esté configurada y guardada.
  7. Haz clic en Probar para probar la integración. Si la conexión se establece correctamente, se muestra una marca de verificación verde. Si no se establece, se muestra una X con el error asociado.
  8. Una vez que hayas completado la autenticación, crea tu primera acción personalizada en la integración personalizada. Para obtener más información, consulta el artículo Crear acciones personalizadas.

¿Necesitas más ayuda? Recibe respuestas de los miembros de la comunidad y de los profesionales de Google SecOps.