Diferencias

Muestra las diferencias entre dos versiones de la página.

--- integraciones [2022/12/02 14:37] – [Integraciones con sistemas externos] scantor
+++ integraciones [2024/09/02 15:10] (actual) – [Consumo del token de autenticación] scantor
@@ Línea 1: / Línea 1: @@
-====== Integraciones con sistemas externos ======
+====== Integraciones con otros sistemas ======
-Existen distintos mecanismos de integración entre Be Aware 360 y sistemas externos:
+Existen distintos mecanismos de integración entre Be Aware 360 y otros sistemas:
   * [[integraciones#Integración por URL sistemas externos|Integración por URL sistemas externos]]
-  * [[integraciones#Integración por URL Genesys PureCloud|Integración por URL Genesys PureCloud]]
   * [[integraciones#Integración del histórico de conversación con Be Aware Social]]
   * [[integraciones#Integración SSO con el Directorio Activo de Microsoft Azure]]
@@ Línea 137: / Línea 136: @@
   * **URL producción:** %%https://api.beaware360.com%%
   * **URL preproducción (Instancias de los partners):** %%https://api-prep.beaware360.com%%
-  * **Resource:** /ba360/apir/v10/login/authexternalsystem
+  * **Resource:** /ba360/apir/v10_5/login/authexternalsystem
 === Body ===
@@ Línea 187: / Línea 186: @@
     - Nombre, Apellido y User se toma del valor “user”.
     - Contraseña, se toma del valor “pass”.
+      - **Nota:** Al crear un usuario a través de esta autenticación, el sistema no le solicitará cambio de contraseña por primer login, si el usuario llega a ingresar a la consola de Be Aware 360.
     - Email se forma desde el valor “user” como {user}@authexternalsystem.com. Luego debe ser modificado por un administrador de usuarios para evitar el envío de correos electrónicos que reboten.
       - Ejemplo:
@@ Línea 208: / Línea 208: @@
     - Luego del login exitoso se redirige a la vista invocada en la URL.
-===== Integración por URL Genesys PureCloud =====
+==== Registro de IDs de interacción asociados al caso de Be Aware 360 ====
-//En construcción//
+Con el objetivo de registrar la relación entre la plataforma gestora de canales de atención y los casos atendidos en Be Aware 360, hemos implementado el registro de todos los ID de Interacción, también conocidos como ID de Chat o ID de Conversación, utilizados al invocar la vista de Sistemas Externos de Be Aware.
+De esta manera, es posible realizar el cruce de datos del caso con la atención brindada a través del canal correspondiente.
+=== Características: ===
+  * La tabla **interaccion_casos_sistemas_externos** registra todas las acciones realizadas en el caso desde la vista de Sistemas Externos de Be Aware.
+  * Se registran las siguientes acciones:
+    * Creación de caso.
+    * Edición de caso.
+    * Marcado de lista de chequeo del caso.
+    * Avance o retroceso en el caso.
+    * Agregado de nota al caso.
+    * Carga o descarga de archivos al caso.
+    * Envío de respuesta por correo.
+  * Los datos se obtienen a través de los informes generados en Be Aware 360.
+=== Tabla Interacción casos sistemas externos ===
+**Nombre de la tabla:** interaccion_casos_sistemas_externos
+**Descripción:** La tabla interaccion_casos_sistemas_externos almacena la relación entre las interacciones generadas en el sistema que gestiona la comunicación con el cliente y los casos creados o modificados en Be Aware 360.
+**Ejemplo práctico:**
+<code mysql>
+SELECT caso.REFNUM AS 'REFNUM', producto.NOMBRE AS 'PRODUCTO', tipo.NOMBRE AS 'MOTIVO', subtipo.NOMBRES AS 'SUBMOTIVO', caso.ORIGEN AS 'CANAL',
+interaccion_casos_sistemas_externos.IDINTERACCION AS 'ID INTERACCIÓN',
+interaccion_casos_sistemas_externos.OPERACION AS 'OPERACIÓN REALIZADA',
+DATE_FORMAT(CONVERT_TZ(interaccion_casos_sistemas_externos.FECHACREACION,'UTC',GETVALUE('TIME_ZONE')), '%Y-%m-%d %H:%i:%s') AS 'FECHA'
+FROM interaccion_casos_sistemas_externos
+JOIN caso ON interaccion_casos_sistemas_externos.IDCASO = caso.ID
+JOIN producto ON caso.IDPRODUCTO = producto.ID
+JOIN tipo ON caso.IDTIPO = tipo.ID
+JOIN subtipo ON caso.IDSUBTIPO = subtipo.ID
+WHERE CONVERT_TZ(interaccion_casos_sistemas_externos.FECHACREACION,'UTC',GETINSTANCETIMEZONE())
+BETWEEN DATE_FORMAT('{{FECHADESDE}}','%Y-%m-%d 00:00:00') AND DATE_FORMAT('{{FECHAHASTA}}','%Y-%m-%d 23:59:59')
+</code>
+^ Campo ^ Tipo ^ Tipo Clave ^Objeto Relacionado ^ Descripción ^
+| ID | INT | Llave Primaria | | Identificador del registro. |
+| IDINTERACCION | VARCHAR |  |  | ID de la interacción generada en el sistema externo. Más conocida como ID de Chat o ID de conversación. |
+| PLATAFORMA | VARCHAR |  |  | Nombre de la plataforma donde se genera la interacción en el sistema externo. |
+| IDCASO | INT |  | caso.ID | ID del caso relacionado en el cual se realizó alguna acción (creación o edición). |
+| iDUSUARIO | INT |  | usuario.ID | ID del usuario que realizó la acción sobre el caso (creación o edición). |
+| OPERACION | VARCHAR |  |  | Descripción de la operación realizada sobre el caso (creación o edición). |
+| FECHACREACION | DATETIME |  |  | Fecha de creación del registro en la tabla. |
 ===== Integración del histórico de conversación con Be Aware Social =====
@@ Línea 231: / Línea 278: @@
 **Nota:** Los nombres de los parámetros se deben respetar tal y como están escritos en esta documentación.
+===== Integración SSO con el Directorio Activo de Microsoft Azure =====
+La consola de Be Aware 360 cuenta con la posibilidad de realizar login unificado (SSO) con la plataforma Azure Active Directory para usuarios de Be Aware 360 en Consola.
+Con esta integración se permite gestionar el acceso a la consola de Be Aware 360 a través de la configuración de usuarios en Azure Active Directory, donde no necesitarán realizar doble login (Azure + Be Aware 360) sino que con el acceso a Microsoft Azure se habilita el acceso a Consola de Be Aware 360.
+==== Flujo de autenticación en Be Aware 360 con Azure Active Directory  ====
+Una vez activada la integración SSO Azure en Be Aware 360, el acceso a Consola se realizará de la siguiente manera:
+  - Un usuario ingresa a la página de login de la consola de Be Aware 360.
+  - El sistema detecta que la instancia de Be Aware tiene activa la integración con Azure Active Directory y automáticamente redirigirá al usuario a la plataforma de Microsoft Azure para solicitar el acceso:
+    - Si el usuario no ha iniciado sesión en Microsoft Azure, se solicitarán los accesos de dicha plataforma.
+    - Si el usuario ya tienen sesión iniciada en Microsoft Azure, no solicitará ingreso de credenciales.
+  - En Microsoft Azure se validan los permisos del agente para acceder a Be Aware 360.
+    - Si el usuario tiene los permisos correspondientes, se redirigirá a la consola de Be Aware 360.
+    - Si el usuario no tiene los permisos necesarios para el ingreso, se dará mensaje de error en Microsoft Azure.
+  - Con el acceso correcto en Microsoft Azure, se redirigirá al usuario a la consola de Be Aware 360.
+    - Se realiza el ingreso a la consola de Be Aware 360 con el usuario del agente que accede.
+      - En caso que no se encuentre el usuario correspondiente, se dará mensaje de error.
+  - Al realizar el logout desde la consola de Be Aware 360 se redirigirá a la página de cierre de sesión de Be Aware 360.
+    - La sesión en Microsoft Azure no se cerrará.
+==== Configuración de la integración entre Be Aware 360 y Azure Active Directory  ====
+A continuación, se indican las tareas a considerar en las configuraciones de los sistemas.
+  - [[integraciones#Creación y configuración de aplicación Be Aware 360 en Azure]].
+  - [[integraciones#Obtención de datos de la aplicación]].
+  - [[integraciones#Sincronización de usuarios de Azure y de Be Aware 360]].
+  - [[integraciones#Activación y configuración de SSO en Be Aware 360]].
+==== Creación y configuración de aplicación Be Aware 360 en Azure ====
+Se debe crear y configurar la aplicación Be Aware 360 en Azure AD.
+**Creación de Aplicación:**
+Dentro del portal de Azure:
+  - Ingresar a Azure Active Directory
+  - En el menú lateral izquierdo, Ir a sección Administrar > Registro de aplicaciones
+  - Crear nuevo registro presionando sobre Nuevo registro
+  - Completar los datos de la aplicación:
+    - **Nombre:** Be Aware 360
+    - **Tipo de cuenta compatible:** Seleccionar tipo de Cuenta
+    - **URI de redirección:**
+      - **Opción:** Aplicación de página única.
+      - **Valor:** Colocar URL de login de Be Aware 360.
+    - Guardar.
+**Configuración de Autenticación:**
+Dentro del portal de Azure:
+  - Ingresar a Azure Active Directory
+  - En el menú lateral izquierdo, Ir a sección Administrar > Autenticación
+  - En la sección Flujos de concesión implícita e híbridos, marcar las opciones:
+    - Tokens de acceso
+    - Tokens de id
+**Configuración de parámetros opcionales:**
+:!: //**Nota:** Este paso es necesario para obtener desde el token de Azure los parámetros que son
+opcionales, entre ellos el email del usuario a autenticar con SSO.//
+Dentro del portal de Azure:
+  - Ingresar a Azure Active Directory
+  - En el menú lateral izquierdo, Ir a sección Administrar > Registro de aplicaciones
+  - Seleccionar e ingresar a la aplicación Be Aware 360 creada anteriormente
+  - En el menú lateral izquierdo, Ir a sección Administrar > Configuración de token
+Continuar con los siguientes pasos:
+   - **Agregar parámetro email.** El parámetro email es utilizado cuando en la configuración de Be Aware 360 se selecciona como Identificador de usuario de Azure el Correo. Corresponde a la configuración por defecto.
+     - Seleccionar la opción + Agregar notificación opcional
+       - Seleccionar Id como tipo de token
+       - Seleccionar el parámetro email
+       - Presionar Agregar
+       - Marcar la casilla para activar el permiso de Microsoft Graph Email
+       - Presionar Agregar
+   - **Agregar parámetro upn (user principal name)**. El User Principal Name (upn) o Nombre principal de usuario es otro parámetro que puede ser utilizado para identificar al usuario Azure. Este parámetro es utilizado cuando se selecciona como Identificador de usuario de Azure al Nombre principal de Usuario en la configuración de Be Aware 360.
+     - Seleccionar la opción + Agregar notificación opcional
+       - Seleccionar Id como tipo de token
+       - Seleccionar el parámetro upn
+       - Presionar Agregar
+       - Si aparece, Marcar la casilla para activar el permiso de Microsoft Graph Email. Presionar Agregar
+       - Presionar sobre los tres puntos que aparecen a la derecha en el parámetro upn
+       - Seleccionar Editar
+       - Colocar como Sí (activar) al valor de Autenticado externamente.
+       - Dejar como No (inactivo) el valor Reemplazar almohadillas.
+       - Presionar sobre Guardar.
+Para más información sobre los parámetros del id token de Azure ver:
+[[https://learn.microsoft.com/en-us/azure/active-directory/develop/id-tokens]]
+[[https://learn.microsoft.com/en-us/azure/active-directory/develop/active-directory-optionalclaims]]
+==== Obtención de datos de la aplicación ====
+Se necesitan obtener datos de la aplicación creada en Azure AD para, luego, ser utilizados en la configuración de Be Aware 360.
+Para realizar la configuración en Be Aware 360 se necesitan los datos de Dominio principal (Tenant) e Id. de aplicación (Client ID).
+Para obtenerlos realizar los siguientes pasos:
+Dentro del Portal de Azure:
+  - Ingresar a Azure Active Directory
+  - En la sección Información General > Información básica:
+    - Copiar el valor de Dominio principal. Este será utilizado como Tenant de Azure.
+  - En el menú lateral izquierdo, Ir a sección Administrar > Registro de aplicaciones
+    - En la sección Aplicaciones propias
+      - Copiar el valor Id. de aplicación (cliente) para la aplicación Be Aware 360 (creada en pasos anteriores).
+==== Sincronización de usuarios de Azure y de Be Aware 360 ====
+La sincronización de usuarios entre sistemas es manual, es decir, se crea un usuario en Azure, luego se crea un usuario en Be Aware 360 y se establece la identificación por un parámetro en específico que deben tener ambos usuarios.
+Para lograr la identificación de los usuarios se debe tener una coincidencia entre el identificador del usuario Azure y el identificador del usuario Be Aware 360. Para lograr la identificación se configura en Be Aware 360 el parámetro de Azure y el de Be Aware 360 a considerar. Ver [[integraciones#Configurar y activar SSO con Azure|Configurar y activar SSO con Azure]].
+=== Parámetros para identificación de usuario de Azure ===
+  * **Correo:**
+    * Corresponde al parámetro **email** del usuario de Azure.
+    * Es la configuración por defecto en Be Aware 360.
+    * Para utilizar este valor, se debe agregar el parámetro opcional email en el Id token.
+    * Hay que considerar que este parámetro queda vacío en Azure para los usuarios creados en la configuración de Azure dentro de la organización.
+  * **ID de Objeto;**
+    * Corresponde al parámetro **Object ID (oid)** del usuario en Azure.
+    * Es un valor único e inmutable de Azure.
+  * **Subject:**
+    * Corresponde al parámetro **Subject (sub)** del usuario en Azure.
+    * Es un valor único e inmutable de Azure.
+  * **Nombre principal de usuario:**
+    * Corresponde al parámetro **User principal name (upn)** del usuario en Azure.
+    * Para utilizar este valor, se debe agregar el parámetro opcional email en el Id token.
+=== Parámetros para identificación de usuario de Be Aware 360 ===
+  * **Correo:**
+    * Corresponde al parámetro “correo electrónico” del usuario de Be Aware 360.
+    * Es la configuración por defecto en Be Aware 360.
+    * Hay que considerar que si existen dos (o más) usuarios en Be Aware 360 con el mismo correo electrónico, la identificación se llevará a cabo con el primero de ellos por orden de ID (primero creado).
+  * **Nombre de usuario:**
+    * Corresponde al parámetro “Usuario” del usuario en Be Aware 360.
+    * Es un valor único.
+  * **ID Externo:**
+    * Corresponde al parámetro “ID Externo” del usuario en Be Aware 360.
+:!: //**Nota:** Para elegir el parámetro de identificación en Azure y en Be Aware 360 se debe tener la seguridad
+que todos los usuarios tendrán valores válidos en ambos parámetros y que servirán para la
+identificación en el login unificado.//
+=== Permisos de aplicación para usuarios Azure ===
+Los usuarios en Azure deben tener otorgados permisos de la aplicación Be Aware 360 (creada anteriormente) para lograr el envío de los parámetros necesarios para la identificación de usuarios.
+Para dar permisos a los usuarios realizar los siguientes pasos.
+Dentro del Portal de Azure:
+  - Ingresar a Aplicaciones empresariales
+  - Seleccionar la aplicación Be Aware 360 creada anteriormente
+  - En el menú lateral izquierdo, Ir a sección Administrar > Usuarios y grupos
+  - Seleccionar la opción + Agregar usuario o grupo
+  - Agregar los usuarios o los grupos correspondientes
+  - Guardar cambios
+==== Activación y configuración de SSO en Be Aware 360 ====
+Luego de realizar las configuraciones mencionadas anteriormente, se debe activar la integración SSO con Azure desde la administración de Be Aware 360.
+:!: //**Importante:** Una vez activada, el ingreso a la Consola de Be Aware 360 será realizada por usuarios válidos en Azure. Si no existen usuarios en Azure con acceso válido, no será posible acceder a la Consola de Be Aware 360 y será necesario comunicarse con el Soporte de Be Aware 360 para desactivar la integración.//
+=== Permisos al Rol administrador ===
+Dentro de la Consola de Be Aware 360:
+  - Ingresar al menú lateral > Agente > Roles
+  - Presionar sobre Permisos (botón verde) en el rol del administrador
+  - Marcar las casillas del permiso Administrar SSO Azure
+  - Presionar Guardar
+:!: //**Nota:** Luego de aplicar los permisos, el usuario con el rol modificado debe cerrar sesión y volver a
+ingresar a la Consola para ver los cambios aplicados.//
+=== Configurar y activar SSO con Azure ===
+Dentro de la Consola de Be Aware 360:
+  - Ingresar al menú Directorio Activo de Azure (menú lateral > Otros > Directorio Activo de Azure).
+  - Seleccionar la opción SI. Esto habilitará el resto de los campos.
+  - Colocar el valor de Dominio principal (obtenido en Azure) en el campo Tenant.
+    - Corresponde a un valor obligatorio.
+    - Este valor se guarda encriptado, por lo que al volver a ingresar a la vista se verá encriptado.
+  - Colocar el valor de Id. de aplicación (obtenido en Azure) en el campo Client ID.
+    - Corresponde a un valor obligatorio.
+    - Este valor se guarda encriptado, por lo que al volver a ingresar a la vista se verá encriptado.
+  - Seleccionar el Identificador de usuario en Azure.
+    - Ver [[integraciones#Parámetros para identificación de usuario de Azure|Parámetros para identificación de usuario de Azure]].
+  - Seleccionar el Identificador de usuario en Be Aware 360.
+    - Ver [[integraciones#Parámetros para identificación de usuario de Be Aware 360|Parámetros para identificación de usuario de Be Aware 360]].
+  - Guardar cambios.