Enviando eventos para MID ServerUsando a API de serviço web

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 3 min. de leitura

    • Configure o coletor de eventos do MID WebService para fornecer um método de URL para enviar mensagens de evento por push 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 uma URL no formato: http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2

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

    Para obter mais informações, consulte Configurar o Contexto do coletor de eventos de MID Web Server.
    Nota:
    Gestão de eventosaceita eventos no fuso horário do MID Serverpor meio do qual o ouvinte enviou a mensagem do 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

    . MID ServerTambém pode receber uma carga personalizada no formato JSON, XML ou texto simples. Nesse caso, o. MID Servertransforma as mensagens de evento usando a inclusão de script que você fornece e 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 inclusão de script, consulte o padrão TransformEvents_xmlSample inclusão de script.

    Para obter um exemplo de como o coletor de eventos do MID WebService transforma mensagens de evento formatadas em JSON, consulte .

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

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

    Nesse caso, o. TransformEvents_MidJsonGeneric A inclusão de script MID fornecida na instância base transforma as mensagens de evento nos campos de evento. Todos os campos são adicionados como Informações adicionais Campos no evento ServiceNow gerados.

    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 o necessário MID Serverinclusão de script para transformar (analisar) mensagens de evento coletadas e preenchê-las no campo de evento mapeado. . MID Servero nome de inclusão do script é composto por um prefixo e 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 um transformação() Função que executa a transformação e prepara a matriz de retorno de objetos de evento. Quando o. Gestão de eventoso plug-in está ativado, você recebe o. TransformEvents_xmlSample Script de inclusão de amostra 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 Informações adicionais campo.

    Cabeçalhos de mensagem de evento

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

    Tabela 1. Valores de cabeçalho da solicitação 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

    Autenticação e opções de segurança de dados

    Opções para autenticação e segurança de dados:
    • Tipo de autenticação , que pode ser definido como qualquer um Chave de API ou Básico .
    • Conexão segura , que permite que você escolha se os dados de entrada e saída serão protegidos quando transmitidos. Se você escolher a opção segura avançada, ela exigirá que você obtenha um certificado de uma autoridade de certificação conhecida e forneça o. Alias do certificado do armazenamento de chaves e o. Senha do armazenamento de chaves .
    • Use o armazenamento de chaves unificado DO MID , que fornece proteção de criptografia e permite instalar um certificado personalizado no MID Serverarmazenamento de chaves unificado. Para obter detalhes, consulte Instale certificados personalizados no armazenamento de chaves unificado do MID Server .
    • Os usuários devem fornecer um script que receba as mensagens de evento formatadas 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. . TransformEvents_xmlSample Incluir script que transforma eventos do formato XML é fornecido como exemplo quando o. Gestão de eventoso plug-in está ativado.
    Para obter mais informações sobre autenticação e segurança de dados, consulte Configure o. MID Web Serverextensão.