Configurer l’intégration

Une fois l’intégration HTTP ajoutée, configurez votre intégration. Ces données de point de terminaison ainsi que la configuration des actions de service constituent la base de la création de micro-apps interactives.

Ajouter des points de terminaison de données

Configurez les points de terminaison de données pour lire les données pertinentes dans le cache. Toutes les données que vous souhaitez montrer à l’utilisateur (ou avec lesquelles vous souhaitez déclencher des événements ou des actions) doivent être mises en cache.

Pour ajouter un point de terminaison de données, procédez comme suit :

  1. Sélectionnez Chargement des données.

    Ajouter un nouveau point de terminaison

  2. Renseignez les champs Nom du point de terminaison et URI du point de terminaison.

  3. Configurez le champ Méthode de requête.

  4. (Facultatif) Sélectionnez + AJOUTER PARAMÈTRES et configurez les paramètres CHEMIN, REQUÊTE ou EN-TÊTE si nécessaire.

    Remarque :

    Le type de données sélectionné détermine le format des attributs. Le format détermine les champs dans les micro-apps. Utilisez les balises de type Mustache pour référencer les noms de paramètres. Par exemple, .

  5. Sélectionnez Type de pagination.

    Le type de pagination que vous devez sélectionner dépend de la norme d’API de votre intégration d’application cible. Consultez la documentation relative à l’API de votre intégration d’application cible pour voir quelle méthode de pagination utilise votre intégration d’application. L’intégration HTTP vous permet de sélectionner une option parmi les méthodes de pagination standard suivantes.

    • Aucune : aucune pagination définie.
    • Page : permet de définir la limite des retours par page.

      Exemple : https://example.com?limit=100&page=3

    • Décalage : fournit deux paramètres, Décalage et Limite. Le paramètre Décalage définit le nombre d’enregistrements à ignorer, le paramètre Limite le nombre d’enregistrements à afficher par page.

      Exemple : https://example.com?limit=100&offset=300

    • Lien : permet de définir la méthode de pagination pour le lien de page suivante dans le corps.

      Exemple :

       {
       “data” […]
       “next”: https://example.com?lpage=3
       }
      
    • Lien d’en-tête : semblable à la pagination de lien ; permet de définir la pagination en fonction de l’en-tête de page URL.

      Exemple :

       Lien : <https://api.github.com/search/code?q=addClass+user%3Amozilla&page=15>; rel="next",
       <https://api.github.com/search/code?q=addClass+user%3Amozilla&page=34>; rel="last"
      
    • Curseur : la pagination par curseur utilise un identificateur unique pour un enregistrement spécifique qui agit en tant que pointeur vers l’enregistrement suivant à interroger pour renvoyer la page de résultats.

      Exemple : https://example.com?paginationToken=BFLMPSVZ

    • OData : sélectionnez votre version OData pour effectuer la pagination selon les normes OData.

      Définir le type de pagination du point de terminaison

  6. Sélectionnez Tester le service pour vérifier que votre point de terminaison est correctement configuré.

    Si le test réussit, passez à l’étape suivante. Si vous recevez un message d’erreur, essayez de résoudre le problème en fonction du message d’erreur reçu.

Récupérer la structure de données

Vous pouvez désormais créer vos tables dans la section Récupérer la structure de données.

  1. Entrez le nom de base des tables créées dans la section Récupérer la structure de données et sélectionnez une des options suivantes :
    • Depuis l’API : permet de récupérer les données automatiquement à partir du point de terminaison défini.
    • Depuis l’exemple de fichier JSON : permet de coller l’API si nécessaire, par exemple, lorsque vous avez la réponse mais ne pouvez pas appeler l’API à ce moment précis.

    Définir la synchronisation

  2. Pour définir votre clé primaire, sélectionnez l’icône crayon Modifier les attributs et activez Clé primaire pour que l’attribut soit utilisé comme clé primaire (par exemple, id). Veuillez noter que la colonne de clé primaire ne peut pas contenir de valeurs nulles. Ne modifiez pas le type de données avec des valeurs d’horodatage (TIMESTAMP).

    Remarque :

    Lors de la création d’une intégration et d’une micro-app personnalisées, vous devez toujours attribuer une clé primaire pour activer un chargement incrémentiel correct plutôt qu’un écrasement complet lors de la synchronisation de vos données.

  3. (Facultatif) Sélectionnez Ajouter une table et configurez des propriétés supplémentaires de table selon les besoins de l’application cible souhaitée, puis cliquez sur Enregistrer. Vous pouvez ensuite recharger la structure de la table à partir de votre point de terminaison d’API.

  4. Synchronisation incrémentielle

    Lorsque l’option Synchronisation incrémentielle est activée, vous pouvez configurer la synchronisation, c’est-à-dire télécharger uniquement les enregistrements mis à jour depuis la dernière synchronisation des données à intervalles plus fréquents. Pour ce faire, configurez la fréquence à laquelle vous souhaitez que votre appel d’API s’exécute. Entrez au moins un paramètre d’heure du serveur. Si vous ne définissez pas de planification de synchronisation, la synchronisation est manuelle.

    Les paramètres personnalisés ne sont requis que si l’application cible les requiert. Consultez la documentation d’intégration de votre application cible si nécessaire.

    Pour plus d’informations sur la synchronisation, consultez la section Définir la synchronisation des données ci-dessous.

  5. Entrez le nom de base des tables créées dans la section Récupérer la structure de données et sélectionnez une des options suivantes :
    • Depuis l’API : permet de récupérer les données automatiquement à partir du point de terminaison défini.
    • Depuis l’exemple de fichier JSON : permet de coller l’API si nécessaire, par exemple, lorsque vous avez la réponse mais ne pouvez pas appeler l’API à ce moment précis.

    Définir la synchronisation

  6. Sélectionnez Ajouter.

Votre point de terminaison de données est mappé ; vous pouvez désormais configurer vos actions de service.

Remarque :

Une fois votre point de terminaison configuré et ajouté, la structure de votre tableau est verrouillée. Si vous devez effectuer une restructuration, vous devez créer et configurer un nouveau point de terminaison de chargement de données.

Ajouter des appels d’API supplémentaires

Lors de la configuration des points de terminaison de données pour l’intégration de votre application, vous pouvez ajouter des points de terminaison enfants supplémentaires au point de terminaison parent d’origine pour activer le chaînage des appels. Une fois les points de terminaison de données configurés, vous pouvez ajouter d’autres points de terminaison associés.

Procédez comme suit :

  1. Sélectionnez Modifier dans le menu en regard de l’intégration à laquelle vous souhaitez ajouter un appel enfant.

    Menu d'édition de l'intégration

    La page Intégration s’ouvre.

  2. Sélectionnez Ajouter un appel d’API enfant dans le menu Point de terminaison de données :

    Menu Ajouter un appel d'API enfant

  3. Sélectionnez la table parente et définissez le point de terminaison comme vous l’avez fait dans les étapes de la section Chargement des données ci-dessus.

Lors de la définition de la méthode de requête, vous pouvez définir le chemin d’accès à une valeur statique ou à une valeur de colonne. Votre chaîne d’appels d’API est maintenant associée à l’appel d’API parent. Vos points de terminaison parent/enfant définis sont maintenant affichés sur la page Point de terminaison de données.

Remarque :

Lors de la création de vos intégrations, il est recommandé de charger vos données à partir d’un seul point de terminaison (et non de plusieurs point de terminaison). Dans la mesure du possible, privilégiez les appels groupés plutôt que les appels de points de terminaison individuels.

Configurer des tables

Vous pouvez désormais reconfigurer les clés primaires des tables sans définir une nouvelle configuration. Pour ce faire, supprimez des entrées de table individuelles dans l’écran de la table et resynchronisez la table en sélectionnant la nouvelle clé primaire.

Ajouter des actions de service

Une fois votre intégration HTTP configurée, vous pouvez configurer vos actions de service. Les actions de service vous permettent de configurer les actions d’écriture conditionnelle sur le système d’enregistrement de votre intégration d’application. Vous configurez les actions de service de la même manière que les points de terminaison de données ci-dessus. Étant donné que votre intégration d’application peut comporter n’importe quel nombre de combinaisons personnalisées, nous allons adopter une approche générique pour expliquer comment fonctionnent les actions de service.

Pour ajouter des actions de service, procédez comme suit :

  1. Sélectionnez l’intégration que vous avez créée sous Nom de l’application.
  2. Sélectionnez Actions de service et Ajouter une nouvelle action de service.
  3. Renseignez le champ Nom de l’action (tel que Obtenir des informations sur le ticket Jira) et entrez le chemin d’accès dans le champ URI du point de terminaison : (/rest/api/2/issue/)
  4. Configurez le champ Méthode de requête en fonction des exigences de l’API de votre intégration d’application.

    Remarque :

    Utilisez les balises de type Mustache pour référencer les noms de paramètres. Par exemple, .

  5. Sélectionnez AJOUTER pour enregistrer l’action de service. Vous pouvez maintenant ajouter des actions de service supplémentaires si nécessaire.

Méthode de requête d’API

Vous pouvez désormais configurer votre méthode de requête en fonction des exigences de l’API d’intégration d’application à l’aide des composants suivants :

  • GET : permet de récupérer les ressources du système d’enregistrement de l’intégration d’application sans effectuer de modification.
  • POST : permet de créer une ressource dans le système d’enregistrement de l’intégration d’application.
  • PUT : permet de mettre à jour les ressources existantes dans l’intégration d’application.
  • PATCH : permet d’effectuer une mise à jour partielle d’une ressource.
  • DELETE: permet de supprimer une ressource.

Utilisez les paramètres d’API configurables suivants :

  • En-tête : permet de définir les paramètres inclus dans l’en-tête de requête, généralement liés à l’autorisation.
  • Chemin : permet de définir les paramètres dans le chemin du point de terminaison, avant la chaîne de requête.
  • Requête : permet de définir les paramètres dans la chaîne de requête du point de terminaison.
  • Corps : permet de définir les paramètres inclus dans le corps de la requête.

Vérifier les entités requises

Utilisez Tableau pour vérifier la liste actuelle de vos tableaux stockés dans le cache, ainsi que les filtres qui sont appliqués à ces tableaux.

Vous êtes maintenant prêt à définir et exécuter votre première synchronisation de données, sauf si vous avez besoin de créer des relations personnalisées. Pour de plus amples informations, consultez Définir la synchronisation des données.

Créer une relation personnalisée

Utilisez la page Relations pour créer une connexion personnalisée entre les tableaux de votre intégration. Vous pouvez utiliser cette option si vous disposez de plusieurs URL de base et que plusieurs intégrations sont requises ou si vous souhaitez créer une relation personnalisée dans la même intégration. Il s’agit d’un cas d’utilisation avancé. Nous vous recommandons donc de vous familiariser avec la création de micro-apps sur une seule intégration avant de commencer à mapper plusieurs intégrations.

  1. Sur la page Gérer les micro-apps, sélectionnez le menu en regard de l’intégration pour laquelle vous souhaitez vérifier les entités.
  2. Sélectionnez Modifier, puis Relations.
  3. Sélectionnez Ajouter une nouvelle relation.

    La page Ajouter une relation s’affiche.

  4. Vous pouvez mapper votre tableau principal à votre tableau étranger.
  5. Entrez l’alias que vous souhaitez utiliser.

Vous pouvez maintenant mapper et ajouter des colonnes de référence supplémentaires en fonction des clés primaires que vous avez configurées pour chacune de vos intégrations.

Important :

Si vous supprimez un tableau, toutes les relations sont également supprimées.

Définir la synchronisation des données

Commencez par extraire les données de vos applications intégrées vers la plate-forme de micro-apps afin qu’une comparaison puisse être établie avec le cache. La meilleure pratique consiste à effectuer une synchronisation complète toutes les 24 heures. Les synchronisations incrémentielles peuvent être configurées pour se produire toutes les cinq minutes.

  1. Sur la page Gérer les micro-apps, sélectionnez le menu en regard de l’intégration pour laquelle vous souhaitez définir la synchronisation.
  2. Sélectionnez Synchronisation.

    Définir la synchronisation des données

  3. Définissez les valeurs de synchronisation des données sur Complète et Incrémentielle.

    • L’option Complète supprime le cache local et extrait toutes les données du système source.

      Important :

      L’exécution de la synchronisation complète peut prendre beaucoup de temps. Nous vous recommandons d’exécuter une synchronisation complète la nuit ou en dehors des heures d’activité. Vous pouvez annuler une synchronisation de données en cours à tout moment en sélectionnant l’icône X.

    • L’option Incrémentielle extrait uniquement les enregistrements modifiés (nouveaux et mis à jour). Cette option ne charge pas les données supprimées.

      Important :

      Toutes les API ne prennent pas en charge la synchronisation incrémentielle.

      Lorsque vous définissez une synchronisation sur Quotidienne ou Hebdomadaire, la synchronisation se produit aléatoirement dans le créneau horaire sélectionné. Par exemple, lorsqu’une synchronisation complète quotidienne est définie sur 00-04, celle-ci sera exécutée à un moment choisi de manière aléatoire au cours de cette période.

  4. Sélectionnez Save.

Remarque :

Vous pouvez également sélectionner les icônes fléchées pour exécuter les intégrations à la demande si nécessaire.

Afficher les journaux d’intégration

Utilisez l’option Journal d’intégration pour afficher un historique des modifications classées par niveau de gravité. Utilisez cette option pour résoudre les problèmes liés à votre intégration. Par exemple, si vous constatez que la synchronisation a échoué, vérifiez les journaux d’intégration pour identifier la raison de l’échec. Si les fiches attendues ne s’affichent pas, vérifiez également les journaux d’intégration pour voir si la synchronisation s’est produite.

Afficher les journaux d'intégration

  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 d’intégration.
  3. Vérifiez les entrées et sélectionnez le menu pour filtrer les entrées par le champ Erreurs si nécessaire.

Exporter les configurations d’intégration

Vous pouvez exporter vos configurations d’intégration. Toutes les informations d’identification sont ignorées. Cela inclut les mots de passe et les détails du client. Seule la configuration stockée sur le serveur des micro-apps est exportée. Par exemple, l’exportation conserve votre nom d’utilisateur mais pas votre mot de passe ; de la même manière, l’exportation conserve votre configuration OAuth mais pas la clé secrète client.

  1. Sur la page Gérer les micro-apps, sélectionnez le menu en regard de l’intégration que vous souhaitez exporter.
  2. Sélectionnez Exporter la configuration.

    Le fichier service.mapp est téléchargé.

Autres ressources

Maintenant que vous avez créé et configuré votre intégration personnalisée, créez vos propres micro-apps pour offrir la meilleure expérience utilisateur qui répond à vos besoins et rationalise les workflows quotidiens. Pour de plus amples informations, consultez Personnaliser les micro-apps.