Diferencias

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

--- apiba360_12 [2025/10/28 17:00] – [Actividades programadas] aolano
+++ apiba360_12 [2026/09/01 15:14] (actual) – [Uso de la API de Be Aware 360 v12 Oauth] clopez
@@ Línea 5: / Línea 5: @@
 Esta API tiene de particular que usa la autenticación a través de Oauth (Open Authorization).
-**Nota:** Para utilizar esta versión de API, es necesario que la instancia de Be Aware tenga activado Keycloak y Oauth 2.0. Para más información sobre cómo activar esta parametrización, haga clic [[configuracionkeycloak#Configuración de Keycloak|aquí]].
+**Nota 1:** Para utilizar esta versión de API, es necesario que la instancia de Be Aware tenga activado Keycloak y Oauth 2.0. Para más información sobre cómo activar esta parametrización, haga clic [[configuracionkeycloak#Configuración de Keycloak|aquí]].
+Esta versión expone el mismo conjunto de recursos que la **versión 11** de la API y se diferencia en el mecanismo de autenticación. Salvo por eso, el contrato de cada recurso es equivalente entre ambas versiones.
+**Nota 2:** Al migrar una integración desde la versión 11, tenga en cuenta que los siguientes recursos no tienen equivalente en la versión 12:
+  * Registro de eventos del front-end de la consola.
+  * Registro de eventos del front-end del Portal de Clientes.
+  * Inicio de sesión para integraciones.
+  * Consulta de estados por rol.
+  * Flujo de trabajo del Portal de Clientes.
+**Nota 3:** El recurso de exportación de notas de un caso existe en ambas versiones, pero cambia de dirección: en la versión 12 no cuelga del recurso de casos. Una integración que lo invoque debe actualizar la URL.
 Aquí podrá consultar:
@@ Línea 37: / Línea 49: @@
 ^ Recursos ^ Descripción ^ Método ^ URL Recurso ^
-| [[apiba360_105#Consultar usuarios|Consultar usuarios]] | Retorna la lista de usuariossegún los parámetros de búsqueda. | GET | %%https://api.beaware360.com/ba360/apir/v12/usuario/get%% |
+| [[apiba360_12#Consultar usuarios|Consultar usuarios]] | Retorna la lista de usuariossegún los parámetros de búsqueda. | GET | %%https://api.beaware360.com/ba360/apir/v12/usuario/get%% |
-| [[apiba360_105#Consultar usuario por ID|Consultar usuario por ID]] | Retorna la información de un usuario en específico, según su Id en Be Aware 360. | GET | %%https://api.beaware360.com/ba360/apir/v12/usuario/getby?id=<id_usuario>%% |
+| [[apiba360_12#Consultar usuario por ID|Consultar usuario por ID]] | Retorna la información de un usuario en específico, según su Id en Be Aware 360. | GET | %%https://api.beaware360.com/ba360/apir/v12/usuario/getby?id=<id_usuario>%% |
-| [[apiba360_105#Crear usuario|Crear usuario]] | Crea un usuario en Be Aware 360 | POST | %%https://api.beaware360.com/ba360/apir/v12/usuario/add%% |
+| [[apiba360_12#Crear usuario|Crear usuario]] | Crea un usuario en Be Aware 360 | POST | %%https://api.beaware360.com/ba360/apir/v12/usuario/add%% |
-| [[apiba360_105#Actualizar usuario|Actualizar usuario]] | Actualiza un usuario en Be Aware 360 | PUT | %%https://api.beaware360.com/ba360/apir/v12/usuario/upd%% |
+| [[apiba360_12#Actualizar usuario|Actualizar usuario]] | Actualiza un usuario en Be Aware 360 | PUT | %%https://api.beaware360.com/ba360/apir/v12/usuario/upd%% |
-| [[apiba360_105#Eliminar usuario|Eliminar usuario]] | Elimina un usuario en Be Aware 360 | DELETE | %%https://api.beaware360.com/ba360/apir/v12/usuario/del/?id=<id_usuario>%% |
+| [[apiba360_12#Eliminar usuario|Eliminar usuario]] | Elimina un usuario en Be Aware 360 | DELETE | %%https://api.beaware360.com/ba360/apir/v12/usuario/del/?id=<id_usuario>%% |
-| [[apiba360_105#Consultar Perfil Usuario|Consultar perfil usuario]] | Permite consultar el perfil del usuario. | GET| %%https://api.beaware360.com/ba360/apir/v12/perfilusuario/getby?id=<id_usuario>%% |
+| [[apiba360_12#Consultar Perfil Usuario|Consultar perfil usuario]] | Permite consultar el perfil del usuario. | GET| %%https://api.beaware360.com/ba360/apir/v12/perfilusuario/getby?id=<id_usuario>%% |
-| [[apiba360_105#Actualizar Perfil Usuario|Actualizar perfil usuario]] | Permite actualizar el perfil del usuario. | PUT | %%https://api.beaware360.com/ba360/apir/v12/perfilusuario/upd%% |
+| [[apiba360_12#Actualizar Perfil Usuario|Actualizar perfil usuario]] | Permite actualizar el perfil del usuario. | PUT | %%https://api.beaware360.com/ba360/apir/v12/perfilusuario/upd%% |
-| [[apiba360_105#Cambiar Password Perfil Usuario|Cambiar password perfil usuario]] | Permite cambiar el password del usuario. | PUT | %%https://api.beaware360.com/ba360/apir/v12/perfilusuario/cambiopass%% |
+| [[apiba360_12#Cambiar Password Perfil Usuario|Cambiar password perfil usuario]] | Permite cambiar el password del usuario. | PUT | %%https://api.beaware360.com/ba360/apir/v12/perfilusuario/cambiopass%% |
 ----
@@ Línea 101: / Línea 113: @@
 ^ Recursos ^ Descripción ^ Método ^ URL Recurso ^
-| [[apiba360_105#Consultar lista de tareas de un caso|Consultar lista de tareas del caso]] | Consultar las tareas de un caso específico. | GET | %%https://api.beaware360.com/ba360/apir/v12/checklist/tareas/get?idcaso=<id_caso>%% |
+| [[apiba360_12#Consultar lista de tareas de un caso|Consultar lista de tareas del caso]] | Consultar las tareas de un caso específico. | GET | %%https://api.beaware360.com/ba360/apir/v12/checklist/tareas/get?idcaso=<id_caso>%% |
-| [[apiba360_105#Hacer check en tarea de un caso|Hacer check en tarea de un caso]] | Hacer check a una tarea de un caso. | POST | %%https://api.beaware360.com/ba360/apir/v12/caso/done%% |
+| [[apiba360_12#Hacer check en tarea de un caso|Hacer check en tarea de un caso]] | Hacer check a una tarea de un caso. | PUT | %%https://api.beaware360.com/ba360/apir/v12/caso/done%% |
+| [[apiba360_12#Hacer uncheck en tarea de un caso|Hacer uncheck en tarea de un caso]] | Hacer uncheck a una tarea de un caso. | PUT | %%https://api.beaware360.com/ba360/apir/v12/caso/undone%% |
@@ Línea 1100: / Línea 1113: @@
 {
     "data": {
-        "idusuario": null,
-        "identificador": null,
         "nombre": "Agente",
         "apellido": "Atención3",
-        "pass": null,
+         "email": "agente3@nomail.com",
-        "email": "agente3@nomail.com",
+         "estado": 1,
-        "idrol": 4,
+         "user": "aatenciontres",
-        "language": "es",
+         "estado_ACTUAL": {
-        "estado": 1,
+                "idusuario": 11,
-        "user": "aatenciontres",
+                "idconcepto": 3,
-        "timezone": "America/Santiago",
+                "tipoconcepto": 0,
-        "idhorario": 9,
+                "fhcambioestado": "2025-07-03 16:06:31",
-        "multisession": 0,
+                "id": 6480,
-        "gruposkills": [
+                "uuid": null,
+                "eid": null
-        ],
+            },
-        "idsusuariossupervisadosin": null,
+        "idroldesc": "Agente de atención",
-        "idsusuariossupervisadosout": null,
+         "idempresadesc": null,
-        "cf": {},
-        "latitud": null,
-        "longitud": null,
-        "idgrupo": null,
-        "segmentaciones": [],
-        "idempresa": null,
-        "grupousuariosplus": null,
-        "conceptodefecto": null,
-        "isopais": null,
-        "idexternal": null,
-        "notificacionactiva": 1,
-        "idsusuariossupervisados": null,
-        "fechacreacion": "2020-06-27 00:00:06",
-        "fechamodificacion": "2025-05-15 21:22:58",
-        "gruposskillsdesc": null,
-        "primeringreso": 1,
-        "fechaultimaasignacion": null,
-        "fechaposicion": null,
-        "avatar": null,
-        "cantidadcasos": 25,
-        "portada": null,
-        "idgrupodesc": null,
-        "idpermisodesc": null,
-        "idpermiso": null,
-        "acceso": "0",
-        "idroldesc": "Agente de atención",
-        "idempresadesc": null,
         "idhorariodesc": null,
         "id": 12,
-        "eid": null,
+        "uuid": null ,
-        "uuid": null
+        "eid": null
     },
     "code": 200,
@@ Línea 6840: / Línea 6824: @@
 ----
+===== Gestión del Checklist =====
+==== Consultar lista de tareas de un caso ====
+----
+=== Método ===
+''**GET**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v12/checklist/tareas/get?idcaso=<id_caso>%%**
+----
+=== Request: ===
+**Parámetros:**
+id_caso -> Corresponde al id del caso.
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
+**Campos:**
+No requiere enviar campos.
+**Ejemplo:**
+%%https://api.beaware360.com/ba360/apir/v12/checklist/tareas/get?idcaso=129%%
+----
+=== Response ===
+El sistema retorna las tareas asociadas al paso del caso específico.
+**Ejemplo:**
+<code java>
+{
+    "data": [
+        {
+            "tipo": 0,
+            "valor": 0,
+            "descripcion": "Acordar con el cliente la fecha y hora de la sesión",
+            "activo": 1,
+            "expiracion": 0,
+            "fhsubmit": null,
+            "totalchecklisttareas": null,
+            "idtipo": 0,
+            "idusuariomodificacion": null,
+            "estadoaprobacion": null,
+            "comentario": null,
+            "status": 0,
+            "idencuesta": null,
+            "idchecklist": 15,
+            "orden": 1,
+            "idurl": null,
+            "idhtml": null,
+            "idscript": null,
+            "idaprobacion": null,
+            "script": null,
+            "estadocaso": 0,
+            "obligatorio": 1,
+            "fhmodificacion": null,
+            "estadoactividad": 0,
+            "idchecklistdesc": "SPA - Contactar al cliente",
+            "urlexpiracion": -1,
+            "autosave": 0,
+            "id": 370,
+            "eid": null,
+            "uuid": null
+        },
+        {
+            "tipo": 5,
+            "valor": 0,
+            "descripcion": "Encuesta de prueba",
+            "activo": 1,
+            "expiracion": 0,
+            "fhsubmit": null,
+            "totalchecklisttareas": null,
+            "idtipo": 1,
+            "idusuariomodificacion": null,
+            "estadoaprobacion": null,
+            "comentario": null,
+            "status": 0,
+            "idencuesta": null,
+            "idchecklist": 15,
+            "orden": 4,
+            "idurl": null,
+            "idhtml": null,
+            "idscript": null,
+            "idaprobacion": null,
+            "script": null,
+            "estadocaso": 0,
+            "obligatorio": 1,
+            "fhmodificacion": null,
+            "estadoactividad": 0,
+            "idchecklistdesc": "SPA - Contactar al cliente",
+            "urlexpiracion": -1,
+            "autosave": 0,
+            "id": 333,
+            "eid": null,
+            "uuid": null
+        }
+    ],
+    "code": 200,
+    "message": null,
+    "pagination": null
+}</code>
+----
+==== Hacer check en tarea de un caso ====
+----
+=== Método ===
+''**PUT**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v12/caso/done%%**.
+----
+=== Request: ===
+**Parámetros:**
+  Este recurso no recibe parámetros
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
+**Campos:**
+^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
+| idcaso | Id del caso al que pertenece la tarea | Integer | Sí |  | 28 |
+| idtarea | Id de la tarea que se quiere checkear | Integer | Sí |  | 100 |
+| origin | Ambiente desde el que se genera el chequeo | String | Sí |  | “ba360review.deskbeaware.com” |
+**Ejemplo:**
+<code java>
+{
+	"idcaso": 39206,
+	"idtarea": 323,
+	"origin": "ba360review.deskbeaware.com"
+}
+</code>
+----
+=== Response ===
+El sistema hace check a la tarea en el caso.
+**Ejemplo:**
+<code java>
+{
+    "data": {
+        "checklist": {
+            "idactividad": null,
+            "idusuario": 8,
+            "fhsubmit": null,
+            "idcaso": 39026,
+            "idusuariomodificacion": 8,
+            "idtarea": 323,
+            "estadoaprobacion": null,
+            "comentario": null,
+            "status": 1,
+            "origin": "ba360review.deskbeaware.com",
+            "idtareadesc": null,
+            "idusuariodesc": null,
+            "fhmodificacion": null,
+            "id": 2012,
+            "eid": null,
+            "uuid": null
+        }
+    },
+    "code": 200,
+    "message": null,
+    "pagination": null
+}</code>
+----
+==== Hacer uncheck en tarea de un caso ====
+----
+=== Método ===
+''**PUT**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v12/caso/undone%%**.
+----
+=== Request: ===
+**Parámetros:**
+  Este recurso no recibe parámetros
+**Autenticación:**
+Este recurso requiere que se envíe en los Headers los parámetros relacionados en [[apiba360_12#Configuración Headers para todos los recursos de la API de Be Aware 360|Configuración Headers para todos los recursos de la API de Be Aware 360]].
+**Campos:**
+^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
+| idcaso | Id del caso al que pertenece la tarea | Integer | Sí |  | 28 |
+| idtarea | Id de la tarea que se quiere checkear | Integer | Sí |  | 100 |
+| origin | Ambiente desde el que se genera el chequeo | String | Sí |  | “ba360review.deskbeaware.com” |
+**Ejemplo:**
+<code java>
+{
+	"idcaso": 39206,
+	"idtarea": 323,
+	"origin": "ba360review.deskbeaware.com"
+}
+</code>
+----
+=== Response ===
+El sistema hace uncheck a la tarea en el caso.
+**Ejemplo:**
+<code java>
+{
+    "data": {
+        "idactividad": null,
+        "idusuario": 8,
+        "fhsubmit": null,
+        "idcaso": 39026,
+        "idusuariomodificacion": 8,
+        "idtarea": 323,
+        "estadoaprobacion": null,
+        "comentario": null,
+        "status": 0,
+        "origin": "ba360review.deskbeaware.com",
+        "idtareadesc": null,
+        "idusuariodesc": null,
+        "fhmodificacion": null,
+        "id": 2012,
+        "eid": null,
+        "uuid": null
+    },
+    "code": 200,
+    "message": null,
+    "pagination": null
+}
+</code>
+----