Criar sua primeira integração personalizada

Compatível com:

Neste documento, explicamos como criar uma integração personalizada no ambiente de desenvolvimento integrado (IDE) com a mesma estrutura das integrações comerciais. As integrações personalizadas aparecem no Google Security Operations Marketplace, onde você pode configurá-las para diferentes ambientes e usar em playbooks, ações manuais e agentes remotos. Você também pode importar e exportar esses itens, assim como outros itens do ambiente de desenvolvimento integrado.

Neste exemplo de integração personalizada, você vai criar uma integração personalizada para o produto API WHOIS XML. Comece criando sua primeira integração, incluindo o processo de registro no produto WHOIS, que envolve se inscrever no produto e criar a chave de API necessária.

Escolha o produto para integrar

  1. Neste exemplo, você vai se integrar ao produto API XML do WHOIS, uma ferramenta gratuita de código aberto que oferece acesso à API para dados de domínio, incluindo nome do registrante, organização, endereço de e-mail, endereço de registro, informações do registrador, criação, expiração e datas de atualização do domínio, disponibilidade e idade do domínio.
  2. Acesse API XML do WHOIS e faça o registro.
  3. Depois de fazer login, acesse a chave de API na página da sua conta: https://user.whoisxmlapi.com/products
  4. Use essa chave de API nos parâmetros de integração.

Criar a primeira integração personalizada no ambiente de desenvolvimento integrado

Para criar sua primeira integração personalizada no ambiente de desenvolvimento integrado, siga estas etapas:

  1. Na página Resposta > IDE, clique em add Adicionar para adicionar um novo item de ambiente de desenvolvimento integrado.
  2. Selecione o botão de opção Integração e insira um nome para a integração.
  3. Clique em Criar. A integração aparece com um ícone personalizado.
  4. Clique em Configurações.
  5. Na caixa de diálogo de integração, defina o Ícone, a Descrição, as Dependências do Python e os Parâmetros de integração.
    Neste exemplo, os seguintes detalhes aparecem:
    • Uma imagem do logotipo da API WhoisXML é enviada. Essa imagem aparece no Google SecOps Marketplace com a integração.
    • Um ícone SVG foi adicionado ao lado da integração no ambiente de desenvolvimento integrado com uma breve descrição e um parâmetro, a chave de API. Esse é o parâmetro que o produto API Whois XML exige para a configuração da integração.
    • Não são necessárias bibliotecas Python adicionais para essa integração. Por padrão, a integração é definida para ser executada no Python 3.7, e você pode mudar a versão em Configurações.

Configurar a instância padrão

Depois de criar a integração, você pode conferir em "Integrações de resposta" do Google SecOps. Para isso, pesquise o nome da integração na barra de pesquisa ou filtre o tipo de integração por Integrações personalizadas. A imagem, a descrição e o parâmetro definidos para a integração vão aparecer.

  1. Clique em Configurações > Configurar uma instância padrão.
  2. Insira sua chave de API e clique em Salvar.
  3. Opcional: para configurar a integração em outro ambiente (não o padrão), clique na guia Configurar e defina os parâmetros dessa instância.

Criar uma ação de ping

  1. No IDE > Response, clique em add Adicionar > Adicionar novo item do IDE.
  2. Selecione o botão de opção Ação, insira um nome e escolha a integração.
  3. Clique em Criar. Revise o modelo de código gerado.
  4. Copie o código a seguir para a ação Ping. A ação Ping usa o parâmetro API Key que você configurou para a integração e o coloca no URL fornecido pelo produto para fins de teste. Para mais detalhes, consulte Criar ações 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. Clique na chave acima da ação e em Salvar para testar a conexão com o produto.
  6. Acesse o Google SecOps Marketplace, clique em Configurar instância padrão e verifique se a integração está configurada e salva.
  7. Clique em Testar para testar a integração. Uma conexão bem-sucedida mostra uma marca de seleção verde. Uma conexão com falha mostra um X com o erro associado.
  8. Depois de concluir a autenticação, crie sua primeira ação personalizada na integração personalizada. Para mais detalhes, consulte Criar ações personalizadas.

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.