Enviando eventos para MID Server usando a API de serviço da web

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 3 min. de leitura

    • Configure o Coletor de eventos do MID WebService para fornecer um método de URL para enviar mensagens de evento para o MID Server.

    O coletor de eventos do MID WebService, por padrão, permite que você se conecte a um gerador de eventos e envie mensagens de evento por meio do MID Server, usando um URL no formato: http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em /jsonv2

    O formato JSON v2 é o mesmo que os clientes usam para enviar mensagens de evento para a instância. Este URL oferece bom desempenho.

    Para obter mais informações, consulte Configurar o Contexto do coletor de eventos de MID Web Server.
    Nota:
    Gestão de eventos aceita eventos no fuso horário de MID Server por meio do qual o ouvinte enviou a mensagem de evento. Se você precisar de um fuso horário diferente, poderá configurar o script conforme necessário. Consulte Integrar com conectores push.

    URL para enviar cargas personalizadas

    O MID Server também pode receber uma carga personalizada em formato JSON, XML ou texto sem formatação. Nesse caso, o MID Server transforma as mensagens de evento usando a inclusão de script que você fornece e, em seguida, envia os eventos para a instância. O URL, neste caso, é:

    http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event?Transform={Transform_script_name} Para obter um exemplo de uma inclusão de script, consulte a inclusão de script TransformEvents_xmlSample padrão.

    Para obter um exemplo de como o Coletor de eventos do MID WebService transforma mensagens de evento no formato JSON, consulte Coleção de eventos do BMC TrueSight e BMC TrueSight_v2.

    Para enviar eventos no formato JSON genérico, você pode usar o URL neste formato:

    http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event?Transform=TransformEvents_MidJsonGeneric

    Nesse caso, a inclusão de script TransformEvents_MidJsonGeneric MID fornecida na instância base transforma as mensagens do evento nos campos do evento. Todos os campos são adicionados como campos de informações adicionais ao evento da ServiceNow gerado.

    Nota:
    O URL no formato http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/{transform_script_name}também é compatível.

    O URL da REST API para validar a conectividade é: http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/ping

    Inclusão de script para transformar eventos coletados

    Use a inclusão de script MID Server necessária para transformar (analisar) as mensagens de evento coletadas e preenchê-las no campo de evento mapeado. O nome da inclusão de script MID Server é composto por um prefixo e um sufixo. O prefixo é o texto obrigatório TransformEvents_ e o sufixo é o nome da transformação no URL, por exemplo, http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/xmlSample . O nome do script composto é, portanto, TransformEvents_xmlSample.

    Você deve fornecer uma inclusão de script que receba as mensagens de evento em uma variável de texto. O script deve ter uma função transform() que executa a transformação e prepara a matriz de retorno de objetos de evento. Quando o plug-in Gestão de eventos é ativado, você recebe o script de inclusão de exemplo TransformEvents_xmlSample que transforma eventos do formato XML.

    Nota:
    Os campos de evento que não são idênticos aos campos na tabela de eventos são salvos no campo Informações adicionais.

    Cabeçalhos de mensagem de evento

    Especifique o valor do cabeçalho da solicitação relevante para o campo Tipo de conteúdo de acordo com o formato da mensagem do evento.

    Tabela 1. Solicitar valores de cabeçalho para o tipo de conteúdo
    Formato da mensagem Valor do tipo de conteúdo
    JSON aplicação/json
    XML aplicação/xml
    texto texto/simples

    Opções de autenticação e segurança de dados

    Opções para autenticação e segurança de dados:
    • Tipo de autenticação, que pode ser definido como Chave de API ou Básica.
    • Conexão segura, que permite escolher se os dados de entrada e de saída serão protegidos quando transmitidos. Se você escolher a opção avançada protegida, será necessário obter um certificado de uma autoridade de certificação conhecida e fornecer o alias do certificado do armazenamento de chaves e a senhado armazenamento de chaves.
    • Use o MID Unified Keystore, que fornece proteção de criptografia e permite que você instale um certificado personalizado no MID Server armazenamento de chaves unificado. Para obter detalhes, consulte Instalar certificados personalizados no armazenamento de chaves unificado do MID Server.
    • Os usuários devem fornecer um script que receba as mensagens de evento em formato JSON, XML ou texto em uma variável de texto. O script deve ter uma função transform() que executa a transformação e prepara a matriz de retorno de objetos de evento. O script de inclusão TransformEvents_xmlSample que transforma eventos do formato XML é fornecido como um exemplo quando o plug-in Gestão de eventos está ativado.
    Para obter mais informações sobre autenticação e segurança de dados, consulte Configurar a extensão MID Web Server.