Integration Hub fournit un moyen normalisé de gérer l’intégration de CXone avec des services d’authentification et des services Web tiers. Les services Web peuvent être des applications, des plateformes ou des systèmes.
Integration Hub est l’une des façons de travailler avec les appels API REST dans CXone. L’avantage d’utiliser Integration Hub est que vous pouvez ajouter la connexion et l’utiliser à plusieurs endroits. D’autres méthodes nécessitent l’établissement d’une connexion chaque fois que vous souhaitez l’utiliser.
En outre, Integration Hub offre une sécurité accrue, y compris mTLS et les secrets. Les variables ajoutées en tant que secrets sont chiffrées et ne sont pas accessibles directement.
Afficher l’image
Connexions et modèles de connexion
Les connexions définissent les détails des demandes API, les détails d’authentification et les variables que vous souhaitez utiliser dans CXone. 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.
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é, telles que l’extraction de données ou la création d’enregistrements.
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. Ils comprennent :
-
Portail des développeurs NICE CXone : S’intègre aux terminaux disponibles sur le portail de développeurs d’API
pour réduire votre dépendance à l’égard des actions Cadre Studio. 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.
Les modèles système et les modèles que vous créez 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.
Les modèles sont disponibles dans la bibliothèque de connexions dans Integration Hub. Les connexions sont répertoriées sous Mes connexions dans Integration Hub. Vous pouvez créer un maximum de 50 connexions. Le nombre de modèles est illimité.
Demandes
Les demandes sont des appels API. Elles spécifient les informations suivantes, qui sont utilisées 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 : Une façon de transmettre des informations avec une requête API. 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 : text/xml
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 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. Integration Hub utilise la norme de chiffrement avancé (AES) pour chiffrer les données. Ils sont stockés dans une base de données chiffrée. 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, 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, des scripts supplémentaires sont nécessaires pour recevoir la réponse du service Web connecté et la traiter de manière appropriée.
-