Integraciones con sistemas externos

Integración por URL sistemas externos

Be Aware 360 provee una URL para permitir de sistemas externos puedan integrarse con la plataforma permitiendo un único login entre el Sistema externo y Be Aware 360, mediante el uso del token de autenticación.

URL genérica

Con la última actualización de la aplicación se han realizado mejoras en el formato de la URL de integración con sistemas externos, el cual contempla lo siguiente:

  • Se habilita el parámetro caso para permitir realizar búsqueda por un número de caso específico.
  • Se agrupan los parámetros de contacto en un solo parámetro llamado “contacto”.

Importante:

  • La funcionalidad actual no se verá afectada con los nuevos cambios.
  • Se recomienda migrar las implementaciones actuales al nuevo formato de URL.
  • Para nuevas implementaciones se recomienda utilizar el nuevo formato de URL.

La estructura de la nueva URL queda de la siguiente forma:

https://{URL_Instancia}/integracionview/PLATAFORMA/CANAL/IDCHAT/{"contacto":"parametro_contacto","empresa":"parametro_cuenta","caso":"parámetro_caso"}/TOKEN

Ejemplo ambiente de producción:

https://ba360review.deskbeaware.com/integracionview/genesys/chat/1234567645/{"contacto":"998874563","empresa":null,"caso":"210112-000000"}/ZTMgcHJ1ZWJhY2hhdCAxMjM0IHlCeWdPcktxQTAgMjAyMDAyMDc
https://ba360review.deskbeaware.com/integracionview/genesys/chat/1234567645/{"contacto":"998874563","empresa":null,"caso":null}/ZTMgcHJ1ZWJhY2hhdCAxMjM0IHlCeWdPcktxQTAgMjAyMDAyMDc

Ejemplo ambiente de preproducción:

https://ba360reviewdesk.beaware360.com/integracionview/genesys/chat/1234567645/{"contacto":"998874563","empresa":null,"caso":"210112-000000"}/ZTMgcHJ1ZWJhY2hhdCAxMjM0IHlCeWdPcktxQTAgMjAyMDAyMDc
https://ba360reviewdesk.beaware360.com/integracionview/genesys/chat/1234567645/{"contacto":"998874563","empresa":null,"caso":null}/ZTMgcHJ1ZWJhY2hhdCAxMjM0IHlCeWdPcktxQTAgMjAyMDAyMDc

A continuación se detallan los campos que pueden viajar en la URL:

Campo Descripción Tipo de dato
plataforma Corresponde al nombre de la plataforma del sistema externo que está invocando Be Aware 360. String
canal Corresponde al nombre del canal con el que quedará creado el caso en Be Aware 360. Clic aquí para conocer los valores disponibles de canales. String
ID_Chat Corresponde al Id de la interacción de la plataforma del sistema externo y que quedará relacionado en el caso de Be Aware 360. El tamaño máximo del campo son 120 caracteres. String
contacto Corresponde a cualquier parámetro de búsqueda del contacto en Be Aware 360, entre los campos: Identificador, Nombre, Idrrss, Email y Teléfono. String
empresa Corresponde a cualquier parámetro de búsqueda de la cuenta en Be Aware 360, entre los campos: Identificador, Representante, Razón Social, Giro y Dirección. String
caso Corresponde al número de caso de Be Aware 360. String
auth_token Corresponde al token de autenticación del usuario en Be Aware 360. Para más información sobre el token de autenticación, clic aquí. String

URL anterior

La URL anterior para integración con sistemas externos tiene la siguiente estructura:

{URL_Instancia}/integracionview/{plataforma}/{canal}/{ID_Interaccion}/{"identificador":"179259168","nombre":"","idrrss":null,"email":"","telefono":"","empresa":null,"caso":"201201-000005"}/{auth_token}

Ejemplo ambiente de preproducción:

https://ba360reviewdesk.beaware360.com/integracionview/chattigo/chat/150/"identificador":"","nombre":"","idrrss":null,"email":"","telefono":"993405075","empresa":null,"caso":null/ZTMgcHJ1ZWJhY2hhdCAxMjM0IHlCeWdPcktxQTAgMjAyMDAyMDc

Ejemplo ambiente de producción:

https://ba360review.deskbeaware.com/integracionview/chattigo/chat/150/"identificador":"","nombre":"","idrrss":null,"email":"","telefono":"993405075","empresa":null,"caso":null/ZTMgcHJ1ZWJhY2hhdCAxMjM0IHlCeWdPcktxQTAgMjAyMDAyMDc

A continuación se detallan los campos que pueden viajar en la URL anterior:

Campo Descripción Tipo de dato
plataforma Corresponde al nombre de la plataforma del sistema externo que está invocando Be Aware 360. String
canal Corresponde al nombre del canal con el que quedará creado el caso en Be Aware 360. Clic aquí para conocer los valores disponibles de canales. String
ID_Interaccion Corresponde al Id de la interacción de la plataforma del sistema externo y que quedará relacionado en el caso de Be Aware 360. El tamaño máximo del campo son 120 caracteres. String
identificador Corresponde al identificador del contacto en Be Aware 360. String
nombre Corresponde al nombre y apellido del contacto en Be Aware 360. String
idrrss Corresponde al Id de las redes sociales del contacto en Be Aware 360. String
email Corresponde al correo electrónico del contacto en Be Aware 360. String
telefono Corresponde al número de teléfono del contacto en Be Aware 360. String
empresa Corresponde a cualquier parámetro de búsqueda de la cuenta en Be Aware 360, entre los campos: Identificador, Representante, Razón Social, Giro y Dirección. String
caso Corresponde al número de caso de Be Aware 360. String
auth_token Corresponde al token de autenticación del usuario en Be Aware 360. Para más información sobre el token de autenticación, clic aquí. String

Búsqueda de casos, cuentas y contactos

Se debe tener en cuenta la siguiente casuística para hacer la búsqueda por Casos, Cuentas o Contactos:

  1. La prioridad de búsqueda es Caso → Cuenta → Contacto.
  2. Si se envía un dato en el parámetro “caso”, realizará búsqueda sobre el objeto de Casos independientemente si vienen valores en los otros parámetros.
  3. Si se envía un dato en el parámetro “empresa”, realizará búsqueda sobre el objeto de Cuentas, por cualquiera de estos campos: Identificador, Representante, Razón Social, Giro y Dirección, solo si no viene un valor en el parámetro caso.
  4. Si se envía un dato en el parámetro “contacto”, realizará búsqueda sobre el objeto de Contactos por cualquiera de estos campos: identificador, nombre, idrrss, email y telefono, solo si no vienen valores en los parámetros caso ni empresa.

Ingreso directo a registro para resultados únicos

Se deben tener en cuenta las siguientes consideraciones en la búsqueda:

  • Si alguna búsqueda entrega un solo resultado, se ingresará directamente a la vista del registro encontrado.
  • Si alguna búsqueda no entrega resultado, se mostrará el buscador correspondiente con el valor ingresado en la búsqueda pero sin resultados.
  • Si alguna búsqueda entrega más de un resultado, se mostrará el buscador correspondiente con el valor ingresado en la búsqueda y los primeros 10 resultados obtenidos. Moviéndose en las páginas se visualizan otros 10 resultados.

Canales aceptados

Los valores posibles que acepta la URL de integración de sistemas externos sobre los canales son:

  • Voz (se acepta Call)
  • Chat
  • Email
  • SMS
  • TWDirect
  • Messenger
  • Facebook
  • Whatsapp
  • Telegram
  • Hangout
  • Instagram

Consumo del token de autenticación

El último parámetro que recibe la URL para integración de sistemas externos con Be Aware 360 es el token de autenticación. Se debe tener en cuenta la siguiente información para obtener el token:

Método

POST

URL Recurso

  • 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

Body

{
	"user":"USERNAME",
	"pass":"USERPASS",
	"company":"COMPANY",
	"secretkey":"DgRCJT+oAQ5qsK8sBhD0NQ==",
	"clientkey":"/GUslVpfTHkPj3YX7wt2eQ=="
}

Secretkey y Clientkey

Los valores de los campos secretkey y clientkey son propios para cada instancia y manejados por el administrador de la plataforma. Se habilitó una vista especial para el administrador llamada Aplicaciones externas para obtener los valores de ambos campos, teniendo en cuenta las siguientes consideraciones:

  • Al ingresar por primera vez se generan ambos parámetros de forma automática.
  • En la vista se entrega la posibilidad de “Regenerar” el SecretKey invalidando el valor anterior.

Habilitación de la vista Aplicaciones externas

Para generar los valores de secretkey y clientkey, el administrador de la plataforma debe tener acceso a la vista de Aplicaciones externas. Para agregar esta vista a los permisos del administrador, se deben realizar los siguientes pasos:

  1. Navegar al menú Agente > Roles.
  2. Clic en el botón Permisos para el rol Administrador.
  3. Buscar por Aplicaciones Externas y otorgar todos los permisos.
  4. Clic en el botón Guardar.
  5. El usuario con rol de administración verá el menú en el próximo inicio de sesión.
  6. La vista queda disponible en el menú Otros > Aplicaciones externas.
    1. Nota: Al ingresar por primera vez se generarán los valores para Clientkey y Secretkey.

Lógica de negocio

Se deben tener en cuenta las siguientes consideraciones:


Lógica de negocio para manejo de usuarios

  1. Si el usuario no existe, se crea.
    1. Toma el rol marcado por defecto en la vista de Roles.
      1. Si no se ha configurado un rol por defecto, lo crea sin rol.
    2. Toma el grupo marcado por defecto en la vista de Grupos.
      1. Si no se ha configurado un grupo por defecto, lo crea sin grupo.
    3. Nombre, Apellido y User se toma del valor “user”.
    4. Contraseña, se toma del valor “pass”.
    5. 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.
      1. Ejemplo:
        1. Valor campo user: UserNew.
        2. Email: UserNew@authexternalsystem.com.
    6. Zona horaria se toma desde el valor de la instancia.
    7. Idioma se toma desde el valor de la instancia.
    8. Luego de crear, entrega token de autenticación.
  2. Si el usuario existe, entrega token de autenticación o error en autenticación.
  3. Si los datos del Usuario son vacíos o nulos, se entrega mensaje de error y no se realiza la acción de validación/creación.

Lógica de negocio para manejo de token

  1. Si el token enviado en la URL es válido, se accede a la plataforma.
  2. Si el token enviado en la URL no es válido:
    1. Se muestra pantalla de login solicitando credenciales.
    2. Luego del login exitoso se redirige a la vista invocada en la URL.
  3. Si no se envía token en la URL:
    1. Se muestra pantalla de login solicitando credenciales.
    2. Luego del login exitoso se redirige a la vista invocada en la URL.

Integración por URL Genesys PureCloud

En construcción

Integración del histórico de conversación con Be Aware Social

Esta integración permite, desde la Consola de Agentes de Be Aware 360, acceder a la conversación realizada en el canal social (Whatsapp, Messenger, Instagram, etc.) entre el cliente y el ejecutivo que deriva en la creación del caso.

Al crear el caso desde Be Aware Social, se crea una nota automática con un enlace que muestra la conversación relacionada al caso. Al presionar sobre el enlace, desde la Consola de Be Aware 360, se muestran los mensajes correspondientes a la conversación y los adjuntos asociados.

Para configurar esta integración se deben realizar los siguientes pasos:

  1. Ingresar un caso en el PUC, solicitando la entrega de los parámetros de configuración. En el caso se entregarán:
    1. Usuario de la integración.
    2. Contraseña del usuario.
    3. URL del servicio.
  2. Navegar al menú Otros > Parámetros.
  3. Crear un parámetro con el nombre ext_sys_user. El valor del parámetro corresponderá al usuario entregado en el caso.
  4. Crear un parámetro con el nombre ext_sys_pass. El valor del parámetro corresponderá a la contraseña del usuario entregado en el caso.
  5. Crear un parámetro con el nombre ext_sys_url. El valor del parámetro corresponderá a la URL entregada en el caso.

Una vez configurados los parámetros mencionados anteriormente, ya puede empezar a acceder al histórico de conversación en los casos.

Nota: Los nombres de los parámetros se deben respetar tal y como están escritos en esta documentación.