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_105 [2025/05/16 21:12] – [Consultar usuario por ID] aolano | apiba360_105 [2025/05/16 21:53] (actual) – [Cambiar Contraseña Perfil Usuario] aolano | ||
---|---|---|---|
Línea 1341: | Línea 1341: | ||
---- | ---- | ||
+ | ==== 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> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
===== Recursos para Cuentas ===== | ===== Recursos para Cuentas ===== |