API et scripts

Dans vos scripts Studio, vous pouvez vous connecter à des services Web qui utilisent les normes d’API SOAP ou RESTful.

Options prises en charge

Studio prend en charge les méthodes suivantes pour la connexion aux services Web :

Option	Détails
REST API Studio action	L’action REST API Studio action vous permet d’effectuer des Appels API RESTful à partir de vos scripts. Cette méthode : Peut gérer des charges plus élevées que les appels RESTful effectués dans une action SNIPPET action, particulièrement à grande échelle. Est la méthode préférée pour effectuer des appels d’API dans les scripts. Est l’une des options à utiliser si vos appels incluent du JSON.
Integration Hub	Integration Hub est une application NiCE CXone qui vous permet de configurer l’authentification et les demandes API à utiliser dans la plateforme. Elle vous permet également de stocker des données sensibles, comme des mots de passe ou des clés, dans un format chiffré à utiliser dans les scripts. L’action CONNECTREQUEST action et l’action CONNECTAUTH action vous permettent d’utiliser les détails d’authentification et les demandes configurés dans vos scripts. Integration Hub est l’autre option à utiliser si vos appels incluent du JSON.
NiCE CXone API Studio actions	Studio comporte de nombreuses Actions API qui vous permettent d’effectuer des appels aux API NiCE CXone à partir de vos scripts. Toutes les API NiCE CXone ne sont pas disponibles sous forme d’action, mais lorsqu’une l’est, vous devriez l’utiliser plutôt qu’une autre méthode. Vous pouvez trouver les Actions API dans la section API de l’onglet Framework dans Desktop Studio et la palette Actions API dans Studio.
Actions Extrait DE CODE (SNIPPET)	Vous pouvez écrire du code dans une action SNIPPET pour vous connecter à des services Web RESTful ou SOAP à partir de votre script. Il ne s’agit pas de la méthode recommandée pour effectuer des appels REST, car elle peut ralentir la gestion des contacts et causer de graves problèmes de performance avec la plateforme. Toutefois, vous devez utiliser cette méthode si : Vos appels incluent du XML. Vous vous connectez à un service SOAP. Si vous devez utiliser SNIPPET, revoyez les recommandations pour minimiser l’impact sur votre système avant de vous connecter à des services Web RESTful ou SOAP.
Intégration des flux de travail CRM	Configurez les intégrations de flux de travail CRM systèmes tiers qui gèrent des éléments tels que les contacts, les informations de vente, les détails de soutien et les historiques de cas. lorsque vous devez effectuer des Appels API vers le CRM de votre organisation. Cette fonctionnalité est prise en charge dans Agent Workspace (Agent), Agent Workspace (Embedded) (Agent Embedded) et Agent Workspace (Browser Extension) (Agent Integrated).

Limitations relatives à la taille des données renvoyées

La plateforme NiCE CXone permet aux API REST de renvoyer jusqu’à 32 Ko de données. Cette limite empêche l’instabilité et les pannes des clusters. Elle est strictement appliquée.

Cette limite s’applique à toute méthode de connexion à des services Web, y compris REST API action, Integration Hub, et l’exécution d’appels avec l’action SNIPPET. Si possible, utilisez l’action REST API plutôt que l’action SNIPPET pour vos API REST. REST API a une limite de renvoi de 32 Ko, mais elle peut gérer une charge plus importante que la méthode SNIPPET.

Pour réduire la taille des données renvoyées :

• Filtrez les données dans la réponse de l’API : Par exemple, si vous utilisez l’API Reporting NiCE pour obtenir des contacts, vous pouvez filtrer les résultats selon startDate et endDate du contact. Cet Appel api vous permet également de renvoyer et de limiter un nombre haut d’éléments. Reportez-vous à la documentation de l’API fournie avec votre intégration de script pour déterminer les Filtres que vous pouvez utiliser.

• Mettez à jour la demande d’API pour renvoyer uniquement les données dont vous avez besoin : Par exemple, si vous utilisez l’API Reporting NiCE pour obtenir des contacts, vous pouvez utiliser les champs contactId ou agentId pour renvoyer uniquement les données pertinentes. Reportez-vous à la documentation de l’API fournie avec votre intégration de script pour déterminer les limites de données que vous pouvez utiliser.

• Créez un intergiciel : Si vous ne pouvez faire ni l’une ni l’autre des Options précédentes, créez un intergiciel qui effectue le filtres en fonction de critères personnalisés que vous définissez. Si vous procédez ainsi, assurez-vous que votre intergiciel n’ajoute pas de latence à l’Appel.

 

Code d’Erreur -1

Le code d’erreur -1 est un code interne utilisé pour indiquer qu’une erreur a été rencontrée lors d’un Appel API. Plus précisément, ce code indique une situation où un code d’état HTTP ne sera pas renvoyé, ou bien où il est renvoyé, mais ne peut pas être transmis au script.

La description du statut qui accompagne le code d’erreur -1 peut vous aider à déterminer le problème. Les descriptions de statut susceptibles d’accompagner ce code comprennent :

• La demande a été interrompue : L’opération a expiré. La demande peut avoir été traitée ou non. Une validation devrait être effectuée avant de configurer une boucle en réponse à un code d’état -1. Vous devrez peut-être modifier le paramètre de dépassement de délai dans l’appel à l’aide de la propriété ProxyTimeoutSeconds.

• Primitive JSON non valide. L’analyseur JSON n’a pas su interpréter la réponse. Il se peut que la réponse ait contenu des caractères non valides ou qu’elle n’ait pas été au format JSON. Souvent, cette erreur se produit lorsque la réponse est envoyée en HTML. Vous pouvez tester la réponse dans le débogueur d’extraits. L’article de la base de connaissances La Réponse de l’API REST n’est pas un JSON ou XML valide peut vous aider.

• Les données au niveau racine ne sont pas valides. L’analyseur XML n’a pas su interpréter la réponse. Il se peut que la réponse ait contenu des caractères non valides ou qu’elle n’ait pas été au format XML. Souvent, cette erreur se produit lorsque la réponse est envoyée en HTML. L’article de la base de connaissances La Réponse de l’API REST n’est pas un JSON ou XML valide peut vous aider.

• ’doctype’ est un jeton inattendu. Le jeton attendu est ’DOCTYPE’. Consultez Les données au niveau racine ne sont pas valides dans cette liste.

• La balise de début ’br’ à la ligne x, position x, ne correspond pas à la balise de fin de ’body’. Consultez Les données au niveau racine ne sont pas valides dans cette liste.

• La connexion sous-jacente a été fermée : Une erreur inattendue s’est produite lors d’un envoi. Cela signifie souvent qu’il y a un problème avec la négociation TLS. Cela peut également être causé par un port ou une Adresse ip non ouverts sur un pare-feu; l’utilisation d’une version ancienne et non prise en charge de TLS; des certificats non valides ou expirés; l’utilisation d’une adresse ip en combinaison avec HTTPS; ou des problèmes similaires. Résolvez ce problème en consultant les journaux du pare-feu du côté du serveur récepteur.

• La connexion sous-jacente a été fermée : Impossible d’établir une relation de confiance pour le canal sécurisé SSL/TLS. Consultez La connexion sous-jacente a été fermée : Une erreur inattendue s’est produite lors d’un envoi dans cette liste.

• La demande a été interrompue : Impossible de créer un canal sécurisé SSL/TLS. Consultez La connexion sous-jacente a été fermée : Une erreur inattendue s’est produite lors d’un envoi dans cette liste.

• Réponse trop volumineuse. (> 32 Ko). La réponse contient plus que 32 Ko de données. Lorsque cela se produit, la réponse est supprimée, car le système n’a aucun moyen de stocker plus de 32 Ko dans une seule variable. La réponse doit être modifiée ou filtrée pour réduire la quantité de données renvoyées.

Scripts et API