Integration Hub proporciona un lugar centralizado para gestionar las integraciones con sistemas y servicios externos. Le permite crear conexiones de API
Interfaz de programación de aplicaciones. Le permite automatizar ciertas funcionalidades al conectar su sistema NiCE CXone con otro 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 la API. En su lugar, puede crear la solicitud una vez en Integration Hub y luego reutilizarla donde la necesite. 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, de manera 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 que se utilizan para las solicitudes de API. Integration Hub le permite agregar rápidamente una solicitud de autenticación a un script y, luego, utilizar de forma segura las credenciales recuperadas en las siguientes Llamadas a la API. También puede agregar certificados mTLS a una solicitud de API.
Integration Hub es parte de la aplicación de Automatización & AI en NiCE CXone. Si cuenta con el permiso de Iniciar Automatización & AI, puede abrir la aplicación desde NiCE CXone en una ventana nueva y hacer clic en Integration Hub.
Conexiones
Las conexiones definen los detalles para integrarse 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í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 conexiones
Cada conexión que agrega a Integration Hub se crea con base en 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.
Todas las plantillas de Conexiones están disponibles en la biblioteca de conexiones en Integration Hub. Las Plantillas que puede usar 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.
Todas las plantillas no se pueden modificar. 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 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: las plantillas del sistema propiedad de NiCE, y las 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 Portal para desarrolladores: Se integra con los puntos de conexión de API documentados en el NiCE CXone portal para desarrolladores
. Esto es para reducir su dependencia de 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.
Solicitudes
Las solicitudes son Llamadas a la API. Para cada conexión en la lista mis Conexiones, puede agregar solicitudes que desee usar 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.
- Headers: A part of the request that contains additional information about the request. This can include the language, credentials, and so on.
- 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 utilizar 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.
NiCE CXone tiene un límite de 32 KB en el tamaño de las respuestas. Utilice parámetros de consulta para filtrar los datos devueltos.Esto le puede ayudar a mantenerse dentro de dicho límite.
Manual, Studio y Solicitudes Híbridas
Integration Hub admite tres opciones para solicitudes en conexiones:
- Manual: Una solicitud manual se crea en Integration Hub utilizando 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 requerir un script de Studio. También se pueden ejecutar 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. Sin embargo, es posible que desee mantener un registro 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 mientras 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 su solicitud es constante en todas las ejecuciones, pero uno o más valores deben cambiar dinámicamente. 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 Studio script.
-
Desea tener la comodidad de configurar y visualizar valores predeterminados en Integration Hub, mientras conserva la capacidad de anularlos de forma programática.
-
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:
| 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 UI 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 hay campos obligatorios; los valores se pueden proporcionar en tiempo de ejecución |
|
Botón prueba |
Disponible |
No está disponible |
No está disponible |
|
Comportamiento de anulación |
N/A |
N/A |
Los valores Dinámicos anulan a 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 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) para encriptar los datos. La única vez 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:
Datos 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 variables para ejecutar diferentes solicitudes o usar la autenticación de más de una conexión en un solo script.
- Tal como ocurre 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 de forma adecuada.
-
Interruptor de Circuito
Integration Hub tiene un disruptor de circuito integrado. Es un mecanismo de seguridad preventivo para las Llamadas a la API fallidas. Si el disruptor de circuito detecta que una llamada falla repetidamente, se activa y regula la Llamada a la API. El motivo más común de las llamadas fallidas es un error en el servidor temporal (errores 500). Regular (o pausar) la llamada le da tiempo al servidor para volver a funcionar correctamente.
A continuación se presentan las características clave del disyuntor:
-
El interruptor de circuito se activa si más que el 50% de las llamadas a la API fallan dentro de los 30 segundos.
-
Para activar el disyuntor, Integration Hub debe haber intentado más de 100 llamadas a una sola API dentro de una ventana de 30 segundos.
-
El interruptor se activa durante 30 segundos.
-
Las razones de fallo se pueden consultar en los Studio registros de 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 hizo 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.
