Crea la tua prima integrazione personalizzata

Supportato in:

Questo documento spiega come creare un'integrazione personalizzata nell'ambiente di sviluppo integrato (IDE) con la stessa struttura delle integrazioni commerciali. Le integrazioni personalizzate vengono visualizzate in Google Security Operations Marketplace, dove puoi configurarle per diversi ambienti da utilizzare in playbook, azioni manuali e agenti remoti. Puoi anche importarli ed esportarli, come altri elementi dell'IDE.

In questo esempio di integrazione personalizzata, creerai un'integrazione personalizzata per il prodotto API WHOIS XML. Inizia creando la tua prima integrazione incluso il processo di registrazione al prodotto WHOIS, che prevede la registrazione al prodotto e la creazione della chiave API richiesta.

Scegli il prodotto da integrare

  1. In questo esempio, eseguirai l'integrazione con il prodotto API WHOIS XML, uno strumento open source gratuito che fornisce l'accesso API ai dati di dominio, tra cui nome del registrante, organizzazione, indirizzo email, indirizzo di registrazione, informazioni sul registrar, date di creazione, scadenza e aggiornamento del dominio, disponibilità e età del dominio.
  2. Vai alla pagina API WHOIS XML e registrati.
  3. Dopo aver eseguito l'accesso, recupera la chiave API dalla pagina dell'account: https://user.whoisxmlapi.com/products
  4. Utilizza questa chiave API nei parametri di integrazione.

Crea la prima integrazione personalizzata nell'IDE

Per creare la tua prima integrazione personalizzata nell'IDE:

  1. Nella pagina Risposta > IDE, fai clic su Aggiungi Aggiungi per aggiungere un nuovo elemento IDE.
  2. Seleziona il pulsante di opzione Integrazione e inserisci un nome per l'integrazione.
  3. Fai clic su Crea. L'integrazione viene visualizzata con un'icona di integrazione personalizzata.
  4. Fai clic su Impostazioni.
  5. Nella finestra di dialogo di integrazione, definisci Icona, Descrizione, Dipendenze Python e Parametri di integrazione.
    In questo esempio, vengono visualizzati i seguenti dettagli:
    • Viene caricata un'immagine del logo dell'API WhoisXML. Questa immagine viene visualizzata in Google SecOps Marketplace con l'integrazione.
    • È stata aggiunta un'icona SVG accanto all'integrazione nell'IDE con una breve descrizione e un parametro, la chiave API. Questo è il parametro richiesto dal prodotto API XML Whois per la configurazione dell'integrazione.
    • Per questa integrazione non sono necessarie librerie Python aggiuntive. Per impostazione predefinita, l'integrazione è impostata per l'esecuzione su Python 3.7 e puoi modificare la versione in Impostazioni.

Configura l'istanza predefinita

Una volta creata l'integrazione, puoi visualizzarla in Integrazioni di risposta di Google SecOps (cerca il nome dell'integrazione nella barra di ricerca o filtra il tipo di integrazione in Integrazioni personalizzate) con l'immagine, la descrizione e il parametro che hai definito per l'integrazione.

  1. Fai clic su Impostazioni > Configura un'istanza predefinita.
  2. Inserisci la chiave API e fai clic su Salva.
  3. (Facoltativo) Per configurare l'integrazione per un altro ambiente (non quello predefinito), fai clic sulla scheda Configura e imposta i parametri per l'istanza.

Creare un'azione Ping

  1. In Risposta > IDE, fai clic su add Aggiungi > Aggiungi nuovo elemento IDE.
  2. Seleziona il pulsante di opzione Azione, inserisci un nome e seleziona l'integrazione.
  3. Fai clic su Crea. Esamina il modello di codice generato.
  4. Copia il seguente codice per l'azione Ping. L'azione Ping utilizza il parametro API Key che hai configurato per l'integrazione e lo inserisce nell'URL fornito dal prodotto a scopo di test. Per maggiori dettagli, vedi Creare azioni personalizzate. 
    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. Fai clic sul pulsante di attivazione/disattivazione sopra l'azione, quindi su Salva per testare la connessione al prodotto.
  6. Vai al Marketplace di Google SecOps, fai clic su Configura istanza predefinita e assicurati che l'integrazione sia configurata e salvata.
  7. Fai clic su Testa per testare l'integrazione. Una connessione riuscita mostra un segno di spunta verde, mentre una connessione non riuscita mostra una X con l'errore associato.
  8. Dopo aver completato l'autenticazione, crea la tua prima azione personalizzata nell'integrazione personalizzata. Per maggiori dettagli, vedi Creare azioni personalizzate.

Hai bisogno di ulteriore assistenza? Ricevi risposte dai membri della community e dai professionisti di Google SecOps.