Configurer les Connexions

Les connexions Integration Hub vous permettent de configurer des intégrations à des services Web tiers à utiliser dans NiCE CXone.

Créer un Modèle de connexion

Un modèle de connexion définit les informations de base d’une intégration. Les Modèles sont utilisés pour créer des connexions, où vous pouvez configurer des demandes spécifiques et d’autres informations.

Les modèles de connexion ne peuvent pas être modifiés après leur création. Si vous devez modifier des détails, y compris les en-têtes, vous devez créer un nouveau modèle.

Screenshot of the Add Template page in Integration Hub.
  1. Dans NiCE CXone, cliquez sur le sélecteur d'applications et sélectionnez Automatisation et AI > Integration Hub.
  2. Cliquez sur Ajouter un Modèle.
  3. Dans l’onglet Détails, saisissez un nom pour le modèle.
  4. Saisissez le nom de l’Application à laquelle vous vous connectez. Il peut s’agir d’une application, d’une plateforme ou d’un service Web.
  5. Sélectionnez REST comme Méthode d’intégration. Actuellement, REST est la seule méthode prise en charge.

  6. Sélectionnez une option pour Type d’authentification. Après avoir effectué une sélection, l’onglet Configuration s’affiche.

    Option Détails
    OAuth 2.0 Un cadre de norme ouverte qui permet aux applications d’accéder à des ressources au nom d’un utilisateur sans partager les informations d’identification.
    Pas d’authentification Sélectionnez cette option si vous ne souhaitez pas que le modèle inclue l’authentification.
  7. Saisissez une Description du modèle. Les autres utilisateurs peuvent le voir lorsqu’ils sélectionnent ce modèle dans la bibliothèque de connexions.
  8. Joignez une icône en glissant et déposant une image ou en cliquant sur Parcourir les fichiers. Cette icône est affichée pour ce modèle dans la bibliothèque de connexions pour toutes les connexions créées à partir de ce modèle.
  9. Dans l’onglet Configuration, sélectionnez les méthodes (verbes) que vous souhaitez utiliser avec ce modèle. Tous les services Web ne prennent pas en charge tous les verbes REST.
  10. If you selected an authentication type, define any custom authentication headers for this template:
    1. Cliquez sur Ajouter un en-tête personnalisé.
    2. Saisissez le nom de l’en-tête dans le champ qui apparaît.
    3. Cliquez sur Ajouter un en-tête personnalisé pour ajouter d’autres en-têtes personnalisées.
    4. Sélectionnez Obligatoire ? pour les en-têtes qui doivent être utilisés dans les connexions créées à partir de ce modèle.
    5. Cliquez sur X pour supprimer un en-tête.
  11. Vérifiez à nouveau tous les paramètres. Vous ne pouvez pas modifier un modèle après l’avoir enregistré.
  12. Do one of the following: 
    • Cliquez sur Enregistrer pour ajouter le modèle à la bibliothèque de connexions.
    • Cliquez sur Enregistrer + Mes Connexions pour ajouter le modèle à la bibliothèque de connexions et créer une connexion à partir de celui-ci. Une fois la connexion créée, vous pouvez la configurer en ajoutant les détails d’authentification, des variables ou des demandes. Votre demande peut inclure tout ou partie de ces configurations.

Ajouter une connexion à la liste Mes Connexions

Cette section s'applique si vous avez cliqué sur Enregistrer lors de la création du modèle de connexion, et non sur Enregistrer + Mes Connexions. Une connexion ne peut être utilisée dans un script Studio que si elle se trouve dans la liste Mes Connexions.

  1. Dans NiCE CXone, cliquez sur le sélecteur d'applications et sélectionnez Automatisation et AI > Integration Hub.

  2. Créez une nouvelle connexion de l’une des manières suivantes :

    • Sélectionnez une connexion existante dans la bibliothèque de connexions, puis cliquez sur + Mes connexions.

    • Copiez un modèle en sélectionnant un modèle existant dans la liste Mes Connexions, puis cliquez sur Icône de deux feuilles de papier empilées Copier.

  3. Dans le champ Nom de ma connexion de la fenêtre contextuelle, saisissez un nom unique pour la nouvelle connexion.

  4. Cliquez sur Enregistrer.

Configurer les Détails de l’authentification

Vous pouvez configurer les détails de l’authentification dans l’onglet Authentification de votre connexion. Cet onglet n’est visible que si l’authentification est activée dans le modèle utilisé pour cette connexion.

  1. Dans NiCE CXone, cliquez sur le sélecteur d'applications et sélectionnez Automatisation et AI > Integration Hub.

  2. Cliquez sur la connexion avec laquelle vous souhaitez travailler dans la section Mes Connexions sur le côté gauche de la page.

  3. Cliquez sur l’onglet Authentification.

  4. Saisissez l'URL utilisée pour la demande d'authentification. L'URL ne peut pas être dynamique, mais vous pouvez y faire référence à des secrets.

  5. Sélectionnez la méthode REST (verbe) utilisée dans la demande d’authentification. Les verbes disponibles sont définis par le modèle utilisé pour cette connexion.

  6. Sous En-têtes, saisissez la valeur appropriée dans chaque champ. Les Champs marqués d’un astérisque (*) sont obligatoires. Ces champs sont définis dans le modèle utilisé pour cette connexion.

  7. Pour ajouter un en-tête personnalisé à cette connexion :

    1. Cliquez sur Ajouter un en-tête personnalisé.

    2. Saisissez un nom d’en-tête et une valeur d’en-tête.

  8. To add a query parameter to the authentication request:
    1. Cliquez sur Ajouter un paramètre de requête.
    2. Pour chaque paramètre de requête que vous ajoutez, saisissez un Nom du paramètre de requête et une Valeur du paramètre de requête.

  9. Sélectionnez un Type de support et saisissez le contenu du Corps. Le type de support affecte le format du contenu du corps. Il doit correspondre au type requis par le serveur d’autorisation que vous utilisez.

    Option Détails
    AWS Sigv4 Utilisé pour l’authentification avec AWS. Cela met à jour l’en-tête Content-Type de type x-amz-json-1.1, qui est une structure JSON spécifique que AWS attend.

    ApplicationJson

    Le contenu du corps doit être au format JSON.
    ApplicationJsonPatch Le contenu du corps doit être au format JSON Patch.
    FormURLEncoded

    Le contenu du corps doit être constitué de paires clé-valeur. Ce type de support envoie des demandes en utilisant les notations URL courantes.

    Cliquez sur +Ajouter un paramètre de formulaire, puis saisissez le nom du paramètre de formulaire et la valeur du paramètre de formulaire.
    TextHtml Le corps du texte doit être au format HTML.
    TextPlain Le contenu du corps doit être en texte brut.
    TextXml Le contenu du corps doit être au format XML.

  10. Cliquez sur Enregistrer.

Configurer un certificat auto-signé mTLS

Vous pouvez utiliser l’onglet Configuration d’une connexion pour configurer le délai d’attente et un certificat auto-signé mTLS.

  1. Dans NiCE CXone, cliquez sur le sélecteur d'applications et sélectionnez Automatisation et AI > Integration Hub.

  2. Cliquez sur la connexion avec laquelle vous souhaitez travailler dans la section Mes Connexions sur le côté gauche de la page.

  3. Cliquez sur l’onglet Configuration.

  4. Réglez le paramètre Dépassement de délai (MS) selon vos besoins. Le dépassement de délai s’applique à toutes les demandes configurées dans la connexion, y compris l’authentification. Si vous utilisez un certificat auto-signé mTLS, remplissez les champs suivants :

    • Certificat client
    • Clé privée du client
    • Phrase secrète de la clé

    Ces champs apparaissent uniquement si vous utilisez OAuth 2.0 comme type d’authentification. Vous devez saisir le Client Certificate et la Client Private Key ensemble. Si votre Client Private Key est chiffrée, vous devez saisir une Key Passphrase. Les certificats mTLS ne fonctionnent que si votre url d’authentification est en HTTPS. La validation de ces champs se produit après l’enregistrement de la connexion. Vous pouvez faire référence à ces champs dans l’onglet Secrets.

  5. Cliquez sur Enregistrer.

Ajouter des variables à une connexion

Integration Hub variables vous permettent de partager certaines informations dans une connexion. Vous pouvez déterminer si ces informations sont chiffrées ou non. Une variable chiffrée, ou un secret, offre un niveau de sécurité supplémentaire lors de l’utilisation d’informations sensibles, telles que les mots de passe dans les scripts Studio.

Lorsque vous créez une variable, vous pouvez à tout moment la convertir en secret. Une fois qu’une variable devient un secret et que le connecteur a été enregistré, vous ne pouvez pas retransformer le secret en variable.

Les secrets ne sont pas réversibles. Lorsque vous cliquez en dehors du champ Valeur du secret, le contenu est chiffré et remplacé par des astérisques de masquage (*). Il n’existe aucun moyen de récupérer la valeur que vous avez saisie dans le champ après qu’il a été masqué.

  1. Dans NiCE CXone, cliquez sur le sélecteur d'applications et sélectionnez Automatisation et AI > Integration Hub.

  2. Cliquez sur la connexion avec laquelle vous souhaitez travailler dans la section Mes Connexions sur le côté gauche de la page.

  3. Dans l’onglet Variables, cliquez sur + Ajouter une variable.

  4. Saisissez un Variable Name qui identifie le contenu de la variable. Les noms peuvent contenir des espaces ou des caractères spéciaux.

  5. Saisissez la Variable Value. Il s’agit de la valeur de la variable et des informations qui seront chiffrées si vous faites de la variable un secret. Vérifiez que les informations sont correctes avant de transformer la variable en secret.

  6. Pour chiffrer la variable, activez l’option Secret. N’oubliez pas que si vous activez ce commutateur, vous ne pouvez pas le revenir.

  7. Pour supprimer une variable de la connexion, cliquez sur le X à droite de celle-ci.

  8. Cliquez sur Enregistrer.

Utiliser des variables dans une connexion

Vous pouvez utiliser des variables dans des demandes manuelles ou de scripts Studio. Vous pouvez les utiliser dans les en-têtes, les paramètres de requête et le corps du texte.

Utiliser une variable dans les Détails d’authentification ou une Demande manuelle

  1. Dans NiCE CXone, cliquez sur le sélecteur d'applications et sélectionnez Automatisation et AI > Integration Hub.

  2. Cliquez sur la connexion avec laquelle vous souhaitez travailler dans la section Mes Connexions sur le côté gauche de la page.

  3. Cliquez sur l’onglet dans lequel vous souhaitez utiliser une variable. Les variables peuvent être utilisées dans les onglets Authentification et Demandes.

  4. Saisissez la variable à l’endroit où vous souhaitez que la valeur de la variable se trouve, en suivant ces directives :

    • Mettez le nom entre doubles crochets. Par exemple, [[ NomVariable ]].
    • Utilisez le nom tel qu’il a été saisi dans le champ Nom de la variable de l’onglet Variables.
    • Les variables ne peuvent être utilisées qu’avec la connexion où elles ont été créées.

Utiliser une Variable dans une Demande Studio

Pour utiliser des variables dans un script Studio, le script doit comporter une action CONNECTAuth ou CONNECTREQUEST. L’action doit relier le script à la connexion contenant la variable.

  1. Dans Studio, ouvrez le script dans lequel vous voulez utiliser la variable.

  2. Double-clic sur l'action Snippet à laquelle vous souhaitez ajouter la variable.

  3. Dans la fenêtre de l'éditeur Snippet, ajoutez la variable à l'endroit où vous souhaitez que la valeur de la variable soit utilisée, en suivant ces directives :

    • Mettez le nom entre doubles crochets. Par exemple, [[ NomVariable ]].
    • Utilisez le nom tel qu’il a été saisi dans le champ Nom de la variable de l’onglet Variables.
    • Placez les crochets et le nom de variable entre guillemets doubles ( " ). Par exemple, "[[ variableName ]]". Si la variable fait partie d'une chaîne, comme une URL, la chaîne entière doit être placée entre guillemets doubles, et non seulement la variable. Par exemple, "[[ variableName ]]/location/anotherlocation/".
    • Les variables ne peuvent être utilisées qu'avec la connexion où elles ont été créées. La connexion doit être spécifiée dans le script à l'aide d'une action CONNECTAuth ou CONNECTREQUEST.

    Exemples:

    • ASSIGN requestPayload.body = "[[client_id]]"

    • ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V42.0/AGENTS"

Créer une Demande manuelle

Les demandes vous permettent d’obtenir les informations dont vous avez besoin auprès du service Web auquel votre intégration se connecte. Vous pouvez utiliser des demandes manuelles dans des scripts Studio ou les exécuter à partir de Integration Hub.

Si votre demande nécessite des paramètres de chemin ou une substitution de variable dans l'URL, les en-têtes ou les paramètres, vous devez créer une demande Studio. Les demandes manuelles ne prennent pas en charge ces Options.

  1. Dans NiCE CXone, cliquez sur le sélecteur d'applications et sélectionnez Automatisation et AI > Integration Hub.

  2. Cliquez sur la connexion avec laquelle vous souhaitez travailler dans la section Mes Connexions sur le côté gauche de la page.

  3. Dans l’onglet Demandes, cliquez sur Ajouter une Demande.

  4. Saisissez un nom de requête.

  5. Sélectionnez Manuelle comme Déclencheur.

  6. Saisissez l’URL pour cette demande.

  7. Cliquez sur la méthode (verbe) pour cette demande.

  8. Sous En-têtes, ajoutez les en-têtes nécessaires à votre demande :

    1. Cliquez sur Ajouter un en-tête.

    2. Saisissez un nom d’en-tête et une valeur d’en-tête.

  9. Under Query Parameters, add any query parameters that are required for your request: 
    1. Cliquez sur Ajouter un paramètre de requête.
    2. Entrez un nom de paramètre de requête et une valeur de paramètre de requête.

  10. Sélectionnez un Type de support et saisissez le contenu du Corps. Le type de support affecte le format du contenu du corps. Il doit correspondre au type requis par le service Web auquel vous vous connectez.

    Option Détails

    ApplicationJson

    Le contenu du corps doit être au format JSON avec application/json comme en-tête de contenu.
    ApplicationJsonPatch Le contenu du corps doit être au format JSON Patch avec application/json-patch+json comme en-tête de contenu.
    FormURLEncoded

    Le contenu du corps doit être constitué de paires clé-valeur avec application/x-www-form-urlencoded comme en-tête de contenu. Ce type de support envoie des requêtes en utilisant les notations URL courantes.

    Cliquez sur +Ajouter un paramètre de formulaire, puis saisissez le nom du paramètre de formulaire et la valeur du paramètre de formulaire.
    TextHtml Le contenu du corps doit être au format HTML avec text/html comme en-tête de contenu.
    TextPlain Le contenu du corps doit être en texte brut avec text/plain comme en-tête de contenu.
    TextXml Le contenu du corps doit être au format XML avec text/xml comme en-tête de contenu.
  11. Si vous souhaitez modifier l’état actif de cette demande, cliquez sur Actif en haut de la page. Le texte devient Inactif.
  12. Cliquez sur Confirmer.
  13. Dans l’onglet Demandes, cliquez sur Test pour la demande que vous venez d’ajouter. Integration Hub tente d’exécuter la demande. Une fenêtre apparaît et affiche les résultats du test.
  14. Cliquez sur Modifier et apportez des modifications à la demande ou cliquez sur Enregistrer.

Créer une Demande Studio

Une demande Studio est utile lorsque vous avez des demandes API qui ne peuvent pas être créées dans Integration Hub, mais que vous souhaitez pouvoir utiliser Integration Hub pour l’authentification et les secrets.

  1. Dans NiCE CXone, cliquez sur le sélecteur d'applications et sélectionnez Automatisation et AI > Integration Hub.

  2. Cliquez sur la connexion avec laquelle vous souhaitez travailler dans la section Mes Connexions sur le côté gauche de la page.

  3. Dans l’onglet Demandes, cliquez sur Ajouter une Demande.

  4. Saisissez un nom de requête.

  5. Sélectionnez Studio comme Déclencheur.

  6. Sélectionnez et copiez l’exemple de charge utile de la page Ajouter une demande si vous souhaitez utiliser l’exemple pour construire le JSON dans votre script.

  7. Cliquez sur Confirmer.

    Les demandes Studio ne peuvent pas être testées à partir de Integration Hub. Vous devez les tester dans Studio en exécutant le script avec une trace.

  8. Cliquez sur Icône d’une disquette Enregistrer.

  9. Lancer Studio et connectez-vous.
  10. Ouvrez un script existant ou créez un nouveau script.
  11. Ajoutez une Snippet action à votre script, puis double-cliquez dessus pour ouvrir la fenêtre de l’éditeur Snippet.

  12. Créez un objet dynamique dans la fenêtre de l’éditeur Snippet, puis convertissez-le en JSON. L’objet que vous créez doit contenir des membres qui contiennent les en-têtes, les paramètres de requête et le contenu du corps de la demande.

    Utilisez l’exemple de charge utile que vous avez copié dans le Integration Hub lors d’une étape précédente comme guide lorsque vous créez votre objet. L’exemple de charge utile est le suivant : 

    {
 "URL": "[[INSTANCEURI]]/INCONTACTAPI/SERVICES/V42.0/AGENTS",
 "HTTPMETHOD": "POST",
 "HEADERS": {
	"CONTENT-TYPE": "APPLICATION/JSON",
	"AUTHORIZATION": "BEARER[[BEARERTOKEN]]"
	},
 "QUERYPARAMETERS": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "8675309"
	},
 "BODY": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "9035768",
	"ACCOUNTNAME": "Mister Underhill Bagginses"
	}
}

    Un objet dynamique créé à l’aide de l’exemple de charge utile est :

    DYNAMIC requestPayload 

ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERVICES/V42.0/AGENTS"

ASSIGN requestPayload.HTTPMETHOD = "POST"

ASSIGN requestPayload.HEADERS.CONTENTHYPHENPLACEHOLDERTYPE = "APPLICATION/JSON"

ASSIGN requestPayload.HEADERS.AUTHORIZATION = "BEARER[[BEARERTOKEN]]"

ASSIGN requestPayload.QUERYPARAMETERS.ANI = "[[ANI]]"

ASSIGN requestPayload.QUERYPARAMETERS.ACCOUNTID = "8675309"

ASSIGN requestPayload.BODY.ANI = "[[ANI]]"

ASSIGN requestPayload.BODY.ACCOUNTID = "9035768"

ASSIGN requestPayload.BODY.ACCOUNTNAME = "Mister Underhill Bagginses"

ASSIGN requestPayloadJSON = "{requestPayload.asjson()}"

ASSIGN requestPayloadJSON = "{requestPayloadJSON.replace("HYPHENPLACEHOLDER", "-")}"

    La dernière ligne de l’exemple précédent utilise la fonction replace() pour insérer le caractère trait d’union ( - ) dans le nom de clé CONTENT-TYPE. Dans Studio, les noms de variable ne peuvent pas inclure de caractères spéciaux tels que des traits d’union, cette approche est donc utilisée comme solution de contournement.

  13. Configurez le script pour qu’il utilise la demande.

Modifier l’état d’une Demande

Chaque connexion Integration Hub peut avoir jusqu’à 50 demandes. Il n’y a aucune restriction quant au nombre de demandes actives à la fois. Les Demandes sont actives par défaut.

  1. Dans NiCE CXone, cliquez sur le sélecteur d'applications et sélectionnez Automatisation et AI > Integration Hub.

  2. Cliquez sur la connexion avec laquelle vous souhaitez travailler dans la section Mes Connexions sur le côté gauche de la page.

  3. Dans l’onglet Demandes, cliquez sur la demande avec laquelle vous souhaitez travailler.

  4. Cliquez sur Inactif ou Actif en haut de la page pour modifier l’état.