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’applications. Permet d’automatiser certaines fonctionnalités en connectant votre système CXone Mpower à 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 aussi 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 scripts Studio 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 aussi 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 avez la permission Lancer Automation & IA , vous pouvez ouvrir le application depuis CXone Mpower dans une nouvelle fenêtre et cliquer sur Integration Hub.

Connexions

Les connexions définissent les détails de l'intégration avec un service externe, comme 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 sur la base d’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, le cas échéant. Actuellement, vous pouvez choisir OAuth 2.0 ou aucune authentification.
  • Les en-têtes personnalisés pour l’authentification, s’ils 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é, comme 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 n’importe quelle 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 listé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, vos modèles personnalisés peuvent être supprimé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. Les connexions elles-mêmes peuvent être modifiées. La suppression d’un modèle personnalisé n’affecte pas les connexions créées avec ce modèle.

Modèles de système

Integration Hub a deux types de modèles : les modèles système appartenant à NiCE et les modèles que vous créez vous-même. Les modèles système sont fournis avec Integration Hub et ne peuvent pas être supprimés. 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 a pour but de 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 clients.

Demandes

Les demandes sont des appels 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 précisent les renseignements suivants, qui sont utilisés pour se connecter à un service Web :

  • URL : L’emplacement de la ressource à laquelle vous vous connectez.
  • Méthode (Verbe) : L’action que vous voulez que la demande effectue, comme 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 : Une partie de la demande qui contient des informations supplémentaires sur la demande. Il peut s’agir de la langue, d’identifiants, etc.
  • Paramètres de requête : un moyen de transmettre des informations avec une requête API dans l'URL du point de terminaison. Ils sont configurés comme des paires clé-valeur. Ils peuvent être utilisés pour filtrer, trier, personnaliser ou contrôler les données renvoyées dans la réponse.
  • Corps : Le contenu de la demande. Le format dépend des exigences de l’API à laquelle vous vous connectez. Le type de support du corps doit correspondre à ce que la ressource à laquelle vous vous connectez attend. Il est également connu sous le nom de type MIME ou de type de contenu. Il s’agit des options prises en charge et des en-têtes de contenu associés :
    • ApplicationJson : application/json
    • ApplicationJsonPatch : application/json-patch+json
    • FormURLEncoded : application/x-www-form-urlencoded
    • TextHtml : text/html
    • TextPlain : text/plain
    • TextXml : texte/xml
    • Sigv4: application/ x-amz-json-1.1

Chaque connexion Integration Hub peut contenir jusqu’à 50 demandes. Il n’y a aucune restriction quant au nombre de demandes qui peuvent être actives simultanément.

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

Demandes manuelles et Studio

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

  • Manuelle : Une demande manuelle est construite dans Integration Hub en utilisant les options de la page Ajouter une demande. Vous pouvez y utiliser des secrets. Les demandes manuelles sont généralement utilisées lorsque les données ne changent pas. Elles peuvent être exécutées directement à partir de Integration Hub sans nécessiter de script Studio. Elles peuvent également être exécutées dans des scripts Studio.
  • Studio : Dans certains cas, les demandes d’API ne peuvent pas être construites 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 construites dans un script Studio. Toutefois, vous voudrez peut-être garder une trace de ces demandes dans vos connexions Integration Hub. L’option de demande Studio vous permet de le faire. Une demande Studio apparaît dans 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 en tant que variables. Les variables ne sont pas chiffrées par défaut. Cependant, vous pouvez chiffrer une variable en la transformant en secret. Le fait de marquer une variable comme étant 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 connexion ou une demande 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 de chiffrement avancé (AES) pour chiffrer les données. Les données ne sont déchiffrées qu’au moment de l’exécution.

Integration HubStudio Actions

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

Faits saillants concernant les actions Integration Hub Studio

  • Elles ont besoin de Integration Hub. Si Integration Hub n’est pas activé dans votre système CXone Mpower, les actions ne fonctionnent pas.
  • Vous pouvez inclure plus d’une instance 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.
  • Comme pour les autres méthodes d’appel 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.
  • CONNECTAUTH ne permet aucune personnalisation. Il exécute la demande d’authentification telle qu’elle est définie dans la connexion dans Integration Hub.

Disjoncteur

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. La raison la plus fréquente de l’échec des appels est une erreur temporaire du serveur (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 :

  • Le disjoncteur s’active si plus de 50 % des appels à une API échouent dans les 30 secondes.

  • Pour déclencher le disjoncteur, Integration Hub doit avoir tenté plus de 100 appels à une seule API dans une fenêtre de 30 secondes.

  • Le disjoncteur 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 fois qu’une connexion est créée ou mise à jour, 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 passé, 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.