Rest Api Action

Rest Api Action icon

Traite les appels d’API RESTful de manière synchrone. Cette action permet au système de traiter des charges plus importantes. Elle renvoie à la fois le corps et les en-têtes de l’appel API. Cela facilite le test et le débogage des scripts.

Pour tester un script contenant une option d’API REST et afficher des informations sur la réponse, vous devez exécuter le script. Exécutez le script en utilisant l’option Démarrer avec trace.

Vous pouvez également effectuer des appels d’API REST synchrones en utilisant la fonction GetRestProxy dans une action SNIPPET. La charge est alors moins élevée qu’avec l’action REST API.

Dependencies

L'utilisation de cette action est limitée. Des limitations sont imposées au niveau del'unité commercialeFermé Regroupement organisationnel de haut niveau utilisé pour gérer le support technique, la facturation et les paramètres globaux de votre CXone environnement de sorte que l’un ne doit pas avoir d’impacts sur l’autre. Les limitations au niveau de plate-forme sont les suivantes :

  • Format de réponse : seul le format de réponse JSON est pris en charge.
  • Nouvelle tentative en cas d'échec : le gestionnaire d'actions essaiera automatiquement deux fois en cas d'échec avant de renvoyer la réponse.
  • Dépassement de délai : vous spécifiez la valeur de dépassement de délai dans la requête. La valeur ne peut pas être supérieure à 90 secondes.
  • Taille maximale de la réponse : la taille maximale de la réponse est de 32 Ko. Ceci est conforme à la fonctionnalité existante de Snippet.
  • Limite d’étranglement : la limite d’étranglement est définie par deux paramètres :
    • Nombre maximal de demandes simultanées  : jusqu’à 100 requêtes simultanées sont autorisées par défaut. Cette limite est la même pour tous les clients CXone. Cela signifie que 100 demandes simultanées donnent lieu à un débit beaucoup plus élevé que la fonctionnalité existante de Snippet. Si vous avez besoin de plus de 100 requêtes simultanées, demandez à votre Représentant de compte CXone d'augmenter la limite pour votre unité commerciale . Des approbations spéciales sont requises.
    • Nombre en file d’attente : lorsque le nombre de demandes dépasse la limite, les demandes supplémentaires aboutissent dans une file d’attente de traitement. Lorsque le nombre de demandes passe sous la limite, les demandes en file d'attente sont traitées.
  • Disjoncteur : si l'URL que vous avez spécifiée est hors service ou inaccessible, vous risquez d'obtenir trop d'échecs sur votre demande. Dans ce cas, CXone réduira l’exécution des demandes de TOUTES les URL issues de l’action REST API pendant un certain temps. Cela permet à l'URL spécifiée de se remettre de la panne. Les limites sont identifiées ci-dessous.
    • Temps de pause ou durée de la pause : si le taux d’échec est atteint, aucune demande issue de l’action REST API ne sera exécutée pendant 30 secondes.
    • Débit minimum : 100 demandes par seconde. Si votre unité commerciale n'exécute pas le nombre minimum de demandes, il continuera à exécuter vos demandes, même si celles-ci échouent.
    • Taux d'échec : si 50 % des requêtes ont échoué pendant 30 secondes, vos demandes ne seront pas exécutées pendant les 30 secondes suivantes. 30 secondes est une fenêtre de roulement.

Input Properties

Ces propriétés définissent les données que l'action utilise lors de son exécution.

Propriété

Description

une légende

Entrez une courte phrase qui identifie cette action dans le script de manière unique. La légende est affichée sur le canevas de script sous l’icône de l’action. The default is the action name.

Verb

Prend en charge les actions de base REST telles que GET, PUT, POST, DELETE et PATCH.
Parameters

Prend en charge la possibilité de spécifier des paramètres de requête ou de publier des données. Tout type de JSON - Jobject, Jarray, Jtoken doit être acceptable. Actuellement, l'action nécessite que JSON soit fourni sur une seule ligne. La substitution de variable à partir d'une chaîne contenant du JSON ou la conversion de type Dynamic Data en JSON à l'aide de la fonction asjson() sont prises en charge. Vous pouvez également transmettre la variable de sortie resultSet(out) d'une action d'API REST précédente à cette propriété.
Headers

Prend en charge la possibilité d'ajouter des en-têtes personnalisés pour permettre l'authentification du client (comme les jetons de support). Les paires valeur / clé exprimées au format JSON sont acceptées. Cette action nécessite que JSON soit fourni sur une seule ligne. La substitution de variable à partir d’une chaîne contenant du JSON ou la conversion de type Dynamic Data en JSON à l’aide de la fonction asjson() sont prises en charge. Vous pouvez également transmettre la variable de sortie resultSet(out) d'une action REST API précédente à cette propriété.

Important Si votre point de terminaison d'URL personnalisé nécessite des en-têtes différents, il doit être spécifié dans cette propriété. Pour maintenir la parité des fonctionnalités avec l'action Snippet existante, CXone ajoute les en-têtes suivants.

{"Accept":"application/json", "Content-Type" :"application/x-www-form-urlencoded"}

Command

La seule option est MakeRestRequest, qui fonctionne de la même manière dans une action Snippet. Un développement futur peut offrir des commandes supplémentaires que l'action Snippet fournit.

TimeOutInMilliSeconds

Permet de spécifier et d'honorer un délai d'expiration de l'appel REST. Doit durer moins de 90 secondes (90000 millisecondes). Si aucun dépassement de délai n'est défini, la valeur par défaut est 10 secondes (10 000 millisecondes).
Service Address

Permet de fournir une URL personnalisée, y compris la possibilité de spécifier des paramètres de requête pour un GET. La substitution de variable est également prise en charge.

Propriétés de sortie

Ces propriétés contiennent des variables qui stockent les données renvoyées par l'exécution de l'action. Elles sont disponibles à des fins de référence et d’utilisation lorsque l'action est terminée.

Propriété

Description

resultSet(out)

La propriété contenant tout information renvoyée à partir de l’API spécifiée dans l’Adresse de service. Dans la fenêtre de trace Studio, elle apparaît comme Dynamic Object à des fins d'affichage. Vous pouvez également transmettre ce resultSet tel quel dans l'en-tête et les paramètres si nécessaire.

errorArgList(out)

Les conditions d'erreur ont un objet comme le proxy REST pour la compatibilité. Prend en charge le type DynamicData.

Conditions de branche résultantes

Les conditions de branche de résultat vous permettent de créer des branches dans votre script afin de gérer différents résultats lors de l'exécution d'une action.

Condition

Description
Throttle

Chemin emprunté lorsque trop de demandes sont exécutées dans un court laps de temps. Voir les limitations ci-dessous pour plus de détails.
InvalidInput

Chemin emprunté si une entrée non valide est trouvée ou qu'une erreur de temporisation se produit. Chaque paramètre est validé lors de la sauvegarde du script.
Failure

Chemin emprunté lorsqu'une erreur ou une exception se produit dans leNICE CXoneapplication exécuter la demande.
Error

Chemin emprunté lorsque le point de terminaison du client distant renvoie un code d'erreur http.
Default

Chemin emprunté lorsque la réponse n'est pas reçue dans les 90 secondes.
Success

Chemin emprunté si l’action se termine sans erreur et si tous les appels d’API ou retours de données ont abouti (codes de réponse 2xx).

Other Options

Vous pouvez remplacer les demandes d’API RESTful externes actuellement terminées dans l’action Snippet.