Diferencias

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

Enlace a la vista de comparación

Ambos lados, revisión anteriorRevisión previa
Próxima revisión		Revisión previa
apiba360_105 [2025/04/03 21:15] – scantorapiba360_105 [2025/05/16 21:53] (actual) – [Cambiar Contraseña Perfil Usuario] aolano
Línea 30: Línea 30:
  
 ---- ----
 +
 +==== Usuarios ====
 +
 +^ 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/v10_5/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/v10_5/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/v10_5/usuario/add%% |
 +| [[apiba360_105#Actualizar usuario|Actualizar usuario]] | Actualiza un usuario en Be Aware 360 | PUT | %%https://api.beaware360.com/ba360/apir/v10_5/usuario/upd%% |
 +| [[apiba360_105#Eliminar usuario|Eliminar usuario]] | Elimina un usuario en Be Aware 360 | DELETE | %%https://api.beaware360.com/ba360/apir/v10_5/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/v10_5/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/v10_5/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/v10_5/perfilusuario/cambiopass%% |
 +
 +----
 +
  
 ==== Cuentas ==== ==== Cuentas ====
Línea 894: Línea 909:
         "uuid": null,         "uuid": null,
         "id": 90         "id": 90
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +===== Recursos para Usuarios =====
 +
 +==== Consultar Usuarios ====
 +
 +----
 +
 +=== Método === 
 +
 +''**GET**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +Existen distintas formas de consultar usuarios a través de la API. A continuación, se detallan:
 +
 +  * **Consultar todos los usuarios :** %%https://api.beaware360.com/ba360/apir/v10_5/usuario/get%%.
 +  * **Consultar usuario por parámetros:** %%https://api.beaware360.com/ba360/apir/v10_5/usuario/get/?parametro=valor%%.
 +  * **Consultar usuarios con paginación:** %%https://api.beaware360.com/ba360/apir/v10_5/usuario/get/?pagina=<pagina>&cantidad=<cantidad_usuarios_a_mostrar_por_pagina>%%.
 +  * **Consultar usuario por filtro:** %%https://api.beaware360.com/ba360/apir/v10_5/usuario/get?filtrobuscar=<filtro>&pagina=<pagina>&cantidad=<cantidad_usuarios_a_mostrar_por_pagina>%%.
 +
 +----
 +
 +=== Request: ===
 +
 +**Autenticación:**
 +
 +^ Tipo de autenticación ^ Usuario ^ Contraseña ^
 +| Basic Auth | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +----
 +
 +Existen distintas formas de consultar usuarios a través de la API. A continuación, se detallan:
 +
 +=== 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://api.beaware360.com/ba360/apir/v10_5/usuario/get/?id=10
 +https://api.beaware360.com/ba360/apir/v10_5/usuario/getby?email=oskcar@gmail.invalid
 +</code>
 +  
 +----
 +
 +=== 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://api.beaware360.com/ba360/apir/v10_5/usuario/get?pagina=1&cantidad=2
 +</code>
 +
 +----
 +
 +=== 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://api.beaware360.com/ba360/apir/v10_5/usuario/get?filtrobuscar=calle&pagina=1&cantidad=100
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Retorna la lista de los usuarios según el criterio de búsqueda.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "idusuario": null,
 +        "identificador": null,
 +        "nombre": "Agente",
 +        "apellido": "Atención3",
 +        "pass": null,
 +        "email": "agente3@nomail.com",
 +        "idrol": 4,
 +        "language": "es",
 +        "estado": 1,
 +        "user": "aatenciontres",
 +        "timezone": "America/Santiago",
 +        "idhorario": 9,
 +        "multisession": 0,
 +        "gruposkills": [
 +            7
 +        ],
 +        "idsusuariossupervisadosin": null,
 +        "idsusuariossupervisadosout": 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
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Consultar usuario por ID ====
 +
 +----
 +
 +=== Método === 
 +
 +''**GET**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/usuario/getby?id=<id_usuario>%%**.
 +
 +----
 +
 +=== 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 | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v10_5/usuario/getby?id=60
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Retorna la información de un usuario en específico, según su Id en Be Aware 360.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "idusuario": null,
 +        "identificador": null,
 +        "nombre": "Agente",
 +        "apellido": "Atención3",
 +        "pass": null,
 +        "email": "agente3@nomail.com",
 +        "idrol": 4,
 +        "language": "es",
 +        "estado": 1,
 +        "user": "aatenciontres",
 +        "timezone": "America/Santiago",
 +        "idhorario": 9,
 +        "multisession": 0,
 +        "gruposkills": [
 +            7
 +        ],
 +        "idsusuariossupervisadosin": null,
 +        "idsusuariossupervisadosout": 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
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +
 +----
 +
 +==== Crear usuario ====
 +
 +----
 +=== Método === 
 +
 +''**POST**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/usuario/add%%**.
 +
 +----
 +
 +=== 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í |  | "correo3@beaware.com” |
 +| user | Username | String | Sí |  | "correo3@beaware.com” |
 +| email | Correo electrónico del usuario | String | Sí |  | "correo3@beaware.com” |
 +| pass | Clave del usuario para ingresar a consola | String | Sí |  | "83247dfasjdl” |
 +| idempresa | Id de la empresa asociada al usuario | Int | No | 1 |
 +| idrol | Id del rol asignado | Int | Si | 1 |
 +| estado | Estado del usuario (Activo/Inactivo) | Si |  | 1 |
 +| gruposkills | Id's los grupos asociados al usuario | Int(list) | No | [1, 2 ,3] |
 +| language | Id del Idioma Asociado | String | No | "es" |
 +| timezone | Zona horaria del usuario | String | Si | Acepta la zona horario en formato Continente/País | "America/Buenos Aires" |
 +| idhorario | Id del horario laboral asociado al usuario | Int | Si | 1 |
 +| ID Externo | Id externo del usuario | String | No | "dfasdjhfadf" |
 +| 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>
 +{
 +    "nombre": "prueba",
 +    "apellido": "usuario",
 +    "email": "fasdfon@nomail.com",
 +    "user": "dsfuoasdf",
 +    "pass": "dfjañlsdfja",
 +    "idrol": 2,
 +    "estado": 1,
 +    "gruposkills": [
 +        2,
 +        3
 +    ],
 +    "idempresa": 1,
 +    "language": "es",
 +    "timezone": "America/Buenos_Aires",
 +    "idhorario": 4,
 +    "idexternal": "fsdfadf",
 +    "segmentaciones": [
 +        2,
 +        3
 +    ],
 +    "conceptodefecto": 1
 +}
 +</code>
 +
 +----
 +
 +=== 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#Validar correo del usuario|Validación de correo del usuario]].
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "idusuario": null,
 +        "identificador": null,
 +        "nombre": "prueba",
 +        "apellido": "usuario",
 +        "pass": null,
 +        "email": "fasdfon@nomail.com",
 +        "idrol": 2,
 +        "language": "es",
 +        "estado": 1,
 +        "user": "dsfuoasdf",
 +        "timezone": "America/Buenos_Aires",
 +        "idhorario": 4,
 +        "multisession": 0,
 +        "gruposkills": [
 +            2,
 +            3
 +        ],
 +        "idsusuariossupervisadosin": null,
 +        "idsusuariossupervisadosout": null,
 +        "cf": {},
 +        "latitud": null,
 +        "longitud": null,
 +        "idgrupo": null,
 +        "segmentaciones": [
 +            2,
 +            3
 +        ],
 +        "idempresa": 1,
 +        "grupousuariosplus": null,
 +        "conceptodefecto": 1,
 +        "isopais": null,
 +        "idexternal": "fsdfadf",
 +        "notificacionactiva": 1,
 +        "idsusuariossupervisados": null,
 +        "fechacreacion": "2025-05-16 21:08:42",
 +        "fechamodificacion": null,
 +        "gruposskillsdesc": null,
 +        "primeringreso": 0,
 +        "fechaultimaasignacion": null,
 +        "fechaposicion": null,
 +        "avatar": null,
 +        "cantidadcasos": 0,
 +        "portada": null,
 +        "idgrupodesc": null,
 +        "idpermisodesc": null,
 +        "idpermiso": null,
 +        "acceso": "0",
 +        "idroldesc": "Administrador OLD",
 +        "idempresadesc": "Equipo de implementación de negocios",
 +        "idhorariodesc": null,
 +        "id": 168,
 +        "eid": null,
 +        "uuid": null
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== 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 === 
 +
 +''** POST **''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/usuario/upd%%**.
 +
 +----
 +
 +=== 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í |  | "correo3@beaware.com” |
 +| user | Username | String | Sí |  | "correo3@beaware.com” |
 +| email | Correo electrónico del usuario | String | Sí |  | "correo3@beaware.com” |
 +| pass | Clave del usuario para ingresar a consola | String | Sí |  | "83247dfasjdl” |
 +| idempresa | Id de la empresa asociada al usuario | Int | No | 1 |
 +| idrol | Id del rol asignado | Int | Si | 1 |
 +| estado | Estado del usuario (Activo/Inactivo) | Si |  | 1 |
 +| gruposkills | Id's los grupos asociados al usuario | Int(list) | No | [1, 2 ,3] |
 +| language | Id del Idioma Asociado | String | No | "es" |
 +| timezone | Zona horaria del usuario | String | Si | Acepta la zona horario en formato Continente/País | "America/Buenos Aires" |
 +| idhorario | Id del horario laboral asociado al usuario | Int | Si | 1 |
 +| ID Externo | Id externo del usuario | String | No | "dfasdjhfadf" |
 +| 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>
 +{
 +    "nombre": "Agente",
 +    "apellido": "Atención3",
 +    "email": "scantor@grupoinmotion.com",
 +    "idrol": 4,
 +    "language": "es",
 +    "estado": 1,
 +    "user": "aatencion3",
 +    "timezone": "America/Santiago",
 +    "idhorario": 9,
 +    "multisession": 1,
 +    "gruposkills": [
 +        7
 +    ],
 +    "cf": {},
 +    "segmentaciones": [],
 +    "id": 12       
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema actualiza el usuario con la información que se ha enviado a través de la API.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 + "idrol": 4,
 + "idusuario": null,
 + "identificador": null,
 + "nombre": "Agente",
 + "apellido": "Atención3",
 + "pass": null,
 + "email": "scantor@grupoinmotion.com",
 + "language": "es",
 + "estado": 1,
 + "user": "aatencion3",
 + "timezone": "America/Santiago",
 + "idhorario": 9,
 + "multisession": 1,
 + "gruposkills": [
 + 7
 + ],
 + "idsusuariossupervisadosin": null,
 + "idsusuariossupervisadosout": null,
 + "cf": {},
 + "latitud": null,
 + "longitud": null,
 + "idgrupo": null,
 + "segmentaciones": [],
 + "idempresa": null,
 + "grupousuariosplus": null,
 + "conceptodefecto": null,
 + "isopais": null,
 + "idexternal": null,
 + "notificacionactiva": 1,
 + "idsusuariossupervisados": null,
 + "gruposskillsdesc": null,
 + "primeringreso": 1,
 + "fechacreacion": "2020-06-27 00:00:06",
 + "fechamodificacion": "2025-05-16 21:25:25",
 + "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
 +}
 +</code>
 +
 +----
 +
 +==== Eliminar usuario ====
 +
 +----
 +
 +=== Método === 
 +
 +''**DELETE**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/usuario/del/?id=<id_usuario>%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  id -> Id del usuario.
 +
 +**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_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v10_5/usuario/del?id=5
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Elimina un usuario en específico de la base de datos de Be Aware 360.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "idusuario": null,
 +        "identificador": null,
 +        "nombre": null,
 +        "apellido": null,
 +        "pass": null,
 +        "email": null,
 +        "idrol": null,
 +        "language": null,
 +        "estado": null,
 +        "user": null,
 +        "timezone": null,
 +        "idhorario": null,
 +        "multisession": null,
 +        "gruposkills": [],
 +        "idsusuariossupervisadosin": null,
 +        "idsusuariossupervisadosout": null,
 +        "cf": {},
 +        "latitud": null,
 +        "longitud": null,
 +        "idgrupo": null,
 +        "segmentaciones": [],
 +        "idempresa": null,
 +        "grupousuariosplus": null,
 +        "conceptodefecto": null,
 +        "isopais": null,
 +        "idexternal": null,
 +        "notificacionactiva": null,
 +        "idsusuariossupervisados": null,
 +        "fechacreacion": null,
 +        "fechamodificacion": null,
 +        "gruposskillsdesc": null,
 +        "primeringreso": null,
 +        "fechaultimaasignacion": null,
 +        "fechaposicion": null,
 +        "avatar": null,
 +        "cantidadcasos": null,
 +        "portada": null,
 +        "idgrupodesc": null,
 +        "idpermisodesc": null,
 +        "idpermiso": null,
 +        "acceso": null,
 +        "idroldesc": null,
 +        "idempresadesc": null,
 +        "idhorariodesc": null,
 +        "id": 168,
 +        "eid": null,
 +        "uuid": null
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Consultar Perfil Usuario ====
 +
 +----
 +
 +=== Método === 
 +
 +''**GET**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/perfilusuario/getby?id=<id_usuario>%%**.
 +
 +----
 +
 +=== 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 | //compañia/usuario//. Por ejemplo ba360review/aatencion | El Token obtenido en [[apiba360_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v10_5/perfilusuario/getby?id=8
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Muestra los datos del usuario autenticado.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +  "data": {
 +    "idusuario": null,
 +    "identificador": null,
 +    "nombre": "Germán Andres",
 +    "apellido": "Olano ",
 +    "pass": null,
 +    "email": "e_golano@inmotion.cl",
 +    "idrol": 9,
 +    "language": "es",
 +    "estado": null,
 +    "user": "golano",
 +    "timezone": "America/Mexico_City",
 +    "idhorario": 1,
 +    "multisession": null,
 +    "gruposkills": [],
 +    "idsusuariossupervisadosin": null,
 +    "idsusuariossupervisadosout": null,
 +    "cf": {},
 +    "latitud": null,
 +    "longitud": null,
 +    "idgrupo": null,
 +    "segmentaciones": [],
 +    "idempresa": 1,
 +    "grupousuariosplus": null,
 +    "conceptodefecto": null,
 +    "isopais": null,
 +    "idexternal": null,
 +    "notificacionactiva": null,
 +    "idsusuariossupervisados": null,
 +    "fechacreacion": null,
 +    "fechamodificacion": null,
 +    "gruposskillsdesc": [
 +      "Atención mejoras",
 +      "AUDITOR LIQUIDADOR UIO GYE",
 +      "Grupo Rec ChatBot",
 +      "Grupo Rec Contact Center",
 +      "Grupo Atención",
 +      "Oficina Pasto Pymes",
 +      "Oficina Fusagasugá",
 +      "Grupo de prueba",
 +      "A1L - OTRAS CONSULTAS",
 +      "A2L - MEDICINA GENERAL",
 +      "A1L - OBSTETRICIA",
 +      "A1L - INFORMACIÓN CORONAVIRUS",
 +      "A1L - PSICOLOGÍA",
 +      "Prueba consola"
 +    ],
 +    "primeringreso": null,
 +    "fechaultimaasignacion": null,
 +    "fechaposicion": null,
 +    "avatar": null,
 +    "cantidadcasos": 168,
 +    "portada": null,
 +    "idgrupodesc": null,
 +    "idpermisodesc": null,
 +    "idpermiso": null,
 +    "acceso": null,
 +    "idroldesc": "Administrador",
 +    "idempresadesc": "Equipo de implementación de negocios",
 +    "idhorariodesc": "Lunes A Viernes",
 +    "id": 8,
 +    "eid": null,
 +    "uuid": null
 +  },
 +  "code": 200,
 +  "message": null,
 +  "pagination": null
 +}
 +</code>
 +
 +----
 +==== Actualizar Perfil Usuario ====
 +
 +----
 +
 +=== Método === 
 +
 +''**PUT**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/perfilusuario/upd%%**.
 +
 +----
 +
 +=== 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í |  | "correo3@beaware.com” |
 +| language | Id del Idioma Asociado | String | No | "es" |
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "nombre": "Agente",
 +    "apellido": "Atención3",
 +    "email": "test@grupoinmotion.com",
 +    "language": "es",
 +    "id": 1000  
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema actualiza el usuario con la información que se ha enviado a través de la API.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "idusuario": null,
 +        "identificador": null,
 +        "nombre": "Agente",
 +        "apellido": "Atencion3",
 +        "pass": null,
 +        "email": "test@grupoinmotion.com",
 +        "idrol": 9,
 +        "language": "es",
 +        "estado": null,
 +        "user": "agente3",
 +        "timezone": "America/Mexico_City",
 +        "idhorario": 1,
 +        "multisession": null,
 +        "gruposkills": [],
 +        "idsusuariossupervisadosin": null,
 +        "idsusuariossupervisadosout": null,
 +        "cf": {},
 +        "latitud": null,
 +        "longitud": null,
 +        "idgrupo": null,
 +        "segmentaciones": [],
 +        "idempresa": 1,
 +        "grupousuariosplus": null,
 +        "conceptodefecto": null,
 +        "isopais": null,
 +        "idexternal": null,
 +        "notificacionactiva": null,
 +        "idsusuariossupervisados": null,
 +        "fechacreacion": null,
 +        "fechamodificacion": null,
 +        "gruposskillsdesc": [],
 +        "primeringreso": null,
 +        "fechaultimaasignacion": null,
 +        "fechaposicion": null,
 +        "avatar": null,
 +        "cantidadcasos": 168,
 +        "portada": null,
 +        "idgrupodesc": null,
 +        "idpermisodesc": null,
 +        "idpermiso": null,
 +        "acceso": null,
 +        "idroldesc": "Administrador",
 +        "idempresadesc": "Equipo de implementación de negocios",
 +        "idhorariodesc": "Lunes A Viernes",
 +        "id": 10000
 +        "eid": null,
 +        "uuid": null
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Cambiar Contraseña Perfil Usuario ====
 +
 +----
 +
 +=== Método === 
 +
 +''**PUT**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/cambiopass%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  No requiere parámetros
 +
 +**Campos:**
 +
 + ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 +| pass1 | Clave actual usuario | Strint | Sí |  | "Pasa1" |
 +| pass2 | Nueva clave del usuario | String | Sí |  | “Pasa2” |
 +| pass3 | Confirmación nueva clave | String | Sí |  | “Pasa2” |
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +  "pass1": "Pasa.123",
 +  "pass2": "Pasa.1234",
 +  "pass3": "Pasa.1234"
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema actualiza el usuario con la información que se ha enviado a través de la API.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "idusuario": null,
 +        "identificador": null,
 +        "nombre": "Agente",
 +        "apellido": "Atencion3",
 +        "pass": "Pasa.1234",
 +        "email": "test@grupoinmotion.com",
 +        "idrol": 9,
 +        "language": "es",
 +        "estado": null,
 +        "user": "agente3",
 +        "timezone": "America/Mexico_City",
 +        "idhorario": 1,
 +        "multisession": null,
 +        "gruposkills": [],
 +        "idsusuariossupervisadosin": null,
 +        "idsusuariossupervisadosout": null,
 +        "cf": {},
 +        "latitud": null,
 +        "longitud": null,
 +        "idgrupo": null,
 +        "segmentaciones": [],
 +        "idempresa": 1,
 +        "grupousuariosplus": null,
 +        "conceptodefecto": null,
 +        "isopais": null,
 +        "idexternal": null,
 +        "notificacionactiva": null,
 +        "idsusuariossupervisados": null,
 +        "fechacreacion": null,
 +        "fechamodificacion": null,
 +        "gruposskillsdesc": [],
 +        "primeringreso": null,
 +        "fechaultimaasignacion": null,
 +        "fechaposicion": null,
 +        "avatar": null,
 +        "cantidadcasos": 168,
 +        "portada": null,
 +        "idgrupodesc": null,
 +        "idpermisodesc": null,
 +        "idpermiso": null,
 +        "acceso": null,
 +        "idroldesc": "Administrador",
 +        "idempresadesc": "Equipo de implementación de negocios",
 +        "idhorariodesc": "Lunes A Viernes",
 +        "id": 10000
 +        "eid": null,
 +        "uuid": null
     },     },
     "code": 200,     "code": 200,
Línea 1454: Línea 2467:
 Existen distintas formas de consultar cuentas a través de la API. A continuación, se detallan: Existen distintas formas de consultar cuentas a través de la API. A continuación, se detallan:
  
-  * **Consultar todas los grupos:** %%https://api.beaware360.com/ba360/apir/v11/grupo/get%%. +  * **Consultar todos los grupos:** %%https://api.beaware360.com/ba360/apir/v11/gruposkill/get%%. 
-  * **Consultar grupos por parámetros:** %%https://api.beaware360.com/ba360/apir/v11/grupo/get/?parametro=valor%%. +  * **Consultar grupos por parámetros:** %%https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?parametro=valor%%. 
-  * **Consultar grupos con paginación:** %%https://api.beaware360.com/ba360/apir/v11/grupo/get/?pagina=<pagina>&cantidad=<cantidad_grupos_a_mostrar_por_pagina>%%. +  * **Consultar grupos con paginación:** %%https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?pagina=<pagina>&cantidad=<cantidad_grupos_a_mostrar_por_pagina>%%. 
-  * **Consultar grupo por filtro:** %%https://api.beaware360.com/ba360/apir/v11/grupo/get/?filtrobuscar=<filtro>&pagina=<pagina>&cantidad=<cantidad_grupos_a_mostrar_por_pagina>%%.+  * **Consultar grupo por filtro:** %%https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?filtrobuscar=<filtro>&pagina=<pagina>&cantidad=<cantidad_grupos_a_mostrar_por_pagina>%%.
  
 ---- ----
Línea 1500: Línea 2513:
  
 <code java> <code java>
-https://api.beaware360.com/ba360/apir/v11/grupo/get/?idgrupo=1+https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?idgrupo=1
  
 </code> </code>
Línea 1520: Línea 2533:
  
 <code java> <code java>
-https://api.beaware360.com/ba360/apir/v11/grupo/get/?pagina=1&cantidad=10+https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?pagina=1&cantidad=10
 </code> </code>
  
Línea 1538: Línea 2551:
  
 <code java> <code java>
-https://api.beaware360.com/ba360/apir/v11/grupo/get/?filtrobuscar=soft&pagina=1&cantidad=10+https://api.beaware360.com/ba360/apir/v11/gruposkill/get/?filtrobuscar=soft&pagina=1&cantidad=10
 </code> </code>
  
Línea 1562: Línea 2575:
         }         }
     ],     ],
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +==== Crear grupo ====
 +
 +----
 +=== Método === 
 +
 +''**POST**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v11/gruposkill/add%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  Este recurso no recibe parámetros
 +
 +**Campos:**
 +
 +^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 +| nombre | Nombre del grupo | String | Sí | Este campo tiene una validación que sea menor a 255 caracteres. | “Grupo API” |
 +| descripcion | Descripción del grupo | String | No | Debe ser único. Este campo tiene una validación que sea menor a 20 caracteres. | “Grupo creado desde API” |
 +| tipo | Grupo Usuario / Contacto | Integer | No | Indica si el grupo será de usuarios o contactos | 1 |
 +| grupousuarios | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| pordefecto | Grupo por defecto para usuarios | String | No | Indica si será un grupo por defecto para nuevos usuarios | 0 |
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +  "nombre": "grupo API",
 +  "descripcion": "grupo creado desde API",
 +  "tipo": 1,
 +  "grupousuarios": [],
 +  "pordefecto": 0
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema crea la cuenta con la información que se ha enviado a través de la API.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "nombre": "grupo API",
 +        "descripcion": "grupo creado desde API",
 +        "tipo": 1,
 +        "grupocontactos": null,
 +        "grupocontactosplus": null,
 +        "grupocontactosout": null,
 +        "grupocontactosin": null,
 +        "pordefecto": 0,
 +        "multityping": null,
 +        "descmultityping": null,
 +        "grupousuariosplus": null,
 +        "grupousuariosout": null,
 +        "grupousuariosin": null,
 +        "contactosfuera": null,
 +        "gruposkillrelacion": null,
 +        "grupousuarios": null,
 +        "gruposkillmultityping": null,
 +        "total": null,
 +        "eid": null,
 +        "uuid": null,
 +        "id": 55
 +    },
 +    "code": 200,
 +    "message": "Cuenta creada con éxito.",
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Actualizar grupo ====
 +
 +**Nota:** Para utilizar este recurso es necesario siempre enviar todos los campos del grupo y sus valores correspondientes y únicamente modificar los valores de los campos que se vayan a actualizar.
 +
 +----
 +=== Método === 
 +
 +''**PUT**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v11/gruposkill/upd%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  Este recurso no recibe parámetros
 +
 +**Campos:**
 +
 +^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 +| nombre | Nombre del grupo | String | Sí | Nombre del grupo | "grupo API actualizado" |
 +| descripcion | Descripción del grupo | String | Sí | Descripción del grupo | "grupo creado desde API" |
 +| tipo | Tipo de grupo | Integer | Sí | Grupo de contactos o usuarios | 2 |
 +| grupocontactos | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupocontactosplus | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupocontactosout | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupocontactosin | Grupo de contactos | Integer | No | Lista de IDs de contactos que se añaden al grupo. **Nota:** Aplica si el grupo es Tipo Contacto | [1, 2, 3, 4, 5] |
 +| pordefecto | Grupo por defecto | Integer | No | Indica si el grupo es predeterminado para los usuarios nuevos | 0 |
 +| multityping | Tipificaciones del grupo | Integer | No | Indica las tipificaciones asociadas al grupo | [1, 2] |
 +| descmultityping | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupousuariosplus | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupousuariosout | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupousuariosin | Grupo de usuarios | Integer | No | Lista de IDs de usuarios que se añaden al grupo. **Nota:** Aplica si el grupo es Tipo Usuario | [1, 2, 3, 4, 5] |
 +| contactosfuera | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| gruposkillrelacion | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| grupousuarios | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| gruposkillmultityping | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| total | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| eid | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| uuid | En construcción | En construcción | En construcción | En construcción | En construcción |
 +| id | Identificador del grupo | Integer | Sí | Identifica el grupo que se va a actualizar | 58 |
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 + {
 +  "nombre": "grupo API actualizado",
 +  "descripcion": "grupo creado desde API",
 +  "tipo": 2,
 +  "grupocontactos": [],
 +  "grupocontactosplus": null,
 +  "grupocontactosout": null,
 +  "grupocontactosin": [1, 2, 3, 4, 5],
 +  "pordefecto": 0,
 +  "multityping": [1, 2],
 +  "descmultityping": {},
 +  "grupousuariosplus": null,
 +  "grupousuariosout": null,
 +  "grupousuariosin": [7, 8, 9, 10, 11],
 +  "contactosfuera": null,
 +  "gruposkillrelacion": null,
 +  "grupousuarios": null,
 +  "gruposkillmultityping": null,
 +  "total": null,
 +  "eid": null,
 +  "uuid": null,
 +  "id": 58
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema actualiza el grupo con la información que se ha enviado a través de la API.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "nombre": "grupo API actualizado",
 +        "descripcion": "grupo creado desde API",
 +        "tipo": 2,
 +        "grupocontactos": null,
 +        "grupocontactosplus": null,
 +        "grupocontactosout": null,
 +        "grupocontactosin": null,
 +        "pordefecto": 0,
 +        "multityping": [
 +            1,
 +            2
 +        ],
 +        "descmultityping": {
 +            "1": "Soporte BeAware 360",
 +            "2": "Requerimientos BA360"
 +        },
 +        "grupousuariosplus": null,
 +        "grupousuariosout": null,
 +        "grupousuariosin": null,
 +        "contactosfuera": null,
 +        "gruposkillrelacion": null,
 +        "grupousuarios": null,
 +        "gruposkillmultityping": null,
 +        "total": null,
 +        "eid": null,
 +        "uuid": null,
 +        "id": 58
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}
 +</code>
 +
 +----
 +
 +==== Eliminar grupo ====
 +
 +----
 +
 +=== Método === 
 +
 +''**DELETE**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v11/gruposkill/del/?id=<id_cuenta>%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  id -> Id del grupo.
 +
 +**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_105#Paso 3. Obtenga el token (GetToken)|GetToken]]. |
 +
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +https://api.beaware360.com/ba360/apir/v11/gruposkill/del/?id=58
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +Elimina una grupo específica de la base de datos de Be Aware 360.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "nombre": null,
 +        "descripcion": null,
 +        "tipo": null,
 +        "grupocontactos": null,
 +        "grupocontactosplus": null,
 +        "grupocontactosout": null,
 +        "grupocontactosin": null,
 +        "pordefecto": null,
 +        "multityping": null,
 +        "descmultityping": null,
 +        "grupousuariosplus": null,
 +        "grupousuariosout": null,
 +        "grupousuariosin": null,
 +        "contactosfuera": null,
 +        "gruposkillrelacion": null,
 +        "grupousuarios": null,
 +        "gruposkillmultityping": null,
 +        "total": null,
 +        "eid": null,
 +        "uuid": null,
 +        "id": 58
 +    },
     "code": 200,     "code": 200,
     "message": null,     "message": null,
apiba360_105.1743714910.txt.gz · Última modificación: por scantor
Excepto donde se indique lo contrario, el contenido de este wiki esta bajo la siguiente licencia: CC Attribution-Noncommercial-Share Alike 4.0 International


  • Ver página
  • Revisiones antiguas
  • Enlaces a esta página
  • Cambios recientes
  • Administrador de Ficheros
  • Índice