Integration Hub

Integration Hub proporciona un lugar central para gestionar integraciones con sistemas y servicios externos. Le permite crear conexiones RESTAPICerrado Interfaz de programación de la aplicación. Permite automatizar determinadas funciones conectando su sistema CXone Mpower con otro software. estandarizadas, que puede usar en múltiples scripts Studio. Esto evita la necesidad de crear repetidamente las mismas solicitudes cada vez que desee comunicarse externamente a través de API. En lugar de ello, puedes crear la solicitud una vez en Integration Huby ​​luego reutilizarla donde sea necesaria. Esto simplifica y acelera el proceso de creación de scripts.

Integration Hub también hace que sus integraciones sean más seguras. Cifra las credenciales de la API, por lo que cada vez que las usa, no quedan expuestas en el script. Los scriptsStudio se almacenan como texto sin formato, por lo tanto, no es posible almacenar de forma segura credenciales importantes como variables directamente en el script, como tokens utilizados para solicitudes de API. Integration Hub le permite agregar rápidamente una solicitud de autenticación a un script y luego usar de forma segura las credenciales recuperadas en llamadas API posteriores. También puede agregar certificados mTLS a una solicitud de API.

Integration Hub es parte de Automatización e IA aplicación en CXone Mpower. Si tiene el permiso Iniciar automatización e IA, puede abrir aplicación desde CXone Mpower en una nueva ventana y hacer clic en Integration Hub.

Conexiones

Conexiones definen los detalles para la integración con un servicio externo, como solicitudes de API, flujos de autenticación y variables. Por ejemplo, podría crear una plantilla de conexión para Salesforce. Esto definiría los detalles básicos necesarios para conectarse con Salesforce, como el tipo de autenticación y los métodos admitidos. A partir de esta plantilla, creará una conexión que le permitirá completar detalles específicos de la plantilla, junto con detalles más específicos, como las solicitudes de API específicas que desea realizar a Salesforce.

Plantillas de conexión

Cada conexión que usted añade a Integration Hub, se crea con base en la plantilla de conexiones. Las plantillas definen la información básica que aplica a todas las conexiones que se harán con la plantilla. Esto incluye lo siguiente:

  • El nombre del servicio web al que se está conectando.
  • El método de integración. Actualmente, la API REST es el único método compatible.
  • El tipo de autenticación, de haberlo. Actualmente, puede elegir OAuth 2.0 o sin autenticación.
  • Los encabezados personalizados para autenticación, de requerirse alguno.
  • Los verbos disponibles para su uso con las solicitudes que se hacen con base en la plantilla. Los verbos son las acciones que se pueden realizar con el servicio web conectado, como recuperar datos (GET) o crear registros (POST).

Una conexión no tiene que incluir todos los tipos de información de conexión. Puede contener cualquier conexión de los tipos de información compatibles.

Todas las plantillas de conexión están disponibles en la biblioteca de conexiones en Integration Hub. Las Plantillas que puedes usar en un script Studio se enumeran bajo Mis Conexiones en Integration Hub. Puede crear un máximo de 50 Conexiones (en la lista Mis Conexiones). No hay límite en la cantidad de plantillas en la biblioteca de conexiones.

No se pueden modificar todas las plantillas. Sin embargo, las plantillas personalizadas sí pueden eliminarse. Si posteriormente requiere cambiar algo en una plantilla personalizada, puede eliminar la plantilla y crear una nueva. Las conexiones sí pueden modificarse. Eliminar una plantilla personalizada no afecta las conexiones que se crean con dicha plantilla.

Plantillas del sistema

Integration Hub tiene dos tipos de plantillas: las plantillas del sistema, que son propiedad de NiCE, y las plantillas que crea usted mismo. Las plantillas del sistema vienen con Integration Hub y no se pueden eliminar. Actualmente, Integration Hub incluye una plantilla de sistema:

  • CXone Mpower Portal para desarrolladores: se integra con los puntos finales de API documentados en el CXone Mpower Portal para desarrolladores . Esto es para reducir su dependencia de las Studio acciones del marco. Usa la autenticación OAuth 2.0. Para determinar la autenticación, usa Discovery URL. No admite certificados de cliente.

Solicitudes

Las solicitudes son llamadas a la API. Para cada Conexión en la lista Mis Conexiones, puede agregar solicitudes que desee utilizar con el servicio externo específico. Estas solicitudes especifican la siguiente información, que se utiliza para conectarse a un servicio web:

  • URL: La ubicación de la fuente a la que usted se está conectando.
  • Método (Verbo): La acción que desea que realice la solicitud, como recuperar datos o crear un nuevo registro. Integration Hub respalda a estos verbos: OBTENER, PONER, PUBLICAR, ELIMINAR, RASTREAR, REPARAR, ENCABEZADO, OPCIONES. Los verbos disponibles para su uso en una conexión se definen en la plantilla que se usa para crear la conexión.
  • Encabezados: Una parte de la solicitud que contiene información adicional sobre la solicitud. Esto puede incluir el idioma, las credenciales, etc.
  • Parámetros de consulta: una forma de pasar información con una solicitud de API en la URL del punto final. Se configuran como pares de clave-valor. Se pueden usar para filtrar, organizar, personalizar o controlar los datos que se devuelven en la respuesta.
  • Cuerpo: El contenido de la solicitud. El formato depende de los requisitos de la API a la que se está conectando. El tipo de medio del cuerpo debe coincidir con lo que espera el recurso al que usted se está conectando. 'También conocido como el tipo MIME o tipo de contenido. Estas son las opciones admitidas y los encabezados de contenido asociados: 
    • ApplicationJson: aplicación/json
    • ApplicationJsonPatch: aplicación/parche json + json
    • FormURLEncoded: application/x-www-form-urlencoded
    • TextHtml: texto/html
    • TextPlain: texto/sin formato
    • TextXml: texto/xml
    • Sigv4: aplicación/x-amz-json-1.1

Cada conexión Integration Hub puede tener hasta 50 solicitudes. No hay restricción sobre el número de solicitudes que pueden estar activas a la vez.

CXone Mpower tiene un límite de 32 KB  sobre el tamaño de las respuestas. Use los parámetros de la consulta para filtrar los datos devueltos. Esto le puede ayudar a mantenerse dentro de dicho límite.

Manual y Solicitudes de Studio

Integration Hub respalda dos opciones para las solicitudes en las conexiones:

  • Manual: Se construye una solicitud manual en Integration Hub usando las opciones de la página Añadir Solicitud. Puede usar secretos en ellas. Las solicitudes manuales se usan normalmente en casos donde no cambian los datos. Se pueden ejecutar directamente desde Integration Hub sin requerir de un script Studio. También se pueden ejecutar en Studio los scripts.
  • Studio: En algunos casos, las solicitudes de las API no se pueden construir como solicitudes manuales en Integration Hub. Por ejemplo, las solicitudes que requieren parámetros de ruta, la sustitución de variables o que se conectan a los servicios web SOAP deben construirse en un Studio script. Sin embargo, quizá desee dar seguimiento a estas solicitudes en sus conexiones Integration Hub. La solicitud Studio le permite hacer eso. Una solicitud Studio aparece en una pestaña de Solicitudes de la conexión junto con todas las solicitudes manuales que tiene la conexión.

Variables

Integration Hub permite almacenar pares de valores como variables. Las Variables no están cifradas de manera predeterminada. Sin embargo, puede cifrar una variable convirtiéndola en secreta. Marcar una variable como secreta agrega seguridad a la información confidencial, como contraseñas o claves.

Se pueden usar las variables en la conexión donde las creó. Si ejecuta una conexión o una solicitud de autenticación en un script Studio, puede usar variables desde esa conexión en el script.

Los secretos se cifran en reposo en una base de datos cifrada. Integration Hub usa el Estándar de Codificación Avanzado (AES) para codificar los datos. La única vez en que se codifican los datos es en el momento de la ejecución.

Integration Hub Studio Comportamiento

Cuando desee usar la autenticación o hacer una solicitud en un script Studio, use las siguientes acciones Studio:

Puntos clave sobre las acciones de Integration Hub Studio

  • Requieren Integration Hub. Si no está habilitada Integration Hub en su sistema CXone Mpower, no funcionan las acciones.
  • Puede incluir más de una instancia de cada acción en un script.
  • Puede usar la sustitución de variables para ejecutar diferentes solicitudes o usar la autenticación de más de una conexión en un único script.
  • De igual manera que con otros métodos de hacer llamadas API en CXone Mpower, se requiere de la programación adicional de scripts para recibir la respuesta desde el servicio web conectado y manejarlo adecuadamente.
  • CONNECTAUTH no permite ninguna personalización. Ejecuta la solicitud de autenticación según se define en la conexión en Integration Hub.

Interruptor de seguridad

Integration Hub tiene un disyuntor incorporado. Es una medida de precaución ante llamadas API fallidas. Si el disyuntor detecta que una llamada falla repetidamente, se activa y limita la llamada API. La razón más común de las llamadas fallidas es un error temporal del servidor (errores 500). Limitar (o pausar) la llamada le da tiempo al servidor para volver a funcionar correctamente.

Las siguientes son las características clave del disyuntor:

  • El interruptor de seguridad se activa si más del 50% de las llamadas a una API fallan en 30 segundos.

  • Para activar el interruptor de seguridad, Integration Hub debe haber intentado más de 100 llamadas a una única API en un intervalo de 30 segundos.

  • El interruptor de seguridad se activa durante 30 segundos.

  • Las razones de las fallas están accesibles en los registros Studio trace, capturados en la variable _err.

Historial de auditoría

Cada conexión en Integration Hub tiene un registro de cambios. Cada vez que se crea o actualiza una conexión, se registran los siguientes detalles:

  • Fecha:: La fecha en que se realizó el cambio.

  • Modificado por: Quién realizó el cambio.

  • Nombre de perfil: El nombre de la conexión.

  • Acción: Qué ocurrió, como si se creó o modificó una conexión.

Los usuarios podrán acceder a este registro desde un nuevo botón Auditoría en la configuración de la conexión.