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
API REST Studio action

La REST API Studio action permet d'effectuer des Appels API RESTful depuis vos scripts. Cette méthode :

  • Peut gérer des charges plus élevées par rapport à l'exécution d'appels RESTful dans une 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.

Les actions CONNECTREQUEST action et 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.
API NiCE CXone Studio actions Studio comporte de nombreux Actions API permettant d'effectuer des appels aux 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. Ce n'est pas la méthode recommandée pour effectuer des appels REST, car cela peut ralentir la gestion des contacts et provoquer 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, revoyez les recommandations pour 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 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 d’API au 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 évite les pannes et de rendre les clusters instables. Elle s’applique de manière stricte.

Cette limite s'applique à toute méthode de connexion à des services web, y compris REST API action, Integration Hub, et effectuer des appels avec l'action SNIPPET. Si possible, utilisez l’action REST API à la place de l’action SNIPPET pour vos API REST. REST API a une limite de retour de 32 Ko, mais elle peut gérer une charge plus importante que ne le permet la méthode SNIPPET.

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

  • Filtrer les données dans la réponse API : Par exemple, si vous utilisez l'API Reporting 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 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 API pour renvoyer uniquement les données dont vous avez besoin : Par exemple, si vous utilisez l'API de création de rapports 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 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 effectuer aucune des deux options précédentes, créez un middleware qui effectue des filtres en fonction de critères personnalisés que vous définissez. Si vous procédez ainsi, 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é abandonnée : le délai de l'opération a été dépassé. La demande peut avoir été traitée ou non. Une validation doit ê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é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 contenu 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 the upper right corner. article de la base DE connaissances peut vous aider.

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

  • The underlying connection was closed: An unexpected error occurred on a send. Often this means that there is a problem with the TLS handshake. It can also be caused by an IP or port not being open on a firewall; using an old, unsupported version of TLS; invalid or expired certificates; using an IP address in combination with HTTPS; or similar issues. Troubleshoot this response with the firewall logs on the receiving server side.

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

  • La demande a été abandonnée : 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.

  • Response too large. (> 32 KB). The response contains more than 32 KB of data. When this happens, the response is discarded because the system has no way of storing more than 32 KB in one variable. The response must be modified or filtered to reduce the amount of data returned.