Gérer les connexions

Le contenu de cette page concerne un produit ou une fonctionnalité en version contrôlée (CR). Si vous ne faites pas partie du groupe CR et souhaitez plus d'informations, contactez votreReprésentant de compte CXone.

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

Créer un modèle connecté

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, lesquelles vous permettent de 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.

Capture d’écran de la page Ajouter un modèle dans Integration Hub.
  1. Dans CXone, cliquez sur le sélecteur d'application et sélectionnezAutomatisation et IA > 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 méthode d’intégration. Actuellement, REST est l’unique méthode prise en charge.

  6. Sélectionnez une option dans le champ Type d’authentification.

    Option Détails
    OAuth 2.0 Sélectionnez cette option si vous souhaitez inclure l’authentification OAuth 2.0 dans le modèle. Actuellement, il s’agit du seul type d’authentification pris en charge.
    Pas d’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 afficher cette description lorsqu’ils sélectionnent ce modèle dans la bibliothèque de connexions.
  8. Joignez une icône en déplaçant une image ou en cliquant sur Parcourir des Fichiers. Cette icône s’affiche pour ce modèle dans la bibliothèque de connexions et sous Mes 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. Pour définir des en-têtes d’authentification personnalisés pour ce modèle, cliquez sur Ajouter un en-tête personnalisé. Cette option n’est disponible que si vous avez activé l’authentification pour le modèle. Pour définir un en-tête : 
    1. Saisissez le nom de l’en-tête dans le champ qui s’affiche.
    2. Cliquez sur Ajouter un en-tête personnalisé pour ajouter d’autres en-têtes personnalisés.
    3. Sélectionnez Requis ? en regard des en-têtes devant être utilisés dans les connexions créées à partir de ce modèle.
    4. Cliquez sur le signe X pour supprimer un en-tête.
  11. Examinez scrupuleusement tous les paramètres. Vous ne pouvez pas modifier un modèle après l’avoir enregistré.
  12. Procédez de l’une des façons suivantes :
    • 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 secrets ou des demandes. Votre demande peut inclure tout ou partie de ces configurations.

Créer une connexion à partir d’un modèle

Les connexions vous permettent de créer des demandes et d’ajouter des détails d’authentification. Les connexions s’affichent sous Mes connexions dans Integration Hub.

Vous créez des connexions à partir de modèles de connexion. La bibliothèque de connexions contient tous les modèles de connexion qui existent dans votre système CXone. S’il n’existe aucun modèle correspondant à vos besoins, vous pouvez en créer un.

  1. Dans CXone, cliquez sur le sélecteur d'application et sélectionnezAutomatisation et IA > Integration Hub.

  2. Localisez un modèle dans la bibliothèque de connexions. La bibliothèque se trouve à droite de la page. Si vous consultez une connexion ou un modèle, cliquez sur le bouton X dans l’angle supérieur droit de la page. La connexion ou le modèle se ferme et la bibliothèque de connexions s’affiche.

  3. Cliquez sur Ma connexion sur la page des propriétés du modèle pour créer une connexion basée sur le modèle.

  4. Si vous utilisez un certificat autosigné mTLS, renseignez les champs suivants :

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

    Ces champs sont disponibles uniquement si vous utilisez OAuth 2.0 comme type d’authentification. Vous devez spécifier le certificat du client et la clé client privée ensemble. Si votre clé client privée est cryptée, vous devez saisir la phrase secrète de la clé. Les certificats mTLS fonctionnent uniquement si votre URL d’authentification est HTTPS. La validation de ces champs a lieu après l’enregistrement de la connexion. Vous pouvez référencer ces champs dans l’onglet Secrets.

  5. Saisissez un nom pour la connexion et cliquez sur Enregistrer.

  6. Cliquez sur la nouvelle connexion dans la liste située à gauche de la page.

  7. Dans l’onglet Configuration, configurez un dépassement de délai en millisecondes. Le dépassement de délai s’applique à toutes les demandes configurées dans la connexion, y compris l’authentification.

  8. Configurez l’authentification et les demandes selon vos besoins. Votre connexion peut inclure l’authentification ou les demandes, ou les deux.

  9. Configurez les secrets si vous souhaitez crypter certaines informations en vue de les utiliser dans la connexion.

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 CXone, cliquez sur le sélecteur d'application et sélectionnezAutomatisation et IA > Integration Hub.

  2. Cliquez sur la connexion que vous souhaitez utiliser dans la section Mes connexions sur le côté gauche de la page.

  3. Sur l’onglet Authentification, saisissez l’ URL utilisée pour la demande d’authentification. L’URL ne peut pas être dynamique, mais vous pouvez y référencer des secrets.

  4. 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.

  5. Sous En-têtes, saisissez 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.

  6. 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.

  7. Pour ajouter un paramètre de requête à la demande d’authentification :
    1. Cliquez sur Ajouter un paramètre de requête.
    2. Pour chaque paramètre de requête que vous ajoutez, saisissez le nom du paramètre de la requête et la valeur de paramètre de la requête.

  8. 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

    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 contenir des paires de 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.
    TextPlain Le contenu du corps doit être au format Texte Clair.
    TextXml Le contenu du corps doit être au format XML.

  9. Cliquez sur Enregistrer.

Ajouter des secrets à une connexion

Les secrets Integration Hub vous permettent de crypter certaines informations lors d’une connexion. Ils permettent de renforcer la sécurité lors de l’utilisation d’informations sensibles, notamment de mots de passe, dans les scripts Studio.

Les secrets ne sont pas réversibles. Lorsque vous cliquez en dehors du champ Valeur du secret, le contenu est crypté 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 masquée.

  1. Dans CXone, cliquez sur le sélecteur d'application et sélectionnezAutomatisation et IA > Integration Hub.

  2. Cliquez sur la connexion que vous souhaitez utiliser dans la section Mes connexions sur le côté gauche de la page.

  3. Dans l’onglet Secrets, cliquez sur Ajouter un secret.

  4. Saisissez le nom du secret qui identifie le contenu du secret. Ce nom est utilisé comme variable lorsque vous utilisez le secret dans la connexion. Les noms peuvent contenir des espaces ou des caractères spéciaux.

  5. Saisissez la valeur du secret. Ces informations seront cryptées. Avant de cliquer en dehors de ce champ, vérifiez que les informations sont correctes.

  6. Cliquez sur Enregistrer.

Utiliser des secrets dans une connexion

Les secrets sont utilisés comme des variables. Vous saisissez le nom formaté du secret à la place de la valeur qu’il contient. Lorsque la connexion est utilisée, le système remplace le nom du secret par sa valeur cryptée.

Vous pouvez utiliser des secrets dans des demandes manuelles ou Studio. Dans les détails d’authentification, vous pouvez utiliser des secrets dans les en-têtes, les paramètres de requête et le contenu du corps.

Utiliser un secret dans les détails d’authentification ou dans une demande manuelle

  1. Dans CXone, cliquez sur le sélecteur d'application et sélectionnezAutomatisation et IA > Integration Hub.

  2. Cliquez sur la connexion que vous souhaitez utiliser dans la section Mes connexions sur le côté gauche de la page.

  3. Cliquez sur l’onglet dans lequel vous souhaitez utiliser un secret. Il est possible d’utiliser des secrets sur les onglets Authentification et Demandes.

  4. Saisissez le secret à l’emplacement où vous souhaitez placer la valeur du secret, en suivant ces instructions :

    • Placez le nom entre doubles crochets. Par exemple, [[ nomSecret ]].
    • Utilisez le nom tel qu’il a été saisi dans le champ Nom du secret sur l’onglet Secrets.
    • Les secrets ne peuvent être utilisés qu’avec la connexion dans laquelle ils ont été créés.

Utiliser un secret dans une demande Studio

Pour utiliser des secrets dans un script Studio, le script doit disposer d’une action CONNECTAuth ou CONNECTREQUEST. L’action doit lier le script à la connexion contenant le secret.

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

  2. Double-cliquez sur l’action Snippet dans laquelle vous souhaitez ajouter le secret.

  3. Dans la fenêtre de l’éditeur de Snippet, ajoutez le secret à l’emplacement où vous souhaitez utiliser la valeur du secret, en suivant ces instructions :

    • Placez le nom entre doubles crochets. Par exemple, [[ nomSecret ]].
    • Utilisez le nom tel qu’il a été saisi dans le champ Nom du secret sur l’onglet Secrets.
    • Placez les crochets et le nom du secret entre guillemets doubles ( " ). Par exemple, "[[ nomSecret ]]". Si le secret fait partie d’une chaîne, notamment une URL, placez la totalité de la chaîne (et pas uniquement le secret) entre guillemets doubles. Par exemple, "[[ nomSecret ]]/emplacement/autreemplacemen t/".
    • Les secrets ne peuvent être utilisés qu’avec la connexion dans laquelle ils ont été créés. 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 URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.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 à partir de Integration Hub.

Si votre demande nécessite des paramètres de chemin ou une substitution de variables 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 CXone, cliquez sur le sélecteur d'application et sélectionnezAutomatisation et IA > Integration Hub.

  2. Cliquez sur la connexion que vous souhaitez utiliser dans la section 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. Sous Paramètres de requête, ajoutez tous les paramètres de requête nécessaires à votre demande : 
    1. Cliquez sur Ajouter un paramètre de requête.
    2. Saisissez le nom du paramètre de requête et la 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 êtes connecté.

    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 contenir des paires de 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 text/html comme en-tête de contenu.
    TextPlain Le contenu du corps doit être au format Texte Clair 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 le statut Actif de cette demande, cliquez sur Actif en haut de la page. Le texte indique désormais Inactif.
  12. Cliquez sur Confirmer.
  13. Sur l’onglet Demandes, cliquez sur Tester en regard de la demande que vous venez d’ajouter. Integration Hub effectue un test de 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 Studiodemande est utile lorsqu’il s’avère impossible de créer certaines de vos demandes d’API dans Integration Hub, mais que vous souhaitez utiliser Integration Hub pour l’authentification et des secrets.

  1. Dans CXone, cliquez sur le sélecteur d'application et sélectionnezAutomatisation et IA > Integration Hub.

  2. Cliquez sur la connexion que vous souhaitez utiliser dans la section 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.

    Il est impossible de créer les demandes Studio à partir d’Integration Hub. Vous devez les tester dans Studio en exécutant le script avec une trace.

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

  12. Créez un objet dynamique dans la fenêtre de l’éditeur de Snippet et convertissez-le en objet 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. L’exemple de charge utile est le suivant :

    {
 "URL": "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS",
 "HTTPMETHOD": "POST",
 "HEADERS": {
	"CONTENT-TYPE": "APPLICATION/JSON",
	"AUTHORIZATION": "BEARER[[BEARERTOKEN]]"
	},
 "QUERYPARAMETERS": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456"
	},
 "BODY": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456",
	"ACCOUNTNAME": "TESTACCOUNT"
	}
}

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

    DYNAMIC requestPayload 
ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.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 = "123456"
ASSIGN requestPayload.BODY.ANI = "[[ANI]]"
ASSIGN requestPayload.BODY.ACCOUNTID = "123456"
ASSIGN requestPayload.BODY.ACCOUNTNAME = "TESTACCOUNT"
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 tiret ( - ) dans le CONTENT-TYPE nom de clé. 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.

Modifier l’état de la demande

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. Les demandes sont actives par défaut.

  1. Dans CXone, cliquez sur le sélecteur d'application et sélectionnezAutomatisation et IA > Integration Hub.

  2. Cliquez sur la connexion que vous souhaitez utiliser dans la section 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 sur Actif en haut de la page pour modifier l’état.