Configurer Connexions

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

Créer un modèle de connexion

Un modèle de connexion définit les informations de base sur 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.

Il est impossible de modifier les modèles de connexion après leur création. Si vous devez modifier certaines informations, notamment 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'application et sélectionnez Automation & AI > Integration Hub.
  2. Cliquez sur ajouter un Modèle.
  3. Sur l’onglet Détails, donnez un nom au 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 la méthode d’Intégration. Actuellement, REST est la seule méthode prise en charge.

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

    Option Détails
    OAuth 2.0 Un framework standard ouvert qui permet aux applications d’accéder à des ressources pour le compte d’un utilisateur sans partager d’identifiants.
    Aucune authentification Sélectionnez cette option si vous ne souhaitez pas inclure l’authentification dans le modèle.
  7. Saisissez la description du modèle. Les autres utilisateurs peuvent le voir lorsqu'ils sélectionnent ce modèle à partir de la bibliothèque de connexions.
  8. Joignez-lui une icône en faisant glisser une image ou en cliquant sur Parcourir des fichiers. Cette icône s'affiche 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. Entrez le nom DE l’en-tête dans le champ qui s’affiche.
    3. Cliquez sur ajouter un en-tête personnalisé pour ajouter d'autres en-têtes personnalisés.
    4. Sélectionnez Requis ? pour tous 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 des détails d’authentification, des variables ou des demandes. Votre demande peut inclure tout ou partie de ces configurations.

Ajouter une connexion à la liste My Connections List

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 figure dans la liste mes Connexions.

  1. Dans NiCE CXone, cliquez sur le sélecteur d'application et sélectionnez Automation & 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 + MA connexion.

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

  3. Dans le champ My Connection Name de la fenêtre contextuelle, saisissez un nom unique pour la nouvelle connexion.

  4. Cliquez sur enregistrer.

Configurer les Détails d'authentification

Vous pouvez configurer les détails d’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'application et sélectionnez Automation & AI > Integration Hub.

  2. Cliquez sur la connexion avec laquelle vous souhaitez travailler dans mes Connexions, sur le côté gauche de la Page.

  3. Cliquez sur l’onglet Authentification.

  4. Enter the URL used for the authentication request. The URL cannot be dynamic, but you can reference secrets in it.

  5. Sélectionnez la méthode (le verbe) REST 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, entrez la valeur appropriée dans chaque champ. Les Champs accompagné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 le Nom DE l’en-tête et la Valeur DE l’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, entrez un Query Parameter Name et un Query Parameter Value.

  9. Sélectionnez un Type de Média et saisissez le contenu du Corps. Le type de média a une incidence sur le 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 attendue par AWS.

    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 composé de paires clé-valeur. Ce type de média envoie les demandes en utilisant les notations URL courantes.

    Cliquez sur +ajouter un paramètre de formulaire et 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.
    TexteBrut Le contenu du corps doit être au format texte brut.
    TextXml Le contenu du corps doit être au format XML.

  10. Cliquez sur enregistrer.

Configurer un certificat de fournisseur d'identité auto-signé mTLS

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

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

  2. Cliquez sur la connexion que vous souhaitez utiliser dans mes Connexions, sur le côté gauche de la page.

  3. Cliquez sur l’onglet Configuration.

  4. Définissez le paramètre d’expiration (MS), si nécessaire. 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 autosigné mTLS, renseignez les champs suivants :

    • Certificat de fournisseur d'identité du 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 entrer le client Certificate et la client Private Key ensemble. Si votre client Private Key est chiffrée, vous devez entrer une Key Passphrase. Les certificats mTLS fonctionnent uniquement si votre URL d’authentification est en HTTPS. La validation de ces champs a lieu après que la connexion a été sauvegardée. Vous pouvez référencer ces champs dans l’onglet Secrets.

  5. Cliquez sur enregistrer.

Ajouter des variables à une connexion

Les Integration Hub variables vous permettent de partager certaines informations dans une connexion. Vous pouvez déterminer si ces informations sont cryptées ou non. Une variable crypté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 des scripts Studio.

Lorsque vous créez une variable, vous pouvez à tout moment la rendre secrète. une fois qu'une Variable devient un secret et que le connecteur a été sauvegardé, vous ne pouvez pas retransformer le secret en Variable.

Les secrets ne sont pas réversibles. Lorsque vous cliquez à l’extérieur du champ Secret Value, 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 une fois celle-ci masquée.

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

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

  3. Sur l’onglet Variable, cliquez sur + Ajouter une variable.

  4. Entrée un Nom DE variable qui identifie ce que contient la variable. Les noms peuvent contenir des espaces ou des caractères spéciaux.

  5. Saisissez la valeur de la variable . Il s'agit de la valeur de la variable et de l'information qui sera cryptée si vous convertissez la variable en secret. Vérifiez que les informations sont correctes avant de les convertir en secret.

  6. Pour chiffrer la variable, activez l'option Secret. N'oubliez pas que si vous activez cette option, vous ne pouvez pas revenir en arrière.

  7. Pour supprimer une variable de la connexion, cliquez sur le bouton X correspondant.

  8. Cliquez sur enregistrer.

Utiliser des variables dans une connexion

Vous pouvez utiliser des variables dans les demandes manuelles ou de script 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'application et sélectionnez Automation & AI > Integration Hub.

  2. Cliquez sur la connexion avec laquelle vous souhaitez travailler dans 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 sur les onglets Authentication et Demandes.

  4. Saisissez la variable à l'emplacement où vous souhaitez placer la valeur de variable, en suivant ces instructions :

    • Placez le nom entre doubles crochets. Par exemple, [[ variableName ]].
    • Utilisez le nom exactement tel qu'il a été saisi dans le champ Nom DE 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 lier le script à la connexion contenant la variable.

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

  2. Double-cliquez 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 respectant les consignes suivantes :

    • Placez le nom entre doubles crochets. Par exemple, [[ variableName ]].
    • Utilisez le nom exactement comme il a été saisi dans le champ Nom DE variable de l'onglet variables.
    • Mettez les crochets et le nom DE variable entre guillemets doubles ( " ). Par exemple, "[[ variableName ]]". Si la variable fait partie d’une chaîne, notamment une URL, placez la totalité de la chaîne (et pas uniquement la variable) entre guillemets doubles. 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 les scripts Studio ou les exécuter depuis 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'application et sélectionnez Automation & AI > Integration Hub.

  2. Cliquez sur la connexion que vous souhaitez utiliser dans mes Connexions, sur le côté gauche de la Page.

  3. Sur l’onglet Demandes, cliquez sur ajouter une Demande.

  4. Entrez le Nom DE LA demande.

  5. Sélectionnez Manuel comme déclencheur.

  6. Saisissez l’URL de cette demande.

  7. Cliquez sur la méthode (verbe) de 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 le Nom DE l’en-tête et la Valeur DE l’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. Entrée un nom du paramètre de requête et une valeur de paramètre de requête.

  10. Sélectionnez un Type de Média et saisissez le contenu du Corps. Le type de média a une incidence sur le 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 l’en-tête de contenu application/JSON.
    ApplicationJsonPatch Le contenu du corps doit être au format JSON Patch avec l’en-tête de contenu application/JSON-patch+JSON.
    FormURLEncoded

    Le contenu du corps doit être présenté sous forme de paires clé/valeur, avec application/x-www-form-urlencoded comme en-tête de contenu. Ce type de média envoie les demandes en utilisant les notations URL courantes.

    Cliquez sur +ajouter un paramètre de formulaire et 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 l’en-tête de contenu text/html.
    TextPlain Le contenu du corps doit être au format texte brut avec text/plain comme en-tête de contenu.
    TextXml Le contenu du corps doit être au format XML avec l’en-tête de contenu text/xml.
  11. Si vous souhaitez modifier le statut actif de cette demande, cliquez sur Active en haut de la page. Le texte indique désormais 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 s’affiche et présente 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'application et sélectionnez Automation & AI > Integration Hub.

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

  3. Sur l’onglet Demandes, cliquez sur ajouter une Demande.

  4. Entrez le Nom DE LA demande.

  5. Sélectionnez Studio comme déclencheur.

  6. Sélectionnez et copiez l’exemple de charge utile de la demande de la page ajouter une Demande si vous souhaitez utiliser l’exemple pour créer l’objet JSON dans votre script.

  7. Cliquez sur Confirmer.

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

  8. Cliquez sur Icon of a floppy disk enregistrer.

  9. Lancez Studio et connectez-vous.
  10. Ouvrez un script existant ou créez un nouveau script.
  11. Ajoutez une Snippet Action à votre script et double-cliquez sur celle-ci pour ouvrir la fenêtre de l'éditeur Snippet.

  12. Build a objet dynamique dans la fenêtre de l'éditeur Snippet et le convertir en JSON. L’objet que vous créez doit contenir des membres qui englobent 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é à partir d’Integration Hub dans une étape précédente pour vous guider dans la création de votre objet. La charge utile exemple est la suivante :

    {
 "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 le suivant :

    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 variables ne peuvent pas contenir de caractères spéciaux tels que des traits d’union ; c’est pourquoi cette approche est utilisée comme solution de contournement.

  13. Configurez le script pour utiliser la demande.

Changer l'état d'une Demande

Chaque connexion Integration Hub peut comporter jusqu'à 50 demandes. Aucune restriction n’est imposée quant au nombre de demandes pouvant être actives simultanément. Les Demandes sont actives par défaut.

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

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

  3. Sur l’onglet Demandes, cliquez sur la Demande que vous souhaitez utiliser.

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