Integration Hub

Integration Hub fournit un moyen normalisé de gérer l’intégration de CXone avec l’authentification tierce et les services Web. Les services Web peuvent être des applications, des plateformes ou des systèmes.

Integration Hub est l’un des moyens vous permettant d’utiliser les appels d’API REST dans CXone. L’avantage d’utiliser Integration Hub est que vous pouvez ajouter la connexion et l’utiliser à plusieurs emplacements. Dans le cadre d’autres méthodes, vous devez établir une connexion chaque fois que vous souhaitez l’utiliser.

En outre, vous pouvez stocker des données nécessitant une sécurité accrue dans Integration Hub. Les données ajoutées en tant que secrets sont chiffrées et ne sont pas directement accessibles.

Connexions et modèles de connexion

Les connexions définissent les détails des demandes d’API, les informations d’authentification et les secrets que vous souhaitez utiliser dans CXone.  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.

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 qu’il est possible d’effectuer avec le service Web connecté, par exemple l’extraction de données ou la création d’enregistrements.

Il est impossible de modifier les modèles de connexion après leur création. Si vous devez modifier un élément dans un modèle ultérieurement, vous devez supprimer le modèle et en créer un nouveau. Vous pouvez néanmoins supprimer les connexions proprement dites. La suppression d’un modèle n’a pas d’incidence sur les connexions créées avec ce modèle.

Les modèles sont disponibles dans la bibliothèque de connexions d’Integration Hub. Les connexions sont répertoriées sous Mes connexions dans Integration Hub. Vous ne pouvez pas créer plus de 50 connexions. Le nombre de modèles est quant à lui illimité.

Demandes

Les demandes sont des appels d’API. Elles spécifient les informations suivantes, qui vous permettent de vous 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 : moyen de transmettre des informations avec une demande d’API. 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. Le corps est également appelé type MIME ou type de contenu. La liste suivante présente les options prises en charge et l’en-tête de contenu utilisé pour chacune d’elles :
  • 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 comporter 50 demandes maximum. Aucune restriction n’est imposée quant au nombre de demandes pouvant être actives simultanément.

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.

Secrets

Integration Hub vous permet de stocker des informations sensibles sous forme de secrets. Vous pouvez les utiliser pour toute information nécessitant une sécurité supplémentaire, comme les mots de passe ou les clés.

Vous pouvez utiliser les secrets dans la connexion où vous les avez créés. Si vous exécutez une demande de connexion ou d’authentification dans un script Studio, vous pouvez utiliser les secrets de cette connexion dans le script.

Les secrets sont cryptés au repos. Integration Hub utilise la norme AES (Advanced Encryption Standard) pour crypter les données. Ils sont stockés dans une base de données cryptée. 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 secrets 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 .

Faits essentiels concernant ces actions  :

• Elles nécessitent Integration Hub. Si Integration Hub n’est pas activé dans votre système CXone, 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, 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.