Rest Api

Maneja de manera sincrónica las llamadas de la API RESTful. Esta acción permite que el sistema maneje cargas más altas. Devuelve tanto el cuerpo como los encabezados de la Llamada a la API. Esto facilita la prueba y depuración de scripts. Esta acción es uno de los métodos admitidos para conectarse a servicios web en un script de Studio.

Dependencias

Existen limitaciones en el uso de esta acción que se imponen a nivel de unidad de negocio High-level organizational grouping used to manage technical support, billing, and global settings for your NiCE CXone system.. Esto se hace para que una no afecte a la otra. Las limitaciones dentro de la plataforma SOn:

• Formato de respuesta: Solo se admite el formato de respuesta JSON.
• Reintentos en caso de Fallo: el controlador de Acción intentará automáticamente DOs veces si se recibe un mensaje de fallo antes de devolver la respuesta.
• Tiempo en espera: Usted especifica el valor de tiempo DE espera en la solicitud. El valor no puede ser más que 90 segundos.
• Tamaño máximo de Respuesta: El tamaño máximo de respuesta es de 32 KB. Esto es consistente con la funcionalidad existente de Snippet. Si está alcanzando este límite, debe reducir el tamaño de los datos devueltos.
• Throttle Limit: The throttle limit is defined by two parameters:
  • Solicitudes simultáneas máximas: Se permiten hasta 100 solicitudes simultáneas de forma predeterminada. Este límite es el mismo para todos los clientes NiCE CXone. Esto significa que 100 solicitudes simultáneas dan como resultado un rendimiento mucho mayor que realizar llamadas a la Snippet API desde una acción Snippet. Si necesita más de 100 solicitudes simultáneas, comuníquese con su representante de cuenta para solicitar un aumento del límite para su unidad de negocio. Se requieren aprobaciones especiales.
  • En cola Recuento: Cuando las solicitudes superan el límite, las solicitudes adicionales entran en una Cola de procesamiento. Una vez que las solicitudes caen por debajo del límite, se procesan las solicitudes en cola.
• Circuit Breaker: If your specified URL is down or unreachable, you can get too many failures on your request. When this happens, NiCE CXone will reduce request execution of ALL URLs from the REST API action for a period of time. This allows your specified URL to recover from the failure. Limits are identified below:
  • Rendimiento mínimo: 100 solicitudes en 30 segundos. Una vez que se alcanza este umbral, se considera la tasa de fallos. Si su unidad de negocio no está ejecutando el número mínimo de solicitudes, continuará ejecutando solicitudes aunque estén fallando.
  • Tasa de fallo: Cuando se alcanza el umbral mínimo de rendimiento, si al menos el 50% de las solicitudes fallaron durante 30 segundos, se activa el tiempo DE espera. Los 30 segundos es una ventana rodante.
  • Tiempo DE espera o duración de la pausa: Si se alcanzan el rendimiento mínimo y la tasa de fallos, no se ejecutará ninguna solicitud de la acción REST API durante 30 segundos.

Otras dependencias de esta acción SOn:

• JSON es el único formato de respuesta soportado. La acción demanda que todos los JSON estén en una sola fila. Al trabajar con JSON en esta acción, puede:

  • Haga una sustitución de variables a partir de una cadena de caracteres que contenga JSON.
  • Convertir un objeto de datos dinámicos a JSON se admite mediante la función asjson(). Tenga en cuenta que asjson() trata todo como una cadena, lo que significa que se requiere cierta manipulación cuando se trabaja con valores booleanos o numéricos.
  • Pase la variable de salida resultSet(out) de una acción anterior de la API REST a esta propiedad también.
• Las repuestas se devuelven como objetos jtoken. objetos de datos dinámicos en su script.
• Las respuestas contienen encabezados y el cuerpo de la respuesta. También pueden contener códigos de estado HTTP. No todas las respuestas incluirán códigos de estado. Si no hay ningún error, si la acción REST API no logra generar una respuesta Válida, o si el error devuelto no puede analizarse como una respuesta Válida, no se incluye ningún estado.
• Las respuestas contienen encabezados y el cuerpo de la respuesta. También incluyen códigos de estado HTTP en DOs variables, __httpstatuscode y __httpstatusdescription. Estas se rellenan con información devuelta desde el servidor.Sin embargo, no se rellenan si hay un error, tiempo límite, desbordamiento, circuito abierto u otra situación en que el servidor no devuelva una respuesta.
• Puede usar más de una acción REST API en un script, pero ambas no pueden hacer referencia a los mismos objetos.

Entrada Propiedades

Estas propiedades definen los datos que utiliza la acción al ejecutarse.

Propiedad	Descripción
Caption	Introduzca una frase corta que identifique de forma única esta acción en el script. La leyenda aparece en el lienzo del script debajo del ícono de acción. El valor predeterminado es el nombre de acción.
Verbo	El verbo que desea que use esta acción. Esta propiedad admite acciones REST básicas como GET, PUT, POST, DELETE y PATCH.
Parámetros	Especifique los parámetros a incluir o los datos a publicar como un objeto JSON de pares clave-valor. Se pueden aceptar muchos tipos de JSON, como Jobject , Jarray o Jtoken.
Encabezados	Le permite agregar encabezados personalizados para permitir la autenticación del cliente, como tokens de portador. Puede utilizar JSON en este campo. Importante Si su punto final de URL personalizado requiere encabezados diferentes, debe especificarse en esta propiedad. Para mantener la paridad de funciones con la acción Snippet existente, NiCE CXone agrega los siguientes encabezados de forma predeterminada: {"Accept":"application/json", "Content-Type" :"application/x-www-form-urlencoded"}
Comando	Actualmente, la única opción es MakeRestRequest. Esta funciona de la misma manera que la función MakeRestRequest() que se usa cuando se realiza una Llamada a la API de REST en una acción Snippet.
TimeOutInMilliSeconds	Permite especificar y respetar un tiempo DE espera de la llamada REST. Debe ser menos de 90 segundos (90000 milisegundos). Si no se especifica ningún tiempo límite, el valor predeterminado es de 10 segundos (10000 milisegundos).
Dirección de servicio	El URL de la API REST que desee que llame la acción. Puede usar la sustitución de variables con esta propiedad. Use la propiedad Parámetros para especificar los parámetros de consulta que se incluirán.
Tiempo límite	La ruta tomada si no hay respuesta durante la cantidad de segundos especificada en la propiedad Tiempo límite.

Propiedades de salida

Estas propiedades contienen variables que incluyen datos que se evuelven al ejecutar la acción. Están disponibles como referencia y para usarse cuando se completa la acción.

Propiedad	Descripción
resultSet(out)	Una variable que mantiene información devuelta por la API especificada en la dirección del Servicio. De ser necesario, usted puede transferir el contenido de esta variable tal cual es al encabezado y los parámetros. La respuesta se devuelve como un objeto Jtoken, pero puede declararla como un objeto dinámico y trabajar con ella como lo haría con otros objetos dinámicos en su script.
errorArgList (fuera)	Un objeto de datos dinámicos que contiene información sobre cualquier error que ocurra. Cuando ocurre un error, el objeto contiene el código de estado HTTP, la descripción del estado y un mensaje. Cuando no hay ningún error, el objeto está vacío. Los códigos de estado HTTP y las descripciones solo se devuelven en el Error y se pueden analizar correctamente como una respuesta Válida. Esto significa que no todos los errores incluirán un código de respuesta HTTP.

Condiciones de la ramificación de resultado

Las condiciones de las ramas de resultado le permiten crear ramas en su script para manejar diferentes resultados cuando se ejecuta una acción.

Condición	Descripción
Throttle	Ruta tomada cuando se ejecutan demasiadas solicitudes en un período corto de tiempo. Consulte las limitaciones a continuación para obtener más detalles.
InvalidInput	Ruta tomada si se encuentra una entrada no válida o se produce un error de tiempo de espera. Cada parámetro se valida cuando se guarda el script.
Fallo	Ruta tomada cuando ocurre algún error o exception dentro de la aplicación NiCE CXone que ejecuta la solicitud.
Error	Ruta tomada cuando el punto final del cliente remoto devuelve un código de error http.
Por defecto	Camino tomado cuando la respuesta no se recibe dentro de los 90 segundos.
Éxito	Ruta que se toma si la acción finaliza sin errores y cualquier llamada API o devolución de datos se realiza correctamente (códigos de respuesta 2xx).