Diferencias

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

--- apiba360 [2021/05/14 21:04] – 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 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 3221: / 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í.]]
 ----