Integration Hub

Integration Hub fournit un emplacement central pour gérer les intégrations avec les systèmes et services externes. Il vous permet de créer des connexions REST APIFermé Interface de programmation d’application. Permet d’automatiser certaines fonctionnalités en connectant votre système CXone Mpower avec d’autres logiciels. standardisées, que vous pouvez utiliser dans plusieurs scripts Studio. Cela évite d'avoir à construire à chaque fois les mêmes requêtes lorsque vous souhaitez communiquer avec l'extérieur via une API. Au lieu de cela, vous pouvez construire la requête une seule fois dans Integration Hub, puis la réutiliser partout où vous en avez besoin. Cela simplifie et accélère le processus de programmation.

Integration Hub rend également vos intégrations plus sécurisées. Il chiffre les identifiants API, de sorte qu'ils ne sont pas exposés dans le script à chaque utilisation. Les scriptsStudio sont stockés en texte brut, vous ne pouvez donc pas stocker en toute sécurité des informations d'identification importantes en tant que variables directement dans le script, comme les jetons utilisés pour les requêtes API. Integration Hub vous permet d'ajouter rapidement une demande d'authentification à un script, puis d'utiliser en toute sécurité les informations d'identification récupérées dans les appels API suivants. Vous pouvez également ajouter des certificats mTLS à une requête API.

Integration Hub fait partie de l'automatisation et de l'IA application dans CXone Mpower. Si vous disposez de l'autorisation Lancer Automation & IA , vous pouvez ouvrir le application depuis CXone Mpower dans une nouvelle fenêtre et cliquer sur Integration Hub.

Integration Hub, illustrant la liste Mes connexions à gauche et la bibliothèque de connexions à droite.

Connexions

Les Connexions définissent les détails de l'intégration avec un service externe, tels que les requêtes API, les flux d'authentification et les variables. Par exemple, vous pourriez créer un modèle de connexion pour Salesforce. Cela définirait les détails de base nécessaires pour se connecter avec Salesforce, comme le type d'authentification et les méthodes prises en charge. À partir de ce modèle, vous créeriez une connexion, qui vous permettrait de renseigner des détails spécifiques du modèle, ainsi que des détails plus spécifiques comme les requêtes API spécifiques que vous souhaitez effectuer à Salesforce.

Modèles de connexion

Chaque connexion que vous ajoutez à Integration Hub est créée selon un modèle de connexion. Les modèles définissent les informations de base qui s’appliquent à toutes les connexions qui seront effectuées avec le modèle. Cela inclut :

  • Le nom du service Web auquel vous vous connectez.
  • La méthode d’intégration. Actuellement, l’API REST est la seule méthode prise en charge.
  • Le type d’authentification, s’il est défini. Actuellement, vous pouvez choisir OAuth 2.0 ou ne sélectionner aucune authentification.
  • Les en-têtes personnalisés pour l’authentification, s’ils existent, sont nécessaires.
  • Les verbes disponibles pour les demandes effectuées sur la base du modèle. Les verbes sont les actions qui peuvent être effectuées avec le service Web connecté, telles que la récupération de données (GET) ou la création d'enregistrements (POST).

Une connexion ne doit pas nécessairement inclure tous les types d’informations de connexion. Elle peut contenir une combinaison des types d’informations pris en charge.

Tous les modèles de connexion sont disponibles dans la bibliothèque de connexion dans Integration Hub. Les Modèles que vous pouvez utiliser dans un script Studio sont répertoriés sous Mes Connexions dans Integration Hub. Vous pouvez créer un maximum de 50 Connexions (dans la liste Mes Connexions). Le nombre de modèles dans la bibliothèque de connexions est illimité.

Tous les modèles ne peuvent pas être modifiés. Cependant, vous pouvez supprimer vos modèles personnalisés. Si vous devez modifier ultérieurement un élément d'un modèle personnalisé, vous pouvez supprimer le modèle et en créer un nouveau. Il est possible de modifier les connexions proprement dites. La suppression d'un modèle personnalisé n'a pas d’incidence sur les connexions créées avec ce modèle.

Modèles de système

Integration Hub dispose de deux types de modèles : les modèles systèmes appartenant à NiCE et les modèles que vous créez vous-même. Les modèles système sont livrés avec Integration Hub et il est impossible de les modifier. Actuellement, Integration Hub inclut un modèle de système :

  • CXone Mpower Portail de développement : s'intègre aux points de terminaison d'API documentés sur le CXone Mpower portail des développeurs . Ceci vise à réduire votre dépendance aux Studio actions du Framework. Il utilise l’authentification OAuth 2.0. Pour déterminer l'authentification, il utilise l'URL de découverte. Il ne prend pas en charge les certificats des clients.

Demandes

Les demandes sont des appels d’API. Pour chaque Connexion figurant dans la liste Mes Connexions, vous pouvez ajouter des requêtes que vous souhaitez utiliser avec le service externe spécifique. Ces requêtes spécifient les informations suivantes, qui sont utilisées pour se connecter à un service web :

  • URL : emplacement de la ressource à laquelle vous vous connectez.
  • Méthode (verbe) : action que la demande doit exécuter, par exemple la récupération de données ou la création d’un nouvel enregistrement. Integration Hub prend en charge les verbes suivants : GET, PUT, POST, DELETE, TRACE, PATCH, HEAD, OPTIONS. Les verbes pouvant être utilisés dans une connexion sont définis dans le modèle utilisé pour créer la connexion.
  • En-têtes : partie de la demande qui contient des informations supplémentaires sur la demande. Il peut s’agir de la langue, des informations d’identification, etc.
  • Paramètres de requête : un moyen de transmettre des informations avec une requête API dans l'URL du point de terminaison. Ces paramètres sont configurés en tant que paires clé-valeur. Vous pouvez les utiliser pour filtrer, trier, personnaliser ou contrôler les données renvoyées dans la réponse.
  • Corps : contenu de la demande. Le format dépend des exigences de l’API à laquelle vous vous connectez. Le type de média du corps doit correspondre aux attentes de la ressource à laquelle vous vous connectez. Il est également appelé type MIME ou type de contenu. Les options prises en charge et les en-têtes de contenu associés sont les suivants :
    • ApplicationJson : application/json
    • ApplicationJsonPatch : application/json-patch+json
    • FormURLEncoded : application/x-www-form-urlencoded
    • TextHtml : text/html
    • TextPlain : text/plain
    • TextXml: text/xml
    • Sigv4: application/ x-amz-json-1.1

Chaque connexion Integration Hub peut comporter 50 demandes maximum. Aucune restriction n’est imposée quant au nombre de demandes pouvant être actives simultanément.

CXone Mpower impose une limite de 32 Ko quant à la taille des réponses. Utilisez les paramètres de la requête pour filtrer les données renvoyées. Cela peut vous aider à rester en deçà de cette limite.

Demandes manuelles et demandes Studio

Integration Hub prend en charge deux options pour les demandes dans les connexions :

  • Manuelle : une demande manuelle est intégrée à Integration Hub à l’aide des options de la page Ajouter une demande. Vous pouvez utiliser les secrets qu’elles contiennent. Les demandes manuelles sont généralement utilisées lorsque les données ne changent pas. Vous pouvez les exécuter directement à partir d’Integration Hub sans utiliser de script Studio. Il est par ailleurs possible de les exécuter dans des scripts Studio.

  • Studio : dans certains cas, il est impossible d’intégrer les demandes API en tant que demandes manuelles dans Integration Hub. Par exemple, les demandes qui nécessitent des paramètres de chemin ou une substitution de variables, ou qui se connectent à des services Web SOAP, doivent être intégrées dans un script Studio. Vous pouvez toutefois souhaiter conserver une trace de ces demandes dans vos connexions Integration Hub. Utilisez pour cela l’option de demande Studio. Une demande Studio est disponible sur l’onglet Demandes d’une connexion avec toutes les demandes manuelles de la connexion.

Variables

Integration Hub vous permet de stocker des paires de valeurs sous forme de variables. Les variables sont décryptées par défaut. Vous pouvez néanmoins crypter une variable en la rendant secrète. Rendre une variable secrète renforce la sécurité des informations sensibles, telles que les mots de passe ou les clés.

Les variables peuvent être utilisées dans la connexion où vous les créez. Si vous exécutez une demande de connexion ou d’authentification dans un script Studio, vous pouvez utiliser les variables de cette connexion dans le script.

Les secrets sont chiffrés au repos dans une base de données chiffrée. Integration Hub utilise la norme AES (Advanced Encryption Standard) pour crypter les données. Les données ne sont décryptées qu’au moment de l’exécution.

Integration HubStudio Actions

Si vous souhaitez utiliser l’authentification ou effectuer une demande dans un script Studio, utilisez les actions Studio suivantes :

  • CONNECTAUTH : cette action vous permet d’inclure les détails d’authentification ou les secrets dans votre script. Les détails d’authentification et les variables doivent être définis dans une connexion Integration Hub.
  • CONNECTREQUEST : cette action vous permet d’utiliser une demande définie dans une connexion Integration Hub. Cette action est requise pour utiliser les demandes manuelles et les Studiodemandes .

Points à retenir sur les actions Integration Hub Studio

  • Elles nécessitent Integration Hub. Si Integration Hub n’est pas activé dans votre système CXone Mpower, les actions ne fonctionnent pas.
  • Vous pouvez inclure plusieurs instances de chaque action dans un script.
  • Vous pouvez utiliser la substitution de variables pour exécuter différentes demandes ou utiliser l’authentification de plusieurs connexions dans un même script.
  • À l’instar d’autres méthodes pour lancer des appels API dans CXone Mpower, des scripts supplémentaires sont nécessaires pour recevoir la réponse du service Web connecté et la traiter de manière appropriée.
  • L’action CONNECTAUTH ne permet aucune personnalisation. Elle exécute la demande d’authentification telle qu’elle est définie dans la connexion dans Integration Hub.

Coupe-circuit

Integration Hub dispose d'un disjoncteur intégré. Il s'agit d'une mesure de sécurité préventive en cas d'échec des appels API. Si le disjoncteur détecte qu’un appel échoue de manière répétée, il s’active et limite le débit de l’appel API. Le motif le plus courant d’échec d’appel d’API est une erreur serveur temporaire (erreurs 500). La limitation (ou la mise en pause) de l’appel donne au serveur le temps de se remettre en marche et de fonctionner correctement.

Voici les principales caractéristiques du disjoncteur :

  • Il s’active si plus de 50 % des appels à une API échouent sur une période de moins de 30 secondes.

  • Pour déclencher le coupe-circuit, Integration Hub doit avoir essayé au moins 100 appels à une API dans une fenêtre de 30 secondes.

  • Le coupe-circuit s’active pendant 30 secondes.

  • Les raisons de l’échec sont accessibles dans les journaux Studio trace, capturés dans la variable _err.

Historique d’audit

Chaque connexion dans Integration Hub possède un journal des modifications. À chaque création ou mise à jour d’une connexion, les informations suivantes sont enregistrées :

  • Date: La date à laquelle la modification a été effectuée.

  • Modifié par : Qui a effectué la modification.

  • Nom du Profil: Le nom de la connexion.

  • Action : Ce qui s’est produit, par exemple si une connexion a été créée ou modifiée.

Les utilisateurs pourront accéder à ce journal à partir d'un nouveau bouton Audit dans les paramètres de connexion.