Configurar conexiones

Integration Hub las conexiones le permiten configurar integraciones con servicios web de terceros para usarlos en CXone Mpower.

Crear una plantilla de conexión

Una plantilla de conexión define la información básica de una integración. Se usan las plantillas para crear conexiones, en las que puede configurar las solicitudes específicas y otra información.

No se pueden modificar las plantillas de conexión después de la creación. Si desea cambiar cualquier detalle, incluyendo los encabezados, debe crear una nueva plantilla.

Captura de pantalla de la página Agregar plantilla en Integration Hub.
  1. En CXone Mpower, haga clic en el selector de aplicaciones y seleccioneAutomatización e IA > Integration Hub.
  2. Haga clic en Agregar plantilla.
  3. En la pestaña de Detalles, ingrese un Nombre para la plantilla.
  4. Ingrese el nombre de la Aplicación a la que se está conectando. Esta podría ser una aplicación, plataforma o servicio web.
  5. Seleccionar REST como el Método de integración. Actualmente, REST es el único método admitido.

  6. Seleccione una opción para el Tipo de Autenticación. Después de realizar una selección, se muestra la pestaña Configuración.

    Opción Detalles
    OAuth 2.0 Un marco estándar abierto que permite a aplicaciones acceder a recursos en nombre de un usuario sin compartir credenciales.
    No Auth Seleccione esta opción si no desea que la plantilla incluya autenticación.
  7. Ingrese una Descripción de la plantilla. Otros usuarios pueden ver cuando seleccionaron esta plantilla desde la biblioteca de conexión.
  8. Adjunte un icono arrastrando y soltando una imagen o haciendo clic en Examinar archivos. Se muestra este icono para esta plantilla en la biblioteca de conexiones para todas las conexiones que se crearon a partir de esta plantilla.
  9. En la pestaña de Configuración, seleccione los métodos (verbos) que desee estén disponibles para su uso con esta plantilla. No todos los servicios web son compatibles con todos los verbos REST.
  10. Si seleccionó un tipo de autenticación, defina cualquier encabezado de autenticación personalizado para esta plantilla:
    1. Haga clic en Agregar encabezado personalizado.
    2. Ingrese el nombre del encabezado en el campo que aparece.
    3. Haga clic en Añadir Encabezado Personalizado para añadir más encabezados personalizados.
    4. Seleccione ¿Necesario? en los encabezados que deban usarse en las conexiones creadas a partir de esta plantilla.
    5. Haga clic en X para eliminar el encabezado.
  11. Revise todas las configuraciones. No puede editar una plantilla después de guardarla.
  12. Realice una de las siguientes acciones:
    • Haga clic en Guardar para añadir la plantilla a la biblioteca de conexiones.
    • Haga clic en Guardar + Mis Conexiones para añadir la plantilla a la biblioteca de conexiones y cree una conexión a partir de ella. Después de que se crea la conexión, puede configurarla agregando los detalles de autenticación, variables, o solicitudes. Su solicitud puede incluir cualquiera o todas estas configuraciones.

Agregar una conexión a la lista Mis Conexiones

Esta sección se aplica si hizo clic en Guardar al crear la plantilla de conexión, no en Guardar + Mis Conexiones. Una conexión solo se puede usar en un script Studio si está en la lista Mis Conexiones.

  1. En CXone Mpower, haga clic en el selector de aplicaciones y seleccioneAutomatización e IA > Integration Hub.

  2. Cree una conexión nueva de una de estas dos maneras:

    • Seleccione una conexión existente de la Biblioteca de conexiones y luego haga clic en + Mi conexión.

    • Copie una plantilla seleccionando una existente en la lista Mis Conexiones y luego haga clic en Icono de dos hojas apiladasCopiar.

  3. En el campo Nombre de mi conexión en la ventana emergente, ingrese un nombre único para la conexión nueva.

  4. Hacer clic en Guardar.

Configure los Detalles de la Autenticación

Puede configurar los detalles de la autenticación en la pestaña de Autenticación en su conexión. Esta pestaña es únicamente visible cuando está habilitada la autenticación el la plantilla que se usa para esta conexión.

  1. En CXone Mpower, haga clic en el selector de aplicaciones y seleccioneAutomatización e IA > Integration Hub.

  2. Haga clic en la conexión con la que desee trabajar desde Mis Conexiones del lado izquierdo de la página.

  3. Haga clic en la pestaña Autenticación.

  4. Ingrese la URL utilizada para la solicitud de autenticación. La URL no puede ser dinámica, pero puede hacer referencias a secretos en ella.

  5. Seleccione el Método (verbo) REST que se usa en la solicitud de autenticación. Los verbos disponible se definen mediante la plantilla que se usa en esta conexión.

  6. En Encabezados, ingrese el valor adecuado en cada campo. Se requieren los campos marcados con un asterisco ( * ). Estos campos se definen mediante la plantilla que se usa para esta conexión.

  7. Para agregar un encabezado personalizado para esta conexión:

    1. Haga clic en Agregar Encabezado Personalizado.

    2. Ingresa un Nombre de Encabezado y Valor del Encabezado.

  8. Agregue un parámetro de consulta a la solicitud de autenticación:
    1. Haga clic en Añadir Parámetro de Consulta.
    2. Por cada parámetro de consulta que añada, ingrese un Nombre de Parámetro de Consulta y un Valor de Parámetro de Consulta.

  9. Seleccione un Tipo de Medio e ingrese el contenido del Cuerpo. El tipo de medio afecta el formato del contenido del cuerpo. Debe coincidir con el tipo requerido por el servidor de autorización que está utilizando.

    Opción Detalles
    AWS Sigv4 Se utiliza para la autenticación con AWS. Esto actualiza el encabezado Content-Type del tipo x-amz-json-1.1, que es una estructura JSON específica que AWS espera.

    ApplicationJson

    El contenido del cuerpo debe estar en JSON.
    ApplicationJsonPatch El contenido del cuerpo debe estar en formato JSON Patch.
    FormURLEncoded

    El contenido del cuerpo debe estar en pares clave-valor. Este tipo de medio envía solicitudes utilizando notaciones de URL comunes.

    Haga clic en +Agregar Parámetro del Formulario, luego ingrese el Nombre del Parámetro del Formulario y el Valor del Parámetro del Formulario.
    TextHtml El contenido del cuerpo debe estar en HTML.
    TextPlain El contenido del cuerpo debe estar en texto sin formato.
    TextXml El contenido del cuerpo debe estar en XML.

  10. Hacer clic en Guardar.

Configure un certificado autofirmado mTLS

Puede usar la pestaña Configuración de una conexión para configurar los ajustes del tiempo límite y un certificado autofirmado mTLS.

  1. En CXone Mpower, haga clic en el selector de aplicaciones y seleccioneAutomatización e IA > Integration Hub.

  2. Haga clic en la conexión con la que desee trabajar desde Mis Conexiones del lado izquierdo de la página.

  3. Haga clic en la pestaña Configuración .

  4. Ajuste la configuración del Tiempo límite (MS) según sea necesario. El tiempo fuera aplica a todas las solicitudes que se configuran en la conexión, lo que incluye la autenticación. Si está usando un certificado autoasignado de mTLS, llene los siguientes campos:

    • Certificado del Cliente
    • Clave privada del cliente
    • Contraseña

    Estos campos solo aparecen si utiliza OAuth 2.0 como tipo de autenticación. Debería ingresar juntos el Certificado del Cliente y la Clave Privada de Cliente. Si está codificada su Clave Privada de Cliente, debe ingresar una Contraseña. Los certificados mTLS solo funcionan si su URL de autenticación está en HTTPS. La validación de estos campos se produce después de guardar la conexión. Puede hacer referencia a estos campos en la pestaña Secretos.

  5. Hacer clic en Guardar.

Agregar variables a una conexión

Las variables de Integration Hub permiten compartir cierta información en una conexión. Puede determinar si esta información está cifrada o no. Una variable cifrada o un secreto proporciona una capa adicional de seguridad al usar información confidencial como las contraseñas en los scripts de Studio.

Cuando crea una variable, puede convertirla en secreto en cualquier momento. Una vez que una variable se convierte en secreto y se ha guardado el conector, el secreto no se puede volver a convertir en variable.

Los secretos no son reversibles. Cuando hace clic desde el campo de Valor Secreto, se codifica el contenido y se reemplaza con los asteriscos de enmascaramiento ( * ). No hay manera de recuperar el valor que ingresó en el campo después de enmascararlo.

  1. En CXone Mpower, haga clic en el selector de aplicaciones y seleccioneAutomatización e IA > Integration Hub.

  2. Haga clic en la conexión con la que desee trabajar desde Mis Conexiones del lado izquierdo de la página.

  3. En la pestaña de Variable, haga clic en + Agregar variable.

  4. Ingrese un Nombre de variable que identifique qué contiene la variable. Los nombres pueden contener espacios o caracteres especiales.

  5. Ingrese el Valor de la variable. Este es el valor de la variable y la información que será cifrará si hace la variable en un secreto. Compruebe que la información es correcta antes de activarla como secreto.

  6. Para cifrar la variable, active el conmutador Secreto. Recuerde que si habilita esta opción no podrá revertirla.

  7. Para eliminar una variable de la conexión, haga clic en la X situada a la derecha.

  8. Hacer clic en Guardar.

Usar variables en una conexión

Puede usar variables en solicitudes manuales o script de Studio. Puede utilizarlas en encabezados, parámetros de consulta y contenido del cuerpo.

Use una variable en los Detalles de la autenticación o en una Solicitud manual

  1. En CXone Mpower, haga clic en el selector de aplicaciones y seleccioneAutomatización e IA > Integration Hub.

  2. Haga clic en la conexión con la que desee trabajar desde Mis Conexiones del lado izquierdo de la página.

  3. Haga clic en la pestaña donde desee usar una variable. Se pueden usar las variables en las pestañas de Autenticación y Solicitudes.

  4. Ingrese la variable en el lugar donde desee que esté el valor de la variable, siguiendo estas pautas:

    • Ponga el nombre en corchetes dobles. Por ejemplo, [[ variableName ]].
    • Utilice el nombre tal y como se ingresó en el campo Nombre de variable en la pestaña de Variables.
    • Las variables sólo se pueden utilizar con la conexión en la que se crearon.

Usar una variable en una solicitud de Studio

Para usar las variables en un script de Studio, el script debe tener una acción CONNECTAuth o CONNECTREQUEST. La acción debe vincular el script a la conexión que contenga la variable.

  1. En Studio, abra el script en el que desee usar la variable.

  2. Haga doble clic en la acción Snippet a la que desea agregar la variable.

  3. En la ventana del editor de Snippet, agregue la variable en el lugar donde desee que esté el valor de la variable, siguiendo estas pautas:

    • Ponga el nombre en corchetes dobles. Por ejemplo, [[ variableName ]].
    • Utilice el nombre tal y como se ingresó en el campo Nombre de variable en la pestaña de Variables.
    • Ponga los corchetes y el nombre de la variable entre comillas ( “ ). Por ejemplo, "[[ variableName ]]". Si la variable es parte de una cadena, como una URL, debe ponerse la cadena completa entre comillas, no únicamente la variable. Por ejemplo, "[[ variableName ]]/location/anotherlocation/".
    • Las variables sólo se pueden utilizar con la conexión en la que se crearon. Debe especificarse la conexión en el script con una acción CONNECTAuth o CONNECTREQUEST.

    Ejemplos:

    • ASSIGN requestPayload.body = "[[client_id]]"

    • ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V42.0/AGENTS"

Crear una Solicitud Manual

Las solicitudes son la manera en que obtiene informa que requiere del servicio web al que se conecta su integración. Puede usar solicitudes manuales en los Studio scripts o ejecutarse a partir de Integration Hub.

Si su solicitud demanda los parámetros de la ruta o una sustitución de parámetros en la URL, encabezados o parámetros, debe crear una solicitud de Studio. Las solicitudes manuales no son compatibles con estas opciones.

  1. En CXone Mpower, haga clic en el selector de aplicaciones y seleccioneAutomatización e IA > Integration Hub.

  2. Haga clic en la conexión con la que desee trabajar desde Mis Conexiones del lado izquierdo de la página.

  3. En la pestaña de Solicitudes, haga clic en Agregar Solicitud.

  4. Escriba un Nombre de solicitud.

  5. Seleccione Manual como Impulsor.

  6. Ingrese la URL para esta solicitud.

  7. Haga clic en el Método (verbo) para esta solicitud.

  8. En Encabezados, añada cualquier encabezado que se requiera para su solicitud:

    1. Haga clic en Añadir Encabezado .

    2. Ingresa un Nombre de Encabezado y Valor del Encabezado.

  9. En Parámetros de la Consulta, añada cualquier parámetro de la consulta que se requiera para su solicitud: 
    1. Haga clic en Añadir Parámetro de Consulta.
    2. Ingrese un Nombre de Parámetro de la Consulta y un Valor del Parámetro de la Consulta.

  10. Seleccione un Tipo de Medio e ingrese el contenido del Cuerpo. El tipo de medio afecta el formato del contenido del cuerpo. Debe coincidir con el tipo requerido por el servicio web al que se está conectando.

    Opción Detalles

    ApplicationJson

    El contenido del cuerpo debe estar en JSON con application/json como el encabezado del contenido.
    ApplicationJsonPatch El contenido del cuerpo debe estar en formato JSON Patch con application/json-patch+json como el encabezado del contenido.
    FormURLEncoded

    El contenido del cuerpo debe estar en pares clave/valor con application/x-www-form-urlencoded como el encabezado de contenido. Este tipo de medio envía solicitudes utilizando notaciones de URL comunes.

    Haga clic en +Agregar Parámetro del Formulario, luego ingrese el Nombre del Parámetro del Formulario y el Valor del Parámetro del Formulario.
    TextHtml El contenido del cuerpo debe estar en HTML con text/html como el encabezado del contenido.
    TextPlain El contenido del cuerpo debe estar en texto sin formato con text/plain como el encabezado del contenido.
    TextXml El contenido del cuerpo debe estar en XML con text/xml como el encabezado del contenido.
  11. Si desea cambiar este estatus activo de la solicitud, haga clic en Activo en la parte superior de la página El texto cambia a Inactivo.
  12. Haga clic enConfirmar.
  13. En la pestaña de Solicitudes, haga clic en Probar para la solicitud que acaba de añadir. Integration Hub intenta la solicitud. Se despliega una ventana y muestra los resultado de la prueba.
  14. Haga clic en Editar y haga cambios a la solicitud o clic en Guardar.

Crear una solicitud de Studio

Una solicitud de Studio es útil cuando tiene solicitudes de la API que no pueden crearse en Integration Hub pero quiere poder usar Integration Hub para la autenticación y los secretos.

  1. En CXone Mpower, haga clic en el selector de aplicaciones y seleccioneAutomatización e IA > Integration Hub.

  2. Haga clic en la conexión con la que desee trabajar desde Mis Conexiones del lado izquierdo de la página.

  3. En la pestaña de Solicitudes, haga clic en Agregar Solicitud.

  4. Escriba un Nombre de solicitud.

  5. Seleccione Studio como Impulsor.

  6. Seleccione y copie la carga de solicitudes de ejemplo desde la página de Añadir Solicitud si desea usar el ejemplo para construir el JSON en su script.

  7. Haga clic enConfirmar.

    Las solicitudes Studio no se pueden probar desde Integration Hub. Debe probarlas en Studio con la ejecución del script con rastreo.

  8. Hacer clic en Icono de un disco flexibleGuardar.

  9. Lance Studio e inicie sesión.
  10. Abra una secuencia de comandos existente o cree una nueva.
  11. Añada la Snippet acción a su script y haga doble clic para abrir la ventana del editor Snippet.

  12. Construya un objeto dinámico en la ventana del editor de Snippet y conviértalo a JSON. El objeto que cree debe contener los miembros que almacenan los encabezados, los parámetros de consulta y el contenido del cuerpo necesario para la consulta.

    Use la carga de ejemplo que copió desde Integration Hub en un paso anterior como guía al crear su objeto. La carga de ejemplo es:

    {
 "URL": "[[INSTANCEURI]]/INCONTACTAPI/SERVICES/V42.0/AGENTS",
 "HTTPMETHOD": "POST",
 "HEADERS": {
	"CONTENT-TYPE": "APPLICATION/JSON",
	"AUTHORIZATION": "BEARER[[BEARERTOKEN]]"
	},
 "QUERYPARAMETERS": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "8675309"
	},
 "BODY": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "9035768",
	"ACCOUNTNAME": "Mister Underhill Bagginses"
	}
}

    Un objeto dinámico que se creó usando la carga de ejemplo como guía es:

    DYNAMIC requestPayload 
ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERVICES/V42.0/AGENTS"
ASSIGN requestPayload.HTTPMETHOD = "POST"
ASSIGN requestPayload.HEADERS.CONTENTHYPHENPLACEHOLDERTYPE = "APPLICATION/JSON"
ASSIGN requestPayload.HEADERS.AUTHORIZATION = "BEARER[[BEARERTOKEN]]"
ASSIGN requestPayload.QUERYPARAMETERS.ANI = "[[ANI]]"
ASSIGN requestPayload.QUERYPARAMETERS.ACCOUNTID = "8675309"
ASSIGN requestPayload.BODY.ANI = "[[ANI]]"
ASSIGN requestPayload.BODY.ACCOUNTID = "9035768"
ASSIGN requestPayload.BODY.ACCOUNTNAME = "Mister Underhill Bagginses"
ASSIGN requestPayloadJSON = "{requestPayload.asjson()}"
ASSIGN requestPayloadJSON = "{requestPayloadJSON.replace("HYPHENPLACEHOLDER", "-")}"

    La última línea del ejemplo anterior usar la replace() función para insertar el carácter de guion ( - ) en el nombre de la clave CONTENT-TYPE. En Studio, los nombres de las variables no pueden incluir caracteres especiales como guiones, por lo que se usa este método como posible solución.

  13. Configure el script para que use la solicitud.

Cambie un Estado de la Solicitud

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. Las solicitudes están activas de manera predeterminada.

  1. En CXone Mpower, haga clic en el selector de aplicaciones y seleccioneAutomatización e IA > Integration Hub.

  2. Haga clic en la conexión con la que desee trabajar desde Mis Conexiones del lado izquierdo de la página.

  3. En la pestaña de Solicitudes, haga clic en la solicitud con la que desee trabajar.

  4. Haga clic en Inactivo o Activo en la parte superior de la página para cambiar el estado.