Micro-apps

Configurer les écouteurs webhook

Configurez les écouteurs webhook (également appelés API push HTTP) pour permettre à vos micro-apps de fournir des données en temps quasi réel à vos utilisateurs. La configuration d’un webhook permet à vos applications de fournir des données à d’autres applications à un rythme beaucoup plus rapide que la synchronisation du côté de la plate-forme de micro-apps. La taille maximale d’un corps de requête webhook qui peut être géré par le serveur MA est de 64 ko.

Pour ajouter des écouteurs webhook, vous devez connaître votre système d’enregistrement d’application cible, ainsi que disposer des outils et des privilèges d’administration nécessaires pour configurer vos webhooks dans ces emplacements.

Configurez vos webhooks après avoir configuré votre intégration via l’option Chargement des données et procédez comme suit :

  1. Cliquez sur Écouteurs webhook dans la barre de gauche de l’écran Intégration HTTP :

    Écouteurs webhook

  2. Donnez un nom au webhook.
  3. Sélectionnez Copier pour copier l’URL du webhook à utiliser dans l’interface d’administration du système d’enregistrement cible.

Méthode d’autorisation

Vous pouvez sélectionner Jeton ou Aucun lors de la configuration de votre méthode d’autorisation. Pour configurer la méthode Jeton, procédez comme suit :

  1. Sélectionnez Jeton dans le menu de la méthode Autorisation.
  2. Sélectionnez Générer un jeton, puis sélectionnez Copier pour ajouter le jeton à votre Presse-papiers pour l’utiliser dans l’interface d’administration du système d’enregistrement cible.
  3. Sélectionnez Lire le jeton de et choisissez :

    • En-tête personnalisé
    • Paramètre de requête
    • En-tête d’autorisation
  4. Renseignez le champ Nom ou Préfixe en fonction de la méthode de lecture sélectionnée.

Le jeton est maintenant configuré.

Méthodes de requête

Lorsque vous configurez vos écouteurs webhook, utilisez les définitions suivantes pour générer vos appels :

  • La requête PUT est utilisée pour mettre à jour la ressource existante.
  • La requête POST crée de nouvelles ressources subordonnées. Par conséquent, les méthodes POST sont utilisées pour créer une nouvelle ressource dans la collection de ressources. PUT et POST suppriment les données des tables enfants à l’aide des informations de clé primaire de la table racine. Cette méthode remplace ensuite un enregistrement existant ou en ajoute un nouveau.
  • La requête DELETE est utilisée pour supprimer des ressources. DELETE a deux points de terminaison :
    • {serviceUuid}/{webhookListenerUuid}/{recordId}recordId représente la valeur de la clé primaire de l’enregistrement dans la table racine à supprimer. Les enregistrements de la table enfant sont supprimés en conséquence.
    • {serviceUuid}/{webhookListenerUuid}/?id1=1&id2=1id1 et id2 représentent les valeurs de la clé primaire composite de l’enregistrement dans la table racine à supprimer. Les enregistrements de la table enfant sont supprimés en conséquence.
  • Les requêtes PATCH sont utilisées pour effectuer des mises à jour partielles sur une ressource.

Définir la structure des données

Vous pouvez définir la structure de vos données selon une méthode similaire décrite lorsque vous récupérez la structure de données lors de la configuration de l’option Chargement des données. Pour plus d’informations, consultez Configurer l’intégration.

Pour définir la structure de vos données webhook, procédez comme suit :

  1. Définissez la période de rétention des données souhaitée. Toutes les entrées antérieures à cette date sont supprimées. Chaque entrée enregistrée contient une date et une heure de modification, lastModified. Cette date et cette heure sont utilisées pour décider quelles entrées doivent être supprimées.
  2. Sélectionnez Générer des tables.

    L’écran Générer des tables s’ouvre.

    Collez votre demande d’exemple JSON à partir de votre système d’enregistrement d’application cible ici.

  3. Définissez le nom de base des tables créées.
  4. (Facultatif) Définissez l’option Chemin d’accès racine si nécessaire.
  5. Sélectionnez Générer.

Une fois ce processus terminé avec les mesures de configuration effectuées dans l’administration de votre système d’enregistrement d’application cible, sélectionnez Ajouter.

Votre webhook est maintenant configuré.

Afficher les journaux webhook

Utilisez les journaux webhook pour afficher un historique des requêtes et des erreurs générées sur tous les points de terminaison webhook. Vous pouvez filtrer les données en fonction du nom et de l’état du webhook (état de réussite ou d’échec) ou tout afficher. Pour des raisons de performance, seules les 10 dernières entrées de journaux webhook sont conservées pour examen dans l’écran des journaux webhook.

  1. Sur la page Gérer les micro-apps, sélectionnez le menu en regard de l’intégration pour laquelle vous souhaitez afficher les journaux d’intégration.
  2. Sélectionnez Journaux webhook.
  3. Passez en revue les entrées et sélectionnez les options dans le menu pour filtrer les données le cas échéant.
Configurer les écouteurs webhook