API et scripts

Les informations sur cette page d’aide concernent à la fois Studio et Desktop Studio.

Dans vos scripts Studio, vous pouvez établir une connexion à des services web qui utilisent les normes d’API SOAP et RESTful.

Options prises en charge

Studio prend en charge les méthodes suivantes de connexion aux services web :

Option Détails
REST API Studio action

La REST API Studio action vous permet d'effectuer des appels d'API RESTful à partir de vos scripts. Cette méthode :

  • Peut traiter des charges plus importantes que la réalisation d'appels Reposant dans une action SNIPPET action, en particulier à grande échelle.
  • est la méthode à privilégier pour effectuer des appels d’API dans les scripts ;
  • Est l'une des options à utiliser si vos appels incluent 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, telles que des mots DE passe ou des clés, dans un format chiffré à utiliser dans des scripts.

L'CONNECTREQUEST action et l'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 JSON.

API NiCE CXone Studio actions Studio comporte de nombreuses Actions API qui vous permettent d'effectuer des appels vers les API NiCE CXone depuis vos Scripts. Toutes les API NiCE CXone ne sont pas disponibles sous forme d’action, mais lorsqu’elles le sont, vous devez les utiliser plutôt que de passer par une autre méthode. Vous trouverez les Actions API dans la section API de l’onglet Framework dans Desktop Studio et dans la palette Actions d’API dans Studio.
Actions extrait

Vous pouvez écrire du code dans une action SNIPPET pour vous connecter à des services Web RESTful ou SOAP depuis votre script. Il s'agit d'une méthode non recommandée pour effectuer des appels REST, car elle peut ralentir la gestion des contacts et entraîner de graves problèmes de performance avec la plateforme. En revanche, vous devez l’utiliser dans les cas suivants :

  • Vos appels incluent des données XML.
  • Vous vous connectez à un service SOAP.

Si vous devez utiliser SNIPPET, revoir les recommandations permettant de minimiser l'impact sur votre système avant de vous connecter à des services web RESTful ou SOAP.

Intégrations de flux de travail CRM Configurez des intégrations de flux de travail CRMClosed Third-party systems that manage such things as contacts, sales information, support details, and case histories. lorsque vous devez effectuer des appels d’API au CRM de votre organisation. This is supported in Agent Workspace (Embedded) (Agent Embedded), et Agent Workspace (Browser Extension) (Agent Integrated).

Limitations sur 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 évite les pannes et de rendre les clusters instables. Elle s’applique de manière stricte.

This limit applies to any method of connecting to web services, including the REST API action, Integration Hub, and making calls with the SNIPPET action. If you can, use the REST API action instead of the SNIPPET action for your REST APIs. REST API has a return limit of 32 KB, but it can handle a heavier load than the SNIPPET method can.

Pour réduire la taille des données qui vous sont renvoyées :

  • Filtrez les données dans la réponse de l'API : par exemple, si vous utilisez l'API de création de rapports NiCE pour obtenir des contacts, vous pouvez filtrer les résultats par startDate et endDate du contact. Cet Appel API vous permet également de renvoyer et de limiter le nombre d'éléments les plus hauts. Reportez-vous à la documentation API fournie avec l'intégration de votre script pour déterminer les filtres que vous pouvez utiliser.

  • Mettre à jour la demande API pour renvoyer uniquement les données dont vous avez besoin : par exemple, si vous utilisez l'API Reporting NiCE pour récupérer des contacts, vous pouvez utiliser les champs contactId ou agentId pour renvoyer uniquement les données pertinentes. Reportez-vous à la documentation de l’API associée à votre intégration de script pour déterminer les limites de données que vous pouvez utiliser.

  • Créer un middleware : Si vous ne pouvez pas effectuer l'une des options précédentes, créez un middleware qui applique des filtres en fonction de critères personnalisés que vous définissez. Si vous faites cela, assurez-vous que votre middleware n'ajoute pas de latence à l'appel.

 

Code d'Erreur -1

Le code d'erreur -1 est un code interne utilisé pour identifier qu'une erreur a été rencontrée avec un Appel API. plus précisément, ce code indique qu'il s'agit d'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 du statut qui peuvent accompagner ce code sont les suivantes :

  • La demande a été interrompue : l'opération a dépassé le délai d'expiration. La demande peut avoir été traitée ou non. Une validation doit avoir lieu avant de configurer une boucle en réponse à un code d'état -1. Vous devrez peut-être modifier le paramètre de délai d'expiration dans l'appel à l'aide de la propriété ProxyTimeoutSeconds.
  • Primitive JSON non valide. L'analyseur JSON a été dérouté par la réponse. La réponse peut avoir inclus des caractères non valides ou n'était pas au format JSON. Cette erreur se produit souvent lorsque la réponse est envoyée dans un fichier HTML. Vous pouvez tester la réponse dans le débogueur d'extraits. La Réponse de l'API REST n'est pas un JSON ou XML valide A square with an arrow pointing from the center to la upper right corner. peut vous être utile.

  • Data at the root level is invalid. The XML parser was confused by the response. The response may have included invalid characters or wasn't XML. Often, this error occurs when the response is sent in HTML. The REST API Response is not valid JSON or XML  A square with an arrow pointing from the center to the upper right corner. knowledge base article may help.

  • 'doctype' is an unexpected token. The expected token is 'DOCTYPE'. See Data at the root level is invalid in this list.

  • La balise de début « br » à la ligne x position x ne correspond pas à la balise de fin de « body ». Voir 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. Souvent, cela signifie qu'il y a un problème avec la négociation TLS.Cela peut également être causé par une Adresse IP ou un port non ouvert sur un pare-feu ; l'utilisation d'une version de TLS ancienne et non prise en charge ; des certificats invalides ou expirés ; l'utilisation d'une adresse IP en combinaison avec HTTPS ; ou des problèmes similaires. Pour résoudre ce problème, consultez les journaux de pare-feu sur le serveur de réception.

  • La connexion sous-jacente est fermée : impossible d’établir une relation de confiance pour le canal sécurisé SSL/TLS. Voir The underlying connection was closed: An unexpected error occurred on a send dans cette liste.

  • La demande a été abandonnée : impossible de créer un canal sécurisé SSL/TLS. Voir 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. Dans ce cas, la réponse est ignorée, car le système ne peut pas 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ée.