Configurar Conexiones

Las conexiones de Integration Hub le permiten configurar integraciones con servicios web de terceros para usarlas en NiCE CXone.

Crear una Plantilla de conexión

Una plantilla de conexión define la información básica sobre una integración. Las Plantillas se utilizan para crear conexiones, donde puede configurar 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.

Screenshot of the Add Template page in Integration Hub.
  1. En NiCE CXone, haga clic en el selector de aplicaciones y seleccione Automation & AI > Integration Hub.
  2. Haga clic en Agregar Plantilla.
  3. En la pestaña de Detalles, ingrese un nombre para la plantilla.
  4. Introduzca el nombre de la Aplicación a la que se está conectando. Esto podría ser una aplicación, plataforma o servicio web.
  5. Seleccione REST como el Método de Integrar. Actualmente, REST es el único método admitido.

  6. Seleccione una opción para el Tipo de autenticación. Después de hacer una selección, se muestra la pestaña Configuration.

    Opción Detalles
    OAuth 2.0 Un marco de trabajo de estándar abierto que permite que las aplicaciones accedan a recursos en nombre de un usuario sin compartir credenciales.
    Sin autenticación 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 plantila desde la biblioteca de conexión.
  8. Adjunte un icono arrastrando y soltando una imagen o haciendo clic en Examinar archivos. Este icono se muestra para esta plantilla en la biblioteca de conexiones para todas las conexiones creadas 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. If you selected an authentication type, define any custom authentication headers for this template:
    1. Haga clic en Agregar Encabezado Personalizado.
    2. Ingrese el nombre del encabezado en el campo que aparece.
    3. Haga clic en Agregar Encabezado Personalizado para agregar más encabezados personalizados.
    4. Seleccione ¿Obligatorio? para cualquier encabezado que deba usarse en las conexiones creadas a partir de esta plantilla.
    5. Haga clic en X para eliminar un encabezado.
  11. Verifique nuevamente toda la configuración. No puede editar una plantilla después de guardarla.
  12. Do one of the following: 
    • Haga clic en Guardar para añadir la plantilla a la biblioteca de conexiones.
    • Haga clic en Save + My Connections para agregar la plantilla a la biblioteca de Conexiones y crear 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 de mis Conexiones

Esta sección aplica si hizo clic en Save al crear la plantilla de conexión, no en Save + My Connections. Una conexión solo puede usarse en un script Studio si está en la lista My Connections.

  1. En NiCE CXone, haga clic en el selector de aplicaciones y seleccione Automation & AI > Integration Hub.

  2. Cree una nueva conexión de una de las siguientes 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 apiladas Copiar.

  3. En el campo My Connection Name de la ventana emergente, ingrese un nombre único para la nueva conexión.

  4. Hacer clicGuardar.

Configurar Detalles de 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 plantila que se usa para esta conexión.

  1. En NiCE CXone, haga clic en el selector de aplicaciones y seleccione Automation & AI > Integration Hub.

  2. Haga clic en la conexión con la que desea trabajar desde mis Conexiones en el 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. To add a query parameter to the authentication request:
    1. Haga clic en Añadir Parámetro de Consulta.
    2. Para cada parámetro de consulta que agregue, introduzca un Query Parameter Name y un Query Parameter Value.

  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 usa para la autenticación con AWS. Esto actualiza el encabezado Content-Type de 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 clicGuardar.

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 NiCE CXone, haga clic en el selector de aplicaciones y seleccione Automation & AI > Integration Hub.

  2. Haga clic en la conexión con la que desee trabajar en mis Conexiones, en el 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 de cliente
    • Clave Privada del cliente
    • Frase de contraseña clave

    Estos campos solo aparecen si usted utiliza OAuth 2.0 como su tipo de autenticación. Debe ingresar el Client Certificate y el Client Private Key juntos. Si su Client Private Key está encriptada, debe ingresar una Key Passphrase. Los certificados mTLS solo funcionan si su URL de autentificación está en HTTPS. La validación de estos campos ocurre después de que se guarda la conexión. Puede hacer referencia a estos campos en la pestaña Secretos.

  5. Hacer clicGuardar.

Agregar variables a una conexión

Integration Hub Variables 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 guarda el conector, no es posible volver a convertir el secreto en una 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 forma de recuperar el valor que ingresó en el campo después de que esté oculto.

  1. En NiCE CXone, haga clic en el selector de aplicaciones y seleccione Automation & AI > Integration Hub.

  2. Haga clic en la conexión con la que desee trabajar en mis Conexiones, en el lado izquierdo de la página.

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

  4. Intro un Nombre de variable que identifique lo que 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 activa esta alternancia, no podrá revertirla.

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

  8. Hacer clicGuardar.

Usar variables en una conexión

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

Use a Variable in Authentication Details or a Manual Request

  1. En NiCE CXone, haga clic en el selector de aplicaciones y seleccione Automation & AI > Integration Hub.

  2. Haga clic en la conexión con la que desea trabajar desde mis Conexiones en el lado izquierdo de la página.

  3. Haga clic en la pestaña donde desee usar una variable. Las variables se pueden usar en las pestañas Authentication 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 exactamente como se ingresó en el campo Nombre de variable en la pestaña variables.
    • Las variables sólo se pueden utilizar con la conexión en la que se crearon.

Usar un Variable en una Solicitud de Studio

Para usar 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 desea que se utilice el valor de la variable, siguiendo estas pautas:

    • Ponga el nombre en corchetes dobles. Por ejemplo, [[ variableName ]].
    • Utilice el nombre exactamente como se ingresó en el campo Nombre de variable en la pestaña variables.
    • Encierre los corchetes y el nombre de variable entre comillas dobles ( " ). 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. La conexión debe especificarse 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 de obtener la información que necesita del servicio web al que se conecta su integración. Puede usar solicitudes manuales en los Scripts de Studio o ejecutarlas desde Integration Hub.

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

  1. En NiCE CXone, haga clic en el selector de aplicaciones y seleccione Automation & AI > Integration Hub.

  2. Haga clic en la conexión con la que desea trabajar desde mis Conexiones, en el 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. Under Query Parameters, add any query parameters that are required for your request: 
    1. Haga clic en Añadir Parámetro de Consulta.
    2. Intro 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 de 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 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.
    TextoPlano 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 el estado activo de esta solicitud, haga clic en Activo en la parte superior de la página. El texto cambia a Inactivo.
  12. Haga clic en Confirmar.
  13. En la pestaña Solicitudes, haga clic en Prueba para la Solicitud que acaba de agregar. 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.

Create una Solicitud de Studio

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

  1. En NiCE CXone, haga clic en el selector de aplicaciones y seleccione Automation & AI > Integration Hub.

  2. Haga clic en la conexión con la que desee trabajar desde mis Conexiones en el 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 útil de solicitud de ejemplo desde la página Agregar Solicitud si desea usar el ejemplo para construir el JSON en su script.

  7. Haga clic en Confirmar.

    Las solicitudes de Studio no se pueden probar desde Integration Hub. Debe probarlas en Studio ejecutando el script con un seguimiento.

  8. Haga clic en Icon of a floppy disk Save.

  9. Lance Studio e inicie sesión.
  10. Abrir un script existente o crear uno nuevo.
  11. Agregue una acción Snippet action a su script y haga doble clic en ella para abrir la ventana del editor de Snippet.

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

    Utilice la carga útil de ejemplo que copió de Integration Hub en un paso anterior como guía al momento de crear su objeto. La carga útil 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 creado usando la carga útil 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 usa la función replace() para insertar el carácter de guion ( - ) en el nombre de 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 forma predeterminada.

  1. En NiCE CXone, haga clic en el selector de aplicaciones y seleccione Automation & AI > Integration Hub.

  2. Haga clic en la conexión con la que desea trabajar desde mis Conexiones en el 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.