Diferencias

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

--- apiba360 [2021/01/26 15:39] – scantor
+++ apiba360 [2024/09/13 21:03] (actual) – [Uso de la API REST de Be Aware 360] aolano
@@ Línea 1: / Línea 1: @@
 ====== Uso de la API REST de Be Aware 360 ======
+**Importante**: La versión 10 de la API se encuentra deprecada y no se debe seguir usando (no recibe actualizaciones). Por favor modificar sus integraciones a la versión 10.5
 En esta sección podrá encontrar la información de la API REST de **Be Aware 360** para consultar y administrar la información almacenada en su instancia de Be Aware 360.
@@ Línea 9: / Línea 11: @@
   * Una guía a través de ejemplos simples para el uso de los recursos de la API REST.
-Adicional, podrá visualizar el **[[tecnicamente#Webinar: Crea casos con la API de Be Aware 360|webinar sobre la creación de casos usando la API de Be Aware 360]]**.
+Adicional, podrá visualizar el **[[tecnicamente#Webinar: Atienda sus clientes de principio a fin con Be Aware 360|Webinar: Atienda sus clientes de principio a fin con Be Aware 360]]**.
 El listado de todos los recursos de la API REST son:
@@ Línea 27: / Línea 29: @@
 | [[apiba360#Actualizar contacto|Actualizar contacto]] | Actualiza un contacto en Be Aware 360 | PUT | %%https://api.beaware360.com/ba360/apir/v10/contacto/upd%% |
 | [[apiba360#Eliminar contacto|Eliminar contacto]] | Elimina un contacto en Be Aware 360 | DELETE | %%https://api.beaware360.com/ba360/apir/v10/contacto/del/?id=<id_contacto>%% |
+| [[apiba360#Validar correo del contacto|Validar correo del contacto]] | Envía el correo de verificación al contacto para que pueda verificar su correo electrónico. | POST | %%https://api.beaware360.com/ba360/apir/v10/contacto/verificar%% |
 ----
@@ Línea 558: / Línea 561: @@
 === Response ===
-El sistema crea el contacto con la información que se ha enviado a través de la API.
+El sistema crea el contacto con la información que se ha enviado a través de la API. Si se quiere enviar el correo de verificación al contacto, se debe utilizar la API de [[apiba360#Validar correo del contacto|Validación de correo del contacto]].
 **Ejemplo:**
@@ Línea 789: / Línea 792: @@
     "code": 200,
     "message": "Contaccto eliminado con éxito.",
+    "pagination": null
+}
+</code>
+----
+==== Validar correo del contacto ====
+----
+=== Método ===
+''**POST**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v10/contacto/verificar%%**.
+----
+=== Request: ===
+**Parámetros:**
+  Este recurso no recibe parámetros.
+**Campos:**
+^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
+| email | Correo electrónico del contacto | String | Sí | Se debe usar el correo del contacto que recibirá el correo de verificación. | “correo1@beaware.com” |
+| idcontacto | Id del contacto | Integer | Sí | Corresponde al Id que le otorga Be Aware 360 al contacto. | 1409 |
+| origin | Nombre de la instancia de Be Aware 360 | String | Sí |  | “ba360review.deskbeaware.com” |
+**Ejemplo:**
+<code java>
+{
+    "email":"correo1@beaware.com",
+    "idcontacto":1409,
+    "origin":"ba360review.deskbeaware.com"
+}
+</code>
+----
+=== Response ===
+El sistema envía el correo electrónico de verificación al contacto.
+**Ejemplo:**
+<code java>
+{
+    "data": {
+        "email": [],
+        "fono": [],
+        "fonocp": null,
+        "facebook": null,
+        "instagram": null,
+        "twitter": null,
+        "idsla": 1,
+        "idcuenta": null,
+        "company": null,
+        "origin": null,
+        "fechanacimiento": "1983-03-16",
+        "grupocuentas": [],
+        "emailcp": null,
+        "cargo": "Bibliotecaria",
+        "grupocuentasstring": "2",
+        "lang": "es",
+        "fechacreacion": "2021-08-18 17:38:27.0",
+        "fechamodificacion": null,
+        "cf": {
+            "hobbie_principal": "Lectura",
+            "fecha_ingreso_empresa": "2020-01-06T05:00:00.000Z"
+        },
+        "identificador": "42123222",
+        "nombre": "Contacto",
+        "apellido": "Prueba",
+        "pass": null,
+        "gruposkills": [],
+        "idtipo": null,
+        "direccion": "Calle 145 # 15A - 50",
+        "titulo": null,
+        "idcuentadesc": null,
+        "uuid": null,
+        "eid": null,
+        "id": 1409
+    },
+    "code": 200,
+    "message": null,
     "pagination": null
 }
@@ Línea 1332: / Línea 1427: @@
   * **[[apiba360#Consultar histórico de casos|Consultar histórico de casos:]]** %%https://api.beaware360.com/ba360/apir/v10/caso/get/?filtro=history&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>%%.
+  * **[[apiba360#Consultar histórico de casos API ligera|Consultar histórico de casos API ligera:]]** %%https://api.beaware360.com/ba360/apir/v10/caso/historylite/get/?filtro=history&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>%%
   * **[[apiba360#Consultar casos abiertos|Consultar casos abiertos:]]** %%https://api.beaware360.com/ba360/apir/v10/caso/get?filtro=getall&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>%%.
   * **[[apiba360#Consultar casos en espera|Consultar casos en espera:]]** %%https://api.beaware360.com/ba360/apir/v10/caso/get?filtro=waiting&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>%%.
@@ Línea 1529: / Línea 1625: @@
         "size": 490,
         "actualPage": null
+    }
+}
+</code>
+----
+==== Consultar histórico de casos API ligera ====
+----
+=== Método ===
+''**GET**''
+----
+=== URL Recurso ===
+**%%https://api.beaware360.com/ba360/apir/v10/caso/historylite/get/?filtro=history&pagina=<pagina>&cantidad=<cantidad_casos_por_pagina>%%**.
+----
+=== Request: ===
+**Parámetros:**
+  filtro -> history.
+  pagina -> Indica el número de página que se desea consultar. Sirve para hacer paginación.
+  cantidad -> Indica la cantidad de casos a mostrar por página.
+**Campos:**
+  No requiere enviar campos.
+**Autenticación:**
+^ Tipo de autenticación ^ Usuario ^ Contraseña ^
+| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
+{{:authorization.png|}}
+----
+=== Response ===
+Retorna la lista de todos los casos sin tener en cuenta el estado, grupo o usuario asignado al caso. Este servicio entrega una respuesta acotada respecto al servicio de histórico normal. Con esto, se espera una respuesta del servicio en un tiempo menor permitiendo consultas de gran cantidad de casos.
+La respuesta del servicio entrega los mismos campos que la API del histórico de casos, pero solo retornará valores para los siguientes campos:
+^ Campo ^ Descripción ^
+| id | Identificador único del caso asignado por Be Aware 360. |
+| idestado | Identificador del estado asignado al caso. |
+| idestadodesc | Descripción del estado asignado al caso. |
+| refnum | Número del caso. |
+| idcontacto | Identificador del contacto asignado al caso. |
+| idcontactodesc | Nombre del contacto asignado al caso. |
+| idcuenta | Identificador de la cuenta asignada al caso. |
+| razonsocial | Nombre de la cuenta asignada al caso. |
+| idusuarioasignado | Identificador del usuario asignado al caso. |
+| idusuarioasignadodesc | Nombre del usuario asignado al caso. |
+| idproducto | Identificador del producto asignado al caso. |
+| idproductodesc | Nombre del producto asignado al caso. |
+| idtipo | Identificador del motivo asignado al caso. |
+| idtipodesc | Nombre del motivo asignado al caso. |
+| idsubtipo | Identificador del submotivo asignado al caso. |
+| idsubtipodesc | Nombre del submotivo asignado al caso. |
+| origen | Nombre del canal por el cual se creó el caso. |
+| asunto | Asunto del caso. |
+| fechacreacion | Fecha de creación del caso. |
+| finalizado | Indica si el caso está finalizado. 0 indica que el caso no está finalizado y 1 indica que sí está finalizado el caso. |
+**Ejemplo:**
+<code java>
+{
+    "data": [
+        {
+            "checkList": null,
+            "idworkflow": null,
+            "idtipo": 53,
+            "idworkflowdesc": null,
+            "idestado": 7,
+            "fechamodificacionhora": null,
+            "idusuariocreacion": null,
+            "idusuarioasignado": 91,
+            "idstageactual": null,
+            "asunto": "Caso de prueba",
+            "descripcion": null,
+            "idproducto": 1,
+            "idsubtipo": 22,
+            "origen": "Voz",
+            "finalizado": 1,
+            "idsla": null,
+            "idcontacto": 116,
+            "idcuenta": null,
+            "cf": {},
+            "fechacreacion": "2021-01-12",
+            "idusuariomodificacion": null,
+            "porcentaje": null,
+            "canal": null,
+            "idinteraccion": null,
+            "idconversacion": null,
+            "duedate": null,
+            "destacado": null,
+            "refnum": "210112-000540",
+            "idprioridad": null,
+            "fechamodificacion": null,
+            "cantidadcasos": null,
+            "idcuentadesc": null,
+            "idusuarioasignadodesc": "dquinapallo",
+            "idcontactodesc": "JUAN PEREZ",
+            "idestadodesc": "Solucionado",
+            "sistemaexterno": null,
+            "slavalue": null,
+            "fingreso": null,
+            "flexible": null,
+            "primerpaso": null,
+            "psolucionado": "0",
+            "pcreado": "0",
+            "ppendiente": "0",
+            "horastranscurridas2": null,
+            "idsladesc": null,
+            "totalnotas2": null,
+            "horastranscurridas": null,
+            "urgente": null,
+            "normal": null,
+            "totalnotas": null,
+            "solucionado": null,
+            "creado": null,
+            "pendiente": null,
+            "totalcasos": null,
+            "fechacreacionstr": "2021-01-12T00:00",
+            "fechamodificacionstr": null,
+            "timeactual": null,
+            "idprioridadcolor": null,
+            "idstageactualdesc": null,
+            "idtipodesc": "Soporte back",
+            "idusuariomodificaciondesc": null,
+            "idusuariocreaciondesc": null,
+            "idproductodesc": "Requerimiento",
+            "idsubtipodesc": "Soporte",
+            "idprioridaddesc": null,
+            "logauditoria": null,
+            "fechafinalizacionhoralimit": null,
+            "fechamodificacionhoralimit": null,
+            "fechareapertura": null,
+            "id": 82432,
+            "eid": null,
+            "uuid": null
+        },
+        {
+            "checkList": null,
+            "idworkflow": null,
+            "idtipo": 10,
+            "idworkflowdesc": null,
+            "idestado": 7,
+            "fechamodificacionhora": null,
+            "idusuariocreacion": null,
+            "idusuarioasignado": 33,
+            "idstageactual": null,
+            "asunto": "Caso de prueba 2",
+            "descripcion": null,
+            "idproducto": 2,
+            "idsubtipo": 22,
+            "origen": "Voz",
+            "finalizado": 1,
+            "idsla": null,
+            "idcontacto": 29740,
+            "idcuenta": null,
+            "cf": {},
+            "fechacreacion": "2021-01-12",
+            "idusuariomodificacion": null,
+            "porcentaje": null,
+            "canal": null,
+            "idinteraccion": null,
+            "idconversacion": null,
+            "duedate": null,
+            "destacado": null,
+            "refnum": "210112-000539",
+            "idprioridad": null,
+            "fechamodificacion": null,
+            "cantidadcasos": null,
+            "idcuentadesc": null,
+            "idusuarioasignadodesc": "rortiz",
+            "idcontactodesc": "MARTA ALVARADO",
+            "idestadodesc": "Solucionado",
+            "sistemaexterno": null,
+            "slavalue": null,
+            "fingreso": null,
+            "flexible": null,
+            "primerpaso": null,
+            "psolucionado": "0",
+            "pcreado": "0",
+            "ppendiente": "0",
+            "horastranscurridas2": null,
+            "idsladesc": null,
+            "totalnotas2": null,
+            "horastranscurridas": null,
+            "urgente": null,
+            "normal": null,
+            "totalnotas": null,
+            "solucionado": null,
+            "creado": null,
+            "pendiente": null,
+            "totalcasos": null,
+            "fechacreacionstr": "2021-01-12T00:00",
+            "fechamodificacionstr": null,
+            "timeactual": null,
+            "idprioridadcolor": null,
+            "idstageactualdesc": null,
+            "idtipodesc": "Solicitud",
+            "idusuariomodificaciondesc": null,
+            "idusuariocreaciondesc": null,
+            "idproductodesc": "Requerimiento",
+            "idsubtipodesc": "No aplica",
+            "idprioridaddesc": null,
+            "logauditoria": null,
+            "fechafinalizacionhoralimit": null,
+            "fechamodificacionhoralimit": null,
+            "fechareapertura": null,
+            "id": 82431,
+            "eid": null,
+            "uuid": null
+        }
+    ],
+    "code": 200,
+    "message": null,
+    "pagination": {
+        "cantPages": 41040,
+        "size": 82079,
+        "actualPage": 100
     }
 }
@@ Línea 2076: / Línea 2403: @@
 === URL Recurso ===
-**%%https://api.beaware360.com/ba360/apir/v10/caso/get/?icontacto=<id_contacto_ba360>%%.
+**%%https://api.beaware360.com/ba360/apir/v10/caso/get/?icontacto=<id_contacto_ba360>%%**.
 ----
@@ Línea 2989: / Línea 3316: @@
 **%%https://api.beaware360.com/ba360/apir/v10/producto/get%%**.
+Este endpoint devuelve los productos, teniendo en cuenta el valor que esté configurado en la Lista de parámetros de la instancia.
+Cuando consume este endpoint, se mostrarán los productos según la información que está en los parámetros de configuración en el apartado **Tipificación caso en creación**:
+  * //No considerar grupos// → Muestra todos los productos dado que no considera grupos de contactos o agentes.
+  * //Considerar grupos de contactos// → Muestra todos los productos dado que, para este endpoint, no se tiene en cuenta el grupo de contactos.
+  * //Considerar grupos de agentes// → Muestra solo los productos asociados a los grupos a los que el usuario, que está ejecutando el endpoint, pertenece.
+**%%https://api.beaware360.com/ba360/apir/v10/producto/get?principal=1%%**.
+Este endpoint devuelve todos productos cargados en la instancia sin importar la parametrización de la Lista de parámetros.
+Para más información sobre la parametrización de Tipificación caso en creación, haga clic [[parametrosdeconfiguracion#(parametros_de_casos)|aquí.]]
 ----
@@ Línea 3906: / Línea 4249: @@
 | IDOBJETO | Id del caso al que se le agregará el archivo. | Integer | Sí |  | 203 |
 | TIPOOBJETO | Especifica el tipo de objeto de la nota. | String | Sí | Valor: "casos" | casos |
-| TAGS | Especifica la etiqueta que llevará el archivo adjunto al caso. | String | No |  | Prueba API |
+| TAGS | Especifica la etiqueta que llevará el archivo adjunto al caso. | String | Sí | Acepta valores vacíos, pero es obligatorio que se envíe en el request. | Prueba API |
 | FILE | Archivo adjunto del caso | Archivo (Formato binario). | Sí | De acuerdo con el lenguaje de programación que se esté empleando, se deben usar las funciones para cargar el archivo y generar dicho archivo en formato binario. |  |
 | IDUSUARIO | Identifica el ID de usuario que hace la carga del archivo al caso. | Integer | Sí |  | 3 |
@@ Línea 3935: / Línea 4278: @@
 === Método ===
-''**GET**''
+''**POST**''
 ----