Rest Api Action

Icono de acción de Rest Api

Maneja llamadas API RESTful de forma asincrónica para manejar mejor cargas altas. Esta acción permite que el sistema gestione cargas más altas, ya que no requiere un hilo de bloqueo (actualmente, las llamadas a la acción REST API se ejecutan utilizando una acción Snippet, que requiere un hilo de bloqueo). La acción devuelve tanto el cuerpo como los encabezados de la llamada a la API. Esto facilita la prueba y depuración de scripts.

Se agregaron encabezados de respuesta a la declaración a partir del CXone Lanzamiento de otoño de 2022. Para ver el encabezado de respuesta, debe guardar todos los scripts que contienen la acción de la API REST para que la acción del fragmento incorpore el cambio.

Propiedades

Propiedad Detalles
Verb

Admite acciones de REST básicas como GET, PUT, POST, DELETE y PATCH.

Parameters

Admite la capacidad de especificar parámetros de consulta o publicar cualquier dato. Cualquier tipo de JSON: Jobject, Jarray, Jtoken debería ser aceptable. Actualmente, la acción requiere que JSON se proporcione en una sola línea. Sustitución de variables de una cadena que contiene JSON o convertir el tipo de datos dinámicos a JSON usando el método asjson() está apoyado. También puede transferir a esta propiedad la variable de salida resultSet(out) de una acción anterior REST API.

Headers

Admite la capacidad de agregar encabezados personalizados para permitir la autenticación del cliente (como tokens de portador). Se aceptan pares de valores clave expresados en formato JSON. Esta acción requiere que JSON se proporcione en una sola línea. Sustitución de variable de una cadena que contiene JSON o conversión de tipo de datos dinámicos a JSON utilizando el .asjson () se admite el método. También puede pasar la variable de salida resultSet(out) de una acción previa REST API a esta propiedad.

Importante Si su punto final de URL personalizado requiere encabezados diferentes, debe especificarse en esta propiedad. Para mantener la paridad de características con la acción Snippet existente, CXone agrega los siguientes encabezados.

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

Command

La única opción es MakeRestRequest, que funciona igual que cuando se usa en una acción Snippet. Los desarrollos futuros pueden ofrecer otros comandos que proporciona la acción Snippet.

TimeOutInMilliSeconds

Permite especificar y respetar un tiempo de espera de la llamada REST. Debe ser menos de 90 segundos (90000 milisegundos).

Service Address

Permite que se proporcione una URL personalizada, incluida la capacidad de especificar parámetros de consulta para un GET. También se admite la sustitución de variables.

Variables de salida

Variable Detalles
resultSet(out)

Respuesta del punto final proporcionado por su organización en la dirección de servicio. En lal ventana de rastreo Studio aparece como Dynamic Object con fines de visualización. También puede transferir este resultSet como está en el encabezado y los parámetros de ser necesario.

errorArgList(out)

Las condiciones de error tienen un objeto como el proxy REST para compatibilidad. Admite el tipo DynamicData.

Ramas

Rama Detalles
OnThrottle

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.

OnInvalidInput

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.

OnFailure

Camino tomado cuando ocurre algún error o excepción dentro del NICE CXoneAplicaciónejecutando la solicitud.

OnError

Ruta tomada cuando el punto final del cliente remoto devuelve un código de error http.

Default

Camino tomado cuando la respuesta no se recibe dentro de los 90 segundos.

Limitaciones

Se imponen limitaciones en el nivel de unidad de negocioClosed Agrupación organizativa de alto nivel utilizado para administrar el soporte técnico, facturación y configuración global para su CXone entorno para que uno no impacte al otro. A continuación se muestran las limitaciones dentro delPlataforma:

  • Formato de respuesta: Solo se admite el formato de respuesta JSON.
  • Reintentos en caso de falla: El gestionador de acciones intentará automáticamente dos veces si se recibe una falla antes de regresar la respuesta. Se puede volver a intentar cualquier código de estado HTTP que no sea 2xx.
  • Tiempo en espera: Usted especifica el valor de tiempo de espera en la solicitud. El valor no puede ser superior a 90 segundos.
  • Tamaño máximo de respuesta: El tamaño máximo de respuesta es de 32 KB. Esto está en consonancia con la funcionalidad Snippet existente.
  • Límite de aceleración: El límite de aceleración está definido por 2 parámetros:
    • Solicitudes simultáneas máximas:°De forma predeterminada, se permiten hasta 100 solicitudes simultáneas. Este límite es el mismo para todos los clientes de CXone, y es el mismo que la funcionalidad Snippet existente. Sin embargo, esta acción produce llamadas asincrónicas. Esto implica que 100 solicitudes simultáneas dan como resultado un rendimiento mucho mayor que el de la funcionalidad Snippet existente. Si necesita más de 100 solicitudes simultáneas, hable con su Representante de cuenta CXone acerca de aumentar el límite para suunidad de negocio. Se requieren aprobaciones especiales.
    • Conteo en cola: Cuando las solicitudes exceden el límite, las solicitudes adicionales ingresan a una cola de procesamiento. Una vez que las solicitudes caen por debajo del límite, se procesan las solicitudes en cola. El sistema pone en cola hasta 5.000 solicitudes.
  • Cortacircuitos: Si su URL especificada está inactiva o no se puede ingresar a ella, puede obtener varias fallas en su solicitud. CXone retrocederá (es decir, reducirá) la ejecución de la solicitud durante un período de tiempo. Esto permite que su URL especificada se recupere del error. Los límites se identifican a continuación.
    • Tiempo de retroceso o Duración del descanso: Si se alcanza la tasa de fallas, no se ejecutarán sus solicitudes durante 30 segundos.
    • Rendimiento mínimo: 100 solicitudes por segundo. Si su unidad de negocio no está ejecutando la cantidad mínima de solicitudes, continuará ejecutando sus solicitudes aunque las solicitudes estén fallando.
    • Tasa de fallas: Si fallaron el 50% de las solicitudes durante 30 segundos, no se ejecutarán sus solicitudes durante los siguientes 30 segundos. 30 segundos es una ventana rodante.

Otras opciones

Puede reemplazar las solicitudes API RESTful externas que actualmente están finalizadas en la acción Snippet.