Integration Hub

Integration Hub ofrece un modo estandarizado de manejar la integración de CXone con la autenticación y servicios web de terceros. Los servicios web pueden ser aplicaciones, plataformas o sistemas.

Integration Hub es una de las formas en las que puede trabajar con llamadas de la API REST en CXone. El beneficio de usar Integration Hub es que puede añadir la conexión y usarla en múltiples lugares. Otros métodos requieren establecer una conexión cada vez que desee usarla.

Además, puede almacenar los datos que requieren una mayor seguridad en Integration Hub. Se codifican los datos que se agregan como secretos y no se puede ingresar a ellos directamente.

Conexiones y Plantillas de Conexiones

Las conexiones definen los detalles de las solicitudes de la API, los detalles de autenticación y los secretos que desee usar en CXone.  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.

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 adoptar con el servicio web conectado, como recuperar datos o crear registros.

No pueden modificarse las plantillas de conexión después de crearlas. Si posteriormente requiere cambiar algo en una plantilla, debe eliminar la plantilla y crear una nueva. Sin embargo, se pueden modificar las conexiones en sí mismas. Eliminar una plantilla no afecta las conexiones que se crean con dicha plantilla.

Las plantillas están disponibles en la biblioteca de conexiones en Integration Hub. Las conexiones se listan en Mis Conexiones en Integration Hub. Usted puede crear un máximo de 50 conexiones. No hay límite sobre el número de plantillas.

Solicitudes

Las solicitudes son llamadas a la API. Especifican la siguiente información, que se usa para conectar 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 la consulta: Una forma de transferir información con una solicitud de la API. 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. La siguiente lista muestra las opciones compatibles con el encabezado del contenido que se usa en cada:
  • ApplicationJson:  application/json
  • ApplicationJsonPatch: application/json-patch+json
  • FormURLEncoded:  application/x-www-form-urlencoded
  • TextHtml:  text/html
  • TextPlain:  text/plain
  • TextXml:  text/xml

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 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.

Secretos

Integration Hub le permite almacenar como secretos la información sensible. Puede usarlos para cualquier información que requiera de seguridad adicional, como contraseñas o claves.

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

Los secretos se codifican en espera. Integration Hub usa el Estándar de Codificación Avanzado (AES) para codificar los datos. Se almacena en una base de datos codificada. 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:

• CONNECTAUTH: Esta acción le permite incluir los detalles de la autenticación o los secretos en su script. Los detalles y los secretos de la autenticación deben definirse en una conexión de Integration Hub.
• CONNECTREQUEST: Esta acción les permite usar una solicitud que se define en una conexión Integration Hub. Se requiere esta acción para usar solicitudes manuales y solicitudes de Studio.

Factores clave sobre usar estas acciones:

• Requieren Integration Hub. Si no está habilitada Integration Hub en su sistema CXone, 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, 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.