Gestionar las Conexiones

El contenido de esta página es para un producto o función en versión controlada (CR). Si no forma parte del grupo CR y desea obtener más información, comuníquese con suRepresentante de cuenta CXone.

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

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, 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. Seleccione REST como Método de integración. Actualmente, REST es el único método compatible.

  6. Seleccione una opción para el Tipo de Autenticación.

    Opción Detalles
    OAuth 2.0 Seleccione esta opción si desea que la plantilla incluya una autenticación 2.0 OAuth. Actualmente, este es el único tipo de autenticación compatible.
    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 plantila desde la biblioteca de conexión.
  8. Adjunte un icono arrastrando y soltando una imagen o haciendo clic en Examinar archivos. Se muestra este ícono para esta plantilla en la biblioteca de conexiones y en Mis Conexiones respecto de 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. Para definir los encabezados de autenticación personalizados para esta plantilla, haga clic en Agregar Encabezado Personalizado. Esta opción está únicamente disponible si habilitó la autenticación para la plantilla. Para definir un encabezado: 
    1. Ingrese el nombre del encabezado en el campo que aparece.
    2. Haga clic en Añadir Encabezado Personalizado para añadir más encabezados personalizados.
    3. Seleccione ¿Necesario? en los encabezados que deban usarse en las conexiones creadas a partir de esta plantilla.
    4. 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 añadiendo los detalles de autenticación, secretos o solicitudes. Su solicitud puede incluir cualquiera o todas estas configuraciones.

Crear una Conexión a partir de una Plantilla

Las Conexiones le permiten crear solicitudes y añadir detalles de la autenticación. Las conexiones aparecen en Mis Conexiones en Integration Hub.

Cree conexiones a partir de las plantillas de las conexiones. La biblioteca de conexiones muestra todas las plantillas de conexiones que existen su sistema de CXone. Si no hay una plantilla que coincida con lo que necesite hacer, puede crear una.

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

  2. Ubique una plantilla en la biblioteca de conexiones. La biblioteca está del lado derecho de la página. Si está viendo una conexión o plantilla, haga clic en la X en la esquina superior derecha de la página. Esto la cierra para que pueda ver la biblioteca de conexiones.

  3. Haga clic en Mi Conexión en la página de propiedades de la plantilla para crear una conexión que se basa en la plantilla.

  4. Si está usando un certificado autoasignado de mTLS, llene los siguientes campos:

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

    Estos campos aparecerán únicamente si usaOAuth 2.0 como su 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. Únicamente funcionarán los certificados mTLS si la URL de autenticación está en HTTPS. La validación de estos campos se presentará después de que se guarde la conexión. Puede hacer referencia a estos campos en la pestaña Secretos.

  5. Ingrese un nombre para la conexión y haga clic en Guardar.

  6. Haga clic en conexión nueva en la lista en la parte izquierda de la página.

  7. En la pestaña de Configuración, configure un Tiempo Fuera en milisegundos. El tiempo fuera aplica a todas las solicitudes que se configuran en la conexión, lo que incluye la autenticación.

  8. Configure la autenticación y las solicitudes según se requiera. Su conexión puede incluir una o la otra o ambas.

  9. Configure secretos si tiene información que desea se codifique para su uso en la conexión.

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

  1. En CXone, 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 Autenticación, ingrese la URL que se usa para la solicitud de autenticación. La URL no puede ser dinámica, pero puede hacer referencias a secretos en ella.

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

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

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

  7. 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 que añada, ingrese un Nombre de Parámetro de Consulta y Valor de Parámetro de Consulta.

  8. Seleccione un Tipo de Medio e ingrese el contenido del Cuerpo. El tipo de medio afecta el formato del contenido del cuerpo. Podría coincidir con el tipo solicitado por el el servidor de autorizaciones que está usando.

    Opción Detalles

    ApplicationJson

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

    El contenido del cuerpo debe estar en pares de 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.

  9. Haga clic en Guardar.

Agregue Secretos a una Conexión.

Los Integration Hub secretos le permiten que se codifique cierta información en una conexión. Esto genera una capa adicional de seguridad al usar información sensible como las contraseñas en los scripts de Studio.

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, 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 Secretos, haga clic en Agregar Secreto.

  4. Ingrese un Nombre de Secreto que identifique qué contiene el secreto. Se usará el nombre como variable cuando quiera usar el secreto en la conexión. Los nombres pueden contener espacios o caracteres especiales.

  5. Ingrese el Valor del Secreto. Esta es la información que se codificará. Antes de hacer clic desde este campo, verifique que la información sea correcta.

  6. Haga clic en Guardar.

Utilice Secretos en una Conexión

Los Secretos se usan como variables. Ingrese el nombre con formato del secreto en vez del valor que almacene. Cuando se usa la conexión, el sistema reemplaza el nombre del secreto con su valor codificado.

Puede usar secretos en el manual o Studiosolicitudes. En los detalles de la autenticación, puede usar secretos en los encabezados, parámetros de la consulta y contenido del cuerpo.

Use un Secreto en los Detalles de la Autenticación o una Solicitud Manual

  1. En CXone, 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 un secreto. Se pueden usar los secretos en las pestañas de Autenticación y Solicitudes.

  4. Ingrese el secreto en el lugar donde desee que esté el valor del secreto, siguiendo los lineamientos:

    • Ponga el nombre en corchetes dobles. Por ejemplo, [[ Nombresecreto ]].
    • Use el nombre exactamente de la manera en que lo ingreso en el campo de Nombre del Secreto en la pestaña de Secretos.
    • Únicamente se pueden usar los secretos con la conexión donde se crearon.

Use un Secreto en una Solicitud Studio

Para usar los secretos 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 el secreto.

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

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

  3. En la ventana del editor de Snippet, añada el secreto en el lugar donde desee que esté el valor del secreto, siguiendo estos lineamientos:

    • Ponga el nombre en corchetes dobles. Por ejemplo, [[ nombreSecreto ]].
    • Use el nombre exactamente de la manera en que lo ingreso en el campo de Nombre del Secreto en la pestaña de Secretos.
    • Ponga los corchetes y el nombre del secreto entre comillas ( “ ). Por ejemplo, “[[ nombreSecreto ]]”. Si el secreto es parte de una cadena de caracteres, como una URL, debe ponerse la cadena completa entre comillas, no únicamente el secreto. Por ejemplo, "[[ nombreSecreto ]]/ubicación/otraubicación/".
    • Únicamente se pueden usar los secretos con la conexión donde se crearon. Debe especificarse la conexión en el script con una acción CONNECTAuth o CONNECTREQUEST.

    Ejemplos:

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

    • ASSIGN URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.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, 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. Podría coincidir con el tipo solicitado 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 encabezado del contenido.
    ApplicationJsonPatch El contenido del cuerpo debe estar en formato Patch de JSON con application/json-patch+json como encabezado del contenido.
    FormURLEncoded

    El contenido del cuerpo debe estar en pares de clave/valor con application/x-www-form-urlencoded como encabezado del 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 encabezado del contenido.
    TextPlain El contenido del cuerpo debe estar en texto sin formato con text/plain como encabezado del contenido.
    TextXml El contenido del cuerpo debe estar en XML con text/xml como 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  Studio solicitud es útil cuando tiene solicitudes de la API que no pueden crearse en Integration Hub pero desea poder usar Integration Hub para la autenticación y los secretos.

  1. En CXone, 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. Haga clic en Guardar.
  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/SERBICES/V26.0/AGENTS",
 "HTTPMETHOD": "POST",
 "HEADERS": {
	"CONTENT-TYPE": "APPLICATION/JSON",
	"AUTHORIZATION": "BEARER[[BEARERTOKEN]]"
	},
 "QUERYPARAMETERS": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456"
	},
 "BODY": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456",
	"ACCOUNTNAME": "TESTACCOUNT"
	}
}

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

    DYNAMIC requestPayload 
ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.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 = "123456"
ASSIGN requestPayload.BODY.ANI = "[[ANI]]"
ASSIGN requestPayload.BODY.ACCOUNTID = "123456"
ASSIGN requestPayload.BODY.ACCOUNTNAME = "TESTACCOUNT"
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 son activas de manera predeterminada.

  1. En CXone, 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.