Diferencias
Muestra las diferencias entre dos versiones de la página.
Ambos lados, revisión anteriorRevisión previaPróxima revisión | Revisión previa | ||
apiba360 [2021/01/26 16:00] – [Uso de la API REST de Be Aware 360] scantor | apiba360 [2025/05/16 21:54] (actual) – [Validar correo del contacto] aolano | ||
---|---|---|---|
Línea 1: | Línea 1: | ||
====== Uso de la API REST de Be Aware 360 ====== | ====== Uso de la API REST de Be Aware 360 ====== | ||
+ | |||
+ | **Importante**: | ||
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. | 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# | | [[apiba360# | ||
| [[apiba360# | | [[apiba360# | ||
+ | | [[apiba360# | ||
---- | ---- | ||
+ | |||
+ | ==== Usuarios ==== | ||
+ | |||
+ | ^ Recursos ^ Descripción ^ Método ^ URL Recurso ^ | ||
+ | | [[apiba360_105# | ||
+ | | [[apiba360_105# | ||
+ | | [[apiba360_105# | ||
+ | | [[apiba360_105# | ||
+ | | [[apiba360_105# | ||
+ | | [[apiba360_105# | ||
+ | | [[apiba360_105# | ||
+ | | [[apiba360_105# | ||
+ | |||
+ | ---- | ||
+ | |||
==== Cuentas ==== | ==== Cuentas ==== | ||
Línea 558: | Línea 576: | ||
=== Response === | === 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# |
**Ejemplo: | **Ejemplo: | ||
Línea 789: | Línea 807: | ||
" | " | ||
" | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Validar correo del contacto ==== | ||
+ | |||
+ | ---- | ||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === 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> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | El sistema envía el correo electrónico de verificación al contacto. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== Recursos para Usuarios ===== | ||
+ | |||
+ | ==== Consultar Usuarios ==== | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | Existen distintas formas de consultar usuarios a través de la API. A continuación, | ||
+ | |||
+ | * **Consultar todos los usuarios :** %%https:// | ||
+ | * **Consultar usuario por parámetros: | ||
+ | * **Consultar usuarios con paginación: | ||
+ | * **Consultar usuario por filtro:** %%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Request: === | ||
+ | |||
+ | **Autenticación: | ||
+ | |||
+ | ^ Tipo de autenticación ^ Usuario ^ Contraseña ^ | ||
+ | | Basic Auth | // | ||
+ | |||
+ | ---- | ||
+ | |||
+ | Existen distintas formas de consultar usuarios a través de la API. A continuación, | ||
+ | |||
+ | === Consultar todos los usuarios=== | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | Este recurso no recibe parámetros. | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | No requiere enviar campos para el listado completo de usuarios. | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Consultar usuario por parámetros === | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | id -> Recibe el id del usuario | ||
+ | email -> Recibe el correo electrónico del usuario. | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | No requiere enviar campos. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | https:// | ||
+ | https:// | ||
+ | </ | ||
+ | | ||
+ | ---- | ||
+ | |||
+ | === Consultar usuarios con paginación === | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | pagina -> Indica el número de página a retornar. | ||
+ | cantidad -> Indica el número de usuarios a retornar por página. | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | No requiere enviar campos. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | https:// | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Consultar usuario por filtro === | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | filtrobuscar -> Permite buscar por nombre, apellido, email, dirección, título e identificador. | ||
+ | pagina -> Indica el número de página que se desea consultar. Sirve para hacer paginación. | ||
+ | cantidad -> Indica la cantidad de usuarios a mostrar por página. | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | No requiere enviar campos. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | https:// | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | Retorna la lista de los usuarios según el criterio de búsqueda. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | 7 | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Consultar usuario por ID ==== | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Request: === | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | id -> Recibe el id del usuario en Be Aware 360. | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | No requiere enviar campos. | ||
+ | | ||
+ | **Autenticación: | ||
+ | |||
+ | ^ Tipo de autenticación ^ Usuario ^ Contraseña ^ | ||
+ | | Basic Auth | // | ||
+ | |||
+ | |||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | https:// | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | Retorna la información de un usuario en específico, | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | 7 | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Crear usuario ==== | ||
+ | |||
+ | ---- | ||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Request: === | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | Este recurso no recibe parámetros | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^ | ||
+ | | nombre | Nombre del usuario | String | Sí | | “Josefina” | | ||
+ | | apellido | Apellido del usuario | String | Sí | | “Fernández” | | ||
+ | | email | Correo electrónico del usuario | String | Sí | | " | ||
+ | | user | Username | String | Sí | | " | ||
+ | | email | Correo electrónico del usuario | String | Sí | | " | ||
+ | | pass | Clave del usuario para ingresar a consola | String | Sí | | " | ||
+ | | idempresa | Id de la empresa asociada al usuario | Int | No | 1 | | ||
+ | | idrol | Id del rol asignado | Int | Si | 1 | | ||
+ | | estado | Estado del usuario (Activo/ | ||
+ | | gruposkills | Id's los grupos asociados al usuario | Int(list) | No | [1, 2 ,3] | | ||
+ | | language | Id del Idioma Asociado | String | No | " | ||
+ | | timezone | Zona horaria del usuario | String | Si | Acepta la zona horario en formato Continente/ | ||
+ | | idhorario | Id del horario laboral asociado al usuario | Int | Si | 1 | | ||
+ | | ID Externo | Id externo del usuario | String | No | " | ||
+ | | segmentaciones | Id de los segmentos asociados al usuario | Int(List) | No | [1, 2, 3] | | ||
+ | | conceptopordefecto | Id del concepto asociado por defecto al usuario | Int | No | 1 | | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | 2, | ||
+ | 3 | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | 2, | ||
+ | 3 | ||
+ | ], | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | El sistema crea el usuario con la información que se ha enviado a través de la API. Si se quiere enviar el correo de verificación al usuario, se debe utilizar la API de [[apiba360_105# | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | 2, | ||
+ | 3 | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | 2, | ||
+ | 3 | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Actualizar usuario ==== | ||
+ | |||
+ | **Nota:** Para utilizar este recurso es necesario siempre enviar todos los campos del usuario y sus valores correspondientes y únicamente modificar los valores de los campos que se vayan a actualizar. | ||
+ | |||
+ | ---- | ||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Request: === | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | Este recurso no recibe parámetros | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^ | ||
+ | | id | id del usuario | Int | Sí | | 1 | | ||
+ | | nombre | Nombre del usuario | String | Sí | | “Josefina” | | ||
+ | | apellido | Apellido del usuario | String | Sí | | “Fernández” | | ||
+ | | email | Correo electrónico del usuario | String | Sí | | " | ||
+ | | user | Username | String | Sí | | " | ||
+ | | email | Correo electrónico del usuario | String | Sí | | " | ||
+ | | pass | Clave del usuario para ingresar a consola | String | Sí | | " | ||
+ | | idempresa | Id de la empresa asociada al usuario | Int | No | 1 | | ||
+ | | idrol | Id del rol asignado | Int | Si | 1 | | ||
+ | | estado | Estado del usuario (Activo/ | ||
+ | | gruposkills | Id's los grupos asociados al usuario | Int(list) | No | [1, 2 ,3] | | ||
+ | | language | Id del Idioma Asociado | String | No | " | ||
+ | | timezone | Zona horaria del usuario | String | Si | Acepta la zona horario en formato Continente/ | ||
+ | | idhorario | Id del horario laboral asociado al usuario | Int | Si | 1 | | ||
+ | | ID Externo | Id externo del usuario | String | No | " | ||
+ | | segmentaciones | Id de los segmentos asociados al usuario | Int(List) | No | [1, 2, 3] | | ||
+ | | conceptopordefecto | Id del concepto asociado por defecto al usuario | Int | No | 1 | | ||
+ | | cf | Campos personalizados del usuario | String (JSON) | No | {} | | ||
+ | |||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | 7 | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | El sistema actualiza el usuario con la información que se ha enviado a través de la API. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | 7 | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Eliminar usuario ==== | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Request: === | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | id -> Id del usuario. | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | No requiere enviar campos. | ||
+ | | ||
+ | **Autenticación: | ||
+ | |||
+ | ^ Tipo de autenticación ^ Usuario ^ Contraseña ^ | ||
+ | | Basic Auth | // | ||
+ | |||
+ | |||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | https:// | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | Elimina un usuario en específico de la base de datos de Be Aware 360. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Consultar Perfil Usuario ==== | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Request: === | ||
+ | |||
+ | **Parámetros: | ||
+ | º | ||
+ | id -> Id del usuario (Debe ser el mismo usuario que se ha autenticado). | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | No requiere enviar campos. | ||
+ | | ||
+ | **Autenticación: | ||
+ | |||
+ | ^ Tipo de autenticación ^ Usuario ^ Contraseña ^ | ||
+ | | Basic Auth | // | ||
+ | |||
+ | |||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | https:// | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | Muestra los datos del usuario autenticado. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | "Grupo Rec ChatBot", | ||
+ | "Grupo Rec Contact Center", | ||
+ | "Grupo Atención", | ||
+ | " | ||
+ | " | ||
+ | "Grupo de prueba", | ||
+ | "A1L - OTRAS CONSULTAS", | ||
+ | "A2L - MEDICINA GENERAL", | ||
+ | "A1L - OBSTETRICIA", | ||
+ | "A1L - INFORMACIÓN CORONAVIRUS", | ||
+ | "A1L - PSICOLOGÍA", | ||
+ | " | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | ==== Actualizar Perfil Usuario ==== | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Request: === | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | No requiere parámetros | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^ | ||
+ | | id | id del usuario | Int | Sí | | 1 | | ||
+ | | nombre | Nombre del usuario | String | Sí | | “Josefina” | | ||
+ | | apellido | Apellido del usuario | String | Sí | | “Fernández” | | ||
+ | | email | Correo electrónico del usuario | String | Sí | | " | ||
+ | | language | Id del Idioma Asociado | String | No | " | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | El sistema actualiza el usuario con la información que se ha enviado a través de la API. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Cambiar Contraseña Perfil Usuario ==== | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Request: === | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | No requiere parámetros | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^ | ||
+ | | pass1 | Clave actual usuario | Strint | Sí | | " | ||
+ | | pass2 | Nueva clave del usuario | String | Sí | | “Pasa2” | | ||
+ | | pass3 | Confirmación nueva clave | String | Sí | | “Pasa2” | | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | El sistema actualiza el usuario con la información que se ha enviado a través de la API. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
" | " | ||
} | } | ||
Línea 1332: | Línea 2440: | ||
* **[[apiba360# | * **[[apiba360# | ||
+ | * **[[apiba360# | ||
* **[[apiba360# | * **[[apiba360# | ||
* **[[apiba360# | * **[[apiba360# | ||
Línea 1529: | Línea 2638: | ||
" | " | ||
" | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Consultar histórico de casos API ligera ==== | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === 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 | // | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === 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> | ||
+ | { | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
} | } | ||
} | } | ||
Línea 2989: | Línea 4329: | ||
**%%https:// | **%%https:// | ||
+ | |||
+ | 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. | ||
+ | |||
+ | * // | ||
+ | |||
+ | * // | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | 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# | ||
---- | ---- | ||
Línea 3906: | Línea 5262: | ||
| IDOBJETO | Id del caso al que se le agregará el archivo. | Integer | Sí | | 203 | | | 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: " | | TIPOOBJETO | Especifica el tipo de objeto de la nota. | String | Sí | Valor: " | ||
- | | 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. |
| 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. | | | | 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 | | | IDUSUARIO | Identifica el ID de usuario que hace la carga del archivo al caso. | Integer | Sí | | 3 | | ||
Línea 3935: | Línea 5291: | ||
=== Método === | === Método === | ||
- | '' | + | '' |
---- | ---- |