Integration Hub

Integration Hub proporciona un lugar centralizado para gestionar las integraciones con sistemas y servicios externos. Le permite crear conexiones API Application Programming Interface. Allows you to automate certain functionality by connecting your NiCE CXone system with other software. REST estandarizadas, que puede utilizar en múltiples Scripts de Studio. Esto evita la necesidad de crear repetidamente las mismas solicitudes cada vez que desea comunicarse externamente a través de API. En su lugar, puede crear la solicitud una vez en Integration Hub y luego reutilizarla donde la necesite. Esto simplifica y agiliza el proceso de creación de Scripts.

Integration Hub también hace que sus integraciones sean más seguras. Cifra las credenciales de API, de modo que cada vez que las utiliza, no quedan expuestas en el script. Los scripts de Studio se almacenan como texto sin formato, por lo tanto, no puede almacenar de forma segura credenciales importantes como variables directamente en el script, como los tokens utilizados para las 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 las llamadas de API posteriores. También puede agregar certificados mTLS a una solicitud de API.

Puede encontrar Integration Hub en la aplicación Connections Hub en NiCE CXone. Debe contar con el Launch Connections Hub permission para acceder a ella.

Conexiones

Las conexiones definen los detalles para la integración con un servicio externo, como las solicitudes de API, los flujos de autenticación y las 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ía una conexión, que le permite 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 agregue a Integration Hub se crea a partir de una plantilla de conexión. Las Plantillas definen la información básica que aplica a todas las conexiones que se realizarán con la Plantilla. Esto incluye:

• El nombre del servicio web al que se está conectando.
• El método de integración. Actualmente, REST API es el único método admitido.
• El tipo de autenticación, si corresponde. 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 combinación de los tipos de información admitidos.

Integration Hub viene con cinco plantillas del sistema predeterminadas. Estas plantillas le permiten crear conexiones a varios servicios web, incluidas las API de NiCE CXone y cuatro CRM Third-party systems that manage such things as contacts, sales information, support details, and case histories. populares.

Las plantillas de conexión predeterminadas y cualquier plantilla personalizada que usted cree están disponibles en la biblioteca de Conexiones en Integration Hub. Las plantillas que puede utilizar en un script de Studio se enumeran en 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.

Las plantillas no se pueden modificar. Sin embargo, puede eliminar sus plantillas personalizadas. Si posteriormente requiere cambiar algo en una plantilla personalizada, puede eliminar la plantilla y crear una nueva. Las Conexiones en sí pueden modificarse. borrar una plantilla personalizada no afecta las conexiones creadas con esa plantilla.

Plantillas del sistema

Integration Hub tiene DOs tipos DE plantillas: plantillas del sistema pertenecientes a NiCE, y plantillas que usted mismo crea. Las plantillas del Sistema vienen con Integration Hub y no se pueden eliminar. Actualmente, Integration Hub incluye una plantilla del sistema:

• NiCE CXone Developer Portal: Proporciona acceso directo y flexible a las llamadas de DEVone en el NiCE CXone Developer Portal. Para usar esta plantilla, su aplicación de integración debe estar registrada con NiCE. Studio Acciones de Framework. Usa la autenticación OAuth 2.0. Para determinar la autenticación, utiliza la URL de descubrimiento. No admite certificados de cliente.
• Microsoft Dynamics 365: Le permite conectarse a las API REST de Dynamics 365.
• Salesforce: Permite conectarse a las API REST de Salesforce.
• ServiceNow: Permite conectarse a las API de REST de ServiceNow.
• Zendesk: Le permite conectarse a las API REST de Zendesk.

Las plantillas del sistema están configuradas para usar autenticación OAuth 2.0. Admiten los métodos GET, PUT, POST, DELETE y PATCH. no tienen ningún encabezado definido de forma predeterminada, por lo que debe agregar los encabezados requeridos en las conexiones que cree con las plantillas.

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 admite estos verbos: GET, PUT, POST, DELETE, TRACE, PATCH, HEAD, OPTIONS. Los verbos disponibles para su uso en una conexión se definen en la plantilla que se usa para crear la conexión.
• Encabezados: 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 transmitir información con una solicitud de API en la URL DE terminal. Se configuran como pares clave-valor. Se pueden usar para filtrar, ordenar, personalizar o controlar los datos devueltos en la respuesta.
• Body: The content of the request. The format depends on the requirements of the API you're connecting to. The media type of the body must match what the resource you're connecting to expects. It's also known as the MIME type or content type. These are the supported options and the associated content headers: 
  • ApplicationJson: application/json
  • ApplicationJsonPatch: application/json-patch+json
  • FormURLEncoded: application/x-www-form-urlencoded
  • TextHtml: text/html
  • TextPlain: text/plain
  • TextXml: text/xml
  • Sigv4: application/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.

Manual, Studio y Solicitudes híbridas

Integration Hub admite tres opciones para solicitudes en conexiones:

• Manual: Una solicitud manual se crea en Integration Hub mediante las opciones de la página Agregar Solicitud. Puede usar secretos en ellas. Las solicitudes manuales se usan normalmente en casos donde no cambian los datos. Pueden ejecutarse directamente desde Integration Hub sin necesitar un script de Studio. También pueden ejecutarse en Scripts de Studio.

• 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, sustitución de Variable o que se conectan a servicios web SOAP, se deben crear en un Studio script. However, pero es posible que desee hacer seguimiento de estas solicitudes en sus conexiones de 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.

• Híbrido: Una solicitud híbrida combina las capacidades de los tipos de solicitud manual y Studio. Esto le brinda la flexibilidad de preconfigurar los detalles de la solicitud en Integration Hub, al mismo tiempo que permite que cualquiera de esos valores se sobrescriba dinámicamente en tiempo de ejecución. Las solicitudes híbridas SOn ideales cuando:

  • La mayor parte de la configuración de la solicitud es constante entre las ejecuciones, pero uno o más valores deben cambiar de forma dinámica. Por ejemplo, un cuerpo de solicitud que varía según el cliente o un parámetro de consulta que cambia según la entrada de un script de Studio.

  • Desea la comodidad de configurar y visualizar valores predeterminados en Integration Hub, conservando al mismo tiempo la capacidad de anularlos mediante programación.

  • Necesita una única definición de solicitud que pueda servir para múltiples casos de uso sin duplicar la configuración.

La siguiente tabla resume la diferencia entre los tres tipos de solicitud:

Categoría	Manual	Studio	Híbrido
Configuración	Todos los campos definidos en la UI	Todos los campos proporcionados en tiempo de ejecución	Campos definidos en la interfaz de usuario con anulaciones opcionales en tiempo de ejecución
Entrada en tiempo de ejecución	No soportado	Obligatorio	Opcional
Validación de campo	Se requieren la URL y el método HTTP	N/A (validado en tiempo de ejecución)	No se requieren campos; los valores se pueden proporcionar en tiempo de ejecución
Botón de prueba	Disponible	No está disponible	No está disponible
Comportamiento de anulación	N/A	N/A	Los valores dinámicos anulan los valores estáticos

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 solicitud de conexión o autenticación en un script de Studio, puede usar variables de esa conexión en el script.

Los secretos se encriptan en reposo en una base de datos encriptada. Integration Hub utiliza el Estándar de Cifrado Avanzado (AES, por sus siglas en inglés) para encriptar los datos. El único momento en que los datos se desencriptan 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:

• CONNECTAUTH: Esto action le permite incluir detalles de autenticación o secretos en su script. Los detalles de la autenticación y las variables deben definirse en una conexión de Integration Hub.
• CONNECTREQUEST: Esta acción le permite usar una solicitud que está definida en una conexión de Integration Hub. Esta acción es necesaria para usar solicitudes manuales y solicitudes de Studio.

Puntos clave sobre las acciones de Integration Hub Studio

• Requieren Integration Hub. Si no está habilitada Integration Hub en su sistema NiCE CXone, no funcionan las acciones.
• Puede incluir más que una instancia de cada acción en un script.
• Puede usar la sustitución de variable para ejecutar diferentes solicitudes o usar autenticación de más de una conexión en un solo script.
• Al igual que con otros métodos para realizar Llamadas a la API en NiCE CXone, se requiere programación adicional para recibir la respuesta del servicio web conectado y manejarla adecuadamente.
• CONNECTAUTH no permite ninguna personalización. Ejecuta la solicitud de autenticación según se define en la conexión en Integration Hub.

Circuit Breaker

Integration Hub tiene un interruptor de circuito integrado. Es un mecanismo de seguridad preventivo para las Llamadas a la API fallidas. Si el interruptor de circuito detecta que una llamada falla repetidamente, se activa y limita la Llamada a la API. La razón más común de las llamadas fallidas es un error en el servidor temporal (errores 500). Limitar (o pausar) la llamada le da tiempo al servidor para volver a funcionar correctamente.

A continuación, se presentan las características clave del circuit breaker:

• El cortacircuitos se activa si más que el 50% de las llamadas a la API fallan dentro de 30 segundos.

• Para activar el disyuntor, Integration Hub debe haber intentado más de 100 llamadas a una sola API dentro de un período de 30 segundos.

• El interruptor se activa durante 30 segundos.

• Los motivos de fallo SOn accesibles en los registros de Studio seguimiento, 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: Lo que ocurrió, como si se creó o modificó una conexión.

Puede acceder a este registro con el botón Auditoría en la configuración de la conexión.