Transmettre des événements par push à l’aide de l’API de Serveur MID service Web

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 3 minutes de lecture

    • Configurez le collecteur d'événements MID WebService pour fournir une méthode d'URL pour transmettre par push les messages d'événement au Serveur MID.

    Par défaut, le collecteur d'événements MID WebService vous permet de vous connecter à un générateur d'événements et d'envoyer des messages d'événement via le Serveur MID, à l'aide d'une URL au format suivant : http://{IP_MID_Server}:{port_MID_Web_Server}/api/mid/em/jsonv2

    Le format JSON v2 est le même que le format que les clients utilisent pour envoyer des messages d'événement à l'instance. Cette URL assure des performances optimales.

    Pour en savoir plus, consultez la rubrique Configurer le contexte du collecteur d'événements MID WebService.
    Remarque :
    Gestion des événements accepte les événements dans le fuseau horaire du Serveur MID par le biais duquel l'écouteur a envoyé le message d'événement. Si vous souhaitez utiliser un fuseau horaire différent, vous pouvez configurer le script selon vos besoins ; consultez la rubrique Intégrer à des connecteurs push.

    URL pour transmettre par push des charges utiles personnalisées

    Serveur MID peut également recevoir une charge utile personnalisée au format JSON, au format XML ou en texte brut. Dans ce cas, Serveur MID convertit les messages d'événement à l'aide du script Include que vous fournissez, puis envoient les événements à l'instance. L'URL est la suivante :

    http://{IP_MID_Server}:{port_MID_Web_Server}/api/mid/em/inbound_event?Transform={nom_script_conversion} Pour un exemple de script Include, consultez le script Include TransformEvents_xmlSample par défaut.

    Pour obtenir un exemple sur la façon dont le collecteur d'événements MID WebService convertit les messages d'événements au format JSON, consultez la rubrique .

    Pour envoyer des événements au format JSON générique, vous pouvez utiliser l'URL au format suivant :

    http://{IP_MID_Server}:{port_MID_Web_Server}/api/mid/em/inbound_event?Transform=TransformEvents_MidJsonGeneric

    Dans ce cas, le script Include MID TransformEvents_MidJsonGeneric fourni dans l'instance de base convertit les messages d'événement en champs d'événement. Tous les champs sont ajoutés en tant que champs Informations supplémentaires dans l'événement ServiceNow généré.

    Remarque :
    L'URL au format http://{IP_MID_Server}:{port_MID_Web_Server}/api/mid/em/{nom_script_conversion}est également prise en charge.

    L'URL de l'API REST pour valider la connectivité est la suivante : http://{IP_MID_Server}:{port_MID_Web_Server}/api/mid/em/ping

    Script Include pour convertir les événements collectés

    Utilisez le script Serveur MID Include requis pour convertir (analyser) les messages d'événements collectés et les renseigner dans le champ d'événement mappé. Le nom du script Serveur MID Include est composé d'un préfixe et d'un suffixe. Le préfixe est le texte obligatoire TransformEvents_ et le suffixe est le nom de conversion sur l'URL, par exemple, http://{IP_MID_Server_}:{port_MID_Web_Server}/api/mid/em/xmlSample . Le nom de script composé est donc TransformEvents_xmlSample.

    Vous devez fournir un script Include qui reçoit les messages d'événement dans une variable texte. Le script doit disposer d'une fonction transform() capable de convertir et de préparer le tableau de retour des objets d'événement. Lorsque le module d'extension Gestion des événements est activé, vous recevez le script Include d'exemple l'TransformEvents_xmlSample qui convertit les événements à partir du format XML.

    Remarque :
    les champs d'événements qui ne sont pas identiques aux champs de la table d'événements sont enregistrés dans le champ Informations supplémentaires.

    En-têtes de message d'événement

    Spécifiez la valeur d'en-tête de demande pertinente pour le champ Content-Type en fonction du format du message d'événement.

    Tableau 1. Valeurs d'en-tête de demande pour le champ Content-Type
    Format du message Valeur Content-Type
    JSON application/json
    XML application/xml
    texte texte/brut

    Options d'authentification et de sécurité des données

    Options pour l'authentification et la sécurité des données :
    • Type d’authentification, qui peut être défini sur Clé API, mTLS ou De base.
    • Connexion sécurisée, qui vous permet de choisir si les données entrantes et sortantes sont sécurisées lors de leur transmission. Si vous choisissez l'option de sécurité avancée, vous devez obtenir un certificat auprès d'une autorité de certification connue, puis spécifier l'alias de certificat de magasin de clés et le mot de passe du magasin de clés.
    • Utilisez le magasin de clés unifié MID, qui fournit une protection de chiffrement et vous permet d'installer un certificat personnalisé dans le magasin de clés unifié Serveur MID. Pour plus d’informations, voir Installer des certificats personnalisés dans le magasin de clés unifié MID Server.
    • Les utilisateurs doivent fournir un script qui reçoit les messages d'événement au format JSON, XML ou texte dans une variable texte. Le script doit disposer d'une fonction transform() capable de convertir et de préparer le tableau de retour des objets d'événement. Le script Include TransformEvents_xmlSample qui convertit les événements à partir du format XML est fourni comme exemple lorsque le module d'extension Gestion des événements est activé.
    Pour en savoir plus sur l'authentification et la sécurité des données, consultez la rubrique Configurer l'extension Serveur Web MID.