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/05/16 21:52] – [Actualizar Perfil Usuario] aolanoapiba360_105 [2025/12/24 17:49] (actual) – [Paso 3. Obtenga el token (GetToken)] aolano
Línea 93: Línea 93:
 ^ Recursos ^ Descripción ^ Método ^ URL Recurso ^ ^ Recursos ^ Descripción ^ Método ^ URL Recurso ^
 | [[apiba360_105#Crear una actividad programada|Crear una actividad programada]] | Hace la creación de un caso en Be Aware 360. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/fsactividad/add%% | | [[apiba360_105#Crear una actividad programada|Crear una actividad programada]] | Hace la creación de un caso en Be Aware 360. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/fsactividad/add%% |
 +
 +==== Gestión del Checklist ====
 +
 +^ Recursos ^ Descripción ^ Método ^ URL Recurso ^
 +| [[apiba360_105#Consultar lista de tareas de un caso|Consultar lista de tareas del caso]] | Consultar las tareas de un caso específico. | GET | %%https://api.beaware360.com/ba360/apir/v10_5/checklist/tareas/get?idcaso=<id_caso>%% |
 +| [[apiba360_105#Hacer check en tarea de un caso|Hacer check en tarea de un caso]] | Hacer check a una tarea de un caso. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/caso/done%% |
 +| [[apiba360_105#Hacer uncheck en tarea de un caso|Hacer uncheck en tarea de un caso]] | Hacer uncheck a una tarea de un caso. | POST | %%https://api.beaware360.com/ba360/apir/v10_5/caso/undone%% |
 +
  
 ===== Primeros pasos ===== ===== Primeros pasos =====
Línea 216: Línea 224:
  
 Una vez haya obtenido el token, podrá consumir los recursos de la API REST de Be Aware 360. Una vez haya obtenido el token, podrá consumir los recursos de la API REST de Be Aware 360.
 +
 +** Importante **
 +
 +Control de Acceso por Intentos Fallidos (En Desarrollo) : El sistema realiza un bloqueo automático del proceso de autenticación de un usuario, cuando este realiza varios intentos fallidos de forma consecutiva
 +      - El máximo de intentos antes de que la cuenta sea bloqueada es de 5
 +      - El tiempo de bloqueo establecido es de 5 minutos
 +      - Pasados los 5 minutos el usuario podrá intentar de nuevo la autenticación
 +      - Cuando una cuenta esté bloqueada, el servicio API retornará el código 401
 +      - **Importante:** Este bloqueo se aplica para los intentos de login a través del FRONT (Consola) y de la API REST de Be Aware 360 (para más información sobre la autenticación en Consola de Be Aware  haga clic [[gestiondeusuarios#autenticacion_en_be_aware_360_en_desarrollo|aquí]].)
  
 ===== Recursos para Contactos ===== ===== Recursos para Contactos =====
Línea 1822: Línea 1839:
 === URL Recurso === === URL Recurso ===
  
-**%%https://api.beaware360.com/ba360/apir/v11/cambiopass%%**.+**%%https://api.beaware360.com/ba360/apir/v10_5/cambiopass%%**.
  
 ---- ----
Línea 5321: Línea 5338:
 | idcuenta | Cuenta a la que pertenece el contacto que está asociada al caso | Integer | No |  | 45 | | idcuenta | Cuenta a la que pertenece el contacto que está asociada al caso | Integer | No |  | 45 |
 | idsla | Id del acuerdo asociado al caso | Integer | No |  | 1 | | idsla | Id del acuerdo asociado al caso | Integer | No |  | 1 |
-| idworkflow | Id del proceso asociado al caso | Integer | No | No es necesario enviar este campo dado que la combinación del producto, motivo y submotivo asigna automáticamente el caso al proceso | 2 |+| idworkflow | Id del proceso asociado al caso | Integer | No | Es necesario enviar este campo si es un caso que tiene un proceso asociado; de lo contrario, se limpiará el proceso del caso. | 2 | 
 +| idstageactual | Id del paso del proceso asociado al caso | Integer | No | Es necesario enviar este campo si es un caso que tiene un proceso asociado para indicar en qué paso se encuentra el caso; de lo contrario, generará error la API. | 55 |
 | idusuarioasignado | Id del usuario asignado al caso | Integer | No | Esta es la lógica que emplea Be Aware 360 cuando se actualiza el asignado de un caso: \\ \\  * Si se envía ID asignado válido, lo asigna al caso. \\  * Si se envía ID asignado inválido, deja Caso sin asignado. \\  * Si no se envía parámetro de asignado, deja Caso sin asignado. \\  * Si se envía ID asignado NULL, deja al Caso sin asignado. \\  * Si se envía un ID asignado de un usuario que está //Inactivo//, lo asigna al Caso. | 3 | | idusuarioasignado | Id del usuario asignado al caso | Integer | No | Esta es la lógica que emplea Be Aware 360 cuando se actualiza el asignado de un caso: \\ \\  * Si se envía ID asignado válido, lo asigna al caso. \\  * Si se envía ID asignado inválido, deja Caso sin asignado. \\  * Si no se envía parámetro de asignado, deja Caso sin asignado. \\  * Si se envía ID asignado NULL, deja al Caso sin asignado. \\  * Si se envía un ID asignado de un usuario que está //Inactivo//, lo asigna al Caso. | 3 |
 | cf | Campos personalizados del caso | Lista (depende del tipo de campo) | Depende de la configuración del campo personalizado si fue marcado como obligatorio. | Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. **Nota:** Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 | {"guia": "2345", "fecha guía": "2020-01-06T05:00:00.000Z"} | | cf | Campos personalizados del caso | Lista (depende del tipo de campo) | Depende de la configuración del campo personalizado si fue marcado como obligatorio. | Lista de campos personalizados con su valor correspondiente, separados por comas y entre corchetes {}. **Nota:** Los campos de tipo fecha deben ir especificados con la zona horaria, de lo contrario tomará 00:00 UTC-0 | {"guia": "2345", "fecha guía": "2020-01-06T05:00:00.000Z"} |
 | id | Id del caso que se va a actualizar | Integer | Sí |  | 8 | | id | Id del caso que se va a actualizar | Integer | Sí |  | 8 |
 +| finalizado| Indica si el caso se encuentra finalizado o no | Integer | Sí |  | 1 |
  
 **Ejemplo:** **Ejemplo:**
Línea 5341: Línea 5360:
  "idworkflow": 11,  "idworkflow": 11,
  "idsla": 9,  "idsla": 9,
 +        "finalizado" : 0,
  "cf":   "cf": 
  {  {
Línea 6584: Línea 6604:
     "data": [     "data": [
         {         {
 +            "idusuario": 29,
 +            "nombre": "Domicilio.pdf",
             "idrol": 6,             "idrol": 6,
-            "nombre": "Archivo de prueba.pdf", +            "idobjeto": 1802, 
-            "idstage": 47,+            "tipoobjeto": "casos", 
 +            "seen": 0, 
 +            "fechacreacion": "2025-06-13 22:12:31", 
 +            "idstage": 110, 
 +            "tipodocumento": "Comprobante de domicilio",
             "metadatos": [             "metadatos": [
                 {                 {
-                    "clave": "GRUPO_DOCUMENTO", +                    "clave": "TipoArchivo", 
-                    "valor": "43"+                    "valor": "DOC"
                 },                 },
                 {                 {
-                    "clave": " TIPO_DOCUMENTO", +                    "clave": "IdArchivo", 
-                    "valor": "752"+                    "valor": "987654"
                 }                 }
             ],             ],
-            "idusuario": 29, +            "idtipodocumento": 5,
-            "idobjeto": 442, +
-            "tipoobjeto": "casos", +
-            "fechacreacion": "2025-03-17 21:38:07",+
             "file": null,             "file": null,
-            "idtipodocumento": 1, +            "idcontactodesc": "Pedro Gómez",
-            "seen": 0, +
-            "tipodocumento": "Acta de nacimiento",+
             "tag": "Archivo de prueba.pdf",             "tag": "Archivo de prueba.pdf",
             "filesize": 15895,             "filesize": 15895,
-            "clasificacion": null,+            "publico": 1,
             "idusuariodesc": "Juan Pérez",             "idusuariodesc": "Juan Pérez",
-            "idroldesc": "Ejecutivo de atención", +            "idroldesc": "Analista", 
-            "idstagedesc": "Registro información",+            "clasificacion": null, 
 +            "idstagedesc": "Análisis", 
 +            "id": 1732,
             "eid": null,             "eid": null,
-            "uuid": null, +            "uuid": null
-            "id": 255+
         },         },
         {         {
-            "idrol": 6,+            "idusuario": 29,
             "nombre": "Documento de reembolso.pdf",             "nombre": "Documento de reembolso.pdf",
-            "idstage": 47,+            "idrol": 6, 
 +            "idobjeto": 1802, 
 +            "tipoobjeto": "casos", 
 +            "seen": 0, 
 +            "fechacreacion": "2025-06-13 22:12:43", 
 +            "idstage": 110, 
 +            "tipodocumento": "Reembolso",
             "metadatos": [             "metadatos": [
                 {                 {
-                    "clave": "GRUPO_DOCUMENTO", +                    "clave": "TipoArchivo", 
-                    "valor": "5050010005"+                    "valor": "DOC"
                 },                 },
                 {                 {
-                    "clave": "TIPO_DOCUMENTO", +                    "clave": "IdArchivo", 
-                    "valor": "5050010005009"+                    "valor": "47382384"
                 }                 }
             ],             ],
-            "idusuario": 29, +            "idtipodocumento": 74,
-            "idobjeto": 442, +
-            "tipoobjeto": "casos", +
-            "fechacreacion": "2025-03-17 21:38:32",+
             "file": null,             "file": null,
-            "idtipodocumento": 5, +            "idcontactodesc": "Pedro Gómez",
-            "seen": 0, +
-            "tipodocumento": "Reembolso de pago",+
             "tag": "Documento de reembolso.pdf",             "tag": "Documento de reembolso.pdf",
             "filesize": 15804,             "filesize": 15804,
-            "clasificacion": null,+            "publico": 0,
             "idusuariodesc": "Juan Pérez",             "idusuariodesc": "Juan Pérez",
-            "idroldesc": "Ejecutivo de atención", +            "idroldesc": "Analista", 
-            "idstagedesc": "Análisis de Información",+            "clasificacion": null, 
 +            "idstagedesc": "Análisis", 
 +            "id": 1733,
             "eid": null,             "eid": null,
-            "uuid": null, +            "uuid": null
-            "id": 256+
         }         }
     ],     ],
Línea 6689: Línea 6713:
 ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^ ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 | COMPANYNAME | Instancia de Be Aware 360. | String | Sí |  | ba360review | | COMPANYNAME | Instancia de Be Aware 360. | String | Sí |  | ba360review |
-| IDOBJETO | Id del caso al que se le agregará el archivo. | Integer | Sí |  | 6542 |+| 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 | | 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 | Sí | Acepta valores vacíos, pero es obligatorio que se envíe en el request. | 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. |  | | 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í |  | 44 | +| IDUSUARIO | Identifica el ID de usuario que hace la carga del archivo al caso. | Integer | Sí |  | 3 | 
-| IDTIPODOCUMENTO | Identifica el ID del Catálogo de documentos con el que se subirá el archivo al caso. | Integer | No |  | 1 |+| IDTIPODOCUMENTO | Identifica el ID del tipo de documento asociado al archivo que se está cargando en el caso. | Integer | No |  | 22 | 
 +| PUBLICO | Identifica si el archivo que se está cargando en el caso es de carácter público o privado. | Integer | Sí | El valor 1 corresponde a Público y el valor 0 corresponde a Privado. | 1 |
  
 **Ejemplo:** **Ejemplo:**
  
-{{:api.png?1200|}}+{{:archivosadjuntos:archivos_carga_adjuntos_caso_10_5.png|Ejemplo de carga de archivos adjuntos desde Postman}}
  
 ---- ----
Línea 7141: Línea 7166:
  
 ---- ----
 +
 +
  
 ==== Consultar Catálogo de Documentos por ID ==== ==== Consultar Catálogo de Documentos por ID ====
Línea 7205: Línea 7232:
             "id": 2             "id": 2
         }         }
 +}
 +</code>
 +
 +----
 +
 +===== Gestión del Checklist =====
 +==== Consultar lista de tareas de un caso ====
 +
 +----
 +=== Método === 
 +
 +''**GET**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/checklist/tareas/get?idcaso=<id_caso>%%**
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +id_caso -> Corresponde al id del caso.
 +
 +**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]]. |
 +
 +
 +
 +**Campos:**
 +
 +No requiere enviar campos.
 +
 +**Ejemplo:**
 +
 +%%https://api.beaware360.com/ba360/apir/v10_5/checklist/tareas/get?idcaso=129%%
 +
 +----
 +
 +=== Response ===
 +
 +El sistema retorna las tareas asociadas al paso del caso específico.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": [
 +        {
 +            "tipo": 0,
 +            "valor": 0,
 +            "descripcion": "Acordar con el cliente la fecha y hora de la sesión",
 +            "activo": 1,
 +            "expiracion": 0,
 +            "fhsubmit": null,
 +            "totalchecklisttareas": null,
 +            "idtipo": 0,
 +            "idusuariomodificacion": null,
 +            "estadoaprobacion": null,
 +            "comentario": null,
 +            "status": 0,
 +            "idencuesta": null,
 +            "idchecklist": 15,
 +            "orden": 1,
 +            "idurl": null,
 +            "idhtml": null,
 +            "idscript": null,
 +            "idaprobacion": null,
 +            "script": null,
 +            "estadocaso": 0,
 +            "obligatorio": 1,
 +            "fhmodificacion": null,
 +            "estadoactividad": 0,
 +            "idchecklistdesc": "SPA - Contactar al cliente",
 +            "urlexpiracion": -1,
 +            "autosave": 0,
 +            "id": 370,
 +            "eid": null,
 +            "uuid": null
 +        },
 +        {
 +            "tipo": 5,
 +            "valor": 0,
 +            "descripcion": "Encuesta de prueba",
 +            "activo": 1,
 +            "expiracion": 0,
 +            "fhsubmit": null,
 +            "totalchecklisttareas": null,
 +            "idtipo": 1,
 +            "idusuariomodificacion": null,
 +            "estadoaprobacion": null,
 +            "comentario": null,
 +            "status": 0,
 +            "idencuesta": null,
 +            "idchecklist": 15,
 +            "orden": 4,
 +            "idurl": null,
 +            "idhtml": null,
 +            "idscript": null,
 +            "idaprobacion": null,
 +            "script": null,
 +            "estadocaso": 0,
 +            "obligatorio": 1,
 +            "fhmodificacion": null,
 +            "estadoactividad": 0,
 +            "idchecklistdesc": "SPA - Contactar al cliente",
 +            "urlexpiracion": -1,
 +            "autosave": 0,
 +            "id": 333,
 +            "eid": null,
 +            "uuid": null
 +        }
 +    ],
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}</code>
 +
 +----
 +
 +==== Hacer check en tarea de un caso ====
 +
 +----
 +=== Método === 
 +
 +''**POST**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/caso/done%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  Este recurso no recibe parámetros
 +
 +**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]]. |
 +
 +
 +
 +**Campos:**
 +
 +^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 +| idcaso | Id del caso al que pertenece la tarea | Integer | Sí |  | 28 |
 +| idtarea | Id de la tarea que se quiere checkear | Integer | Sí |  | 100 |
 +| origin | Ambiente desde el que se genera el chequeo | String | Sí |  | “ba360review.deskbeaware.com” |
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 + "idcaso": 39206,
 + "idtarea": 323,
 + "origin": "ba360review.deskbeaware.com"
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema hace check a la tarea en el caso.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "checklist": {
 +            "idactividad": null,
 +            "idusuario": 8,
 +            "fhsubmit": null,
 +            "idcaso": 39026,
 +            "idusuariomodificacion": 8,
 +            "idtarea": 323,
 +            "estadoaprobacion": null,
 +            "comentario": null,
 +            "status": 1,
 +            "origin": "ba360review.deskbeaware.com",
 +            "idtareadesc": null,
 +            "idusuariodesc": null,
 +            "fhmodificacion": null,
 +            "id": 2012,
 +            "eid": null,
 +            "uuid": null
 +        }
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 +}</code>
 +
 +----
 +
 +==== Hacer uncheck en tarea de un caso ====
 +
 +----
 +=== Método === 
 +
 +''**POST**''
 +
 +----
 +
 +=== URL Recurso ===
 +
 +**%%https://api.beaware360.com/ba360/apir/v10_5/caso/undone%%**.
 +
 +----
 +
 +=== Request: ===
 +
 +**Parámetros:**
 +
 +  Este recurso no recibe parámetros
 +
 +**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]]. |
 +
 +
 +
 +**Campos:**
 +
 +^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^
 +| idcaso | Id del caso al que pertenece la tarea | Integer | Sí |  | 28 |
 +| idtarea | Id de la tarea que se quiere checkear | Integer | Sí |  | 100 |
 +| origin | Ambiente desde el que se genera el chequeo | String | Sí |  | “ba360review.deskbeaware.com” |
 +
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 + "idcaso": 39206,
 + "idtarea": 323,
 + "origin": "ba360review.deskbeaware.com"
 +}
 +</code>
 +
 +----
 +
 +=== Response ===
 +
 +El sistema hace uncheck a la tarea en el caso.
 +
 +**Ejemplo:**
 +
 +<code java>
 +{
 +    "data": {
 +        "idactividad": null,
 +        "idusuario": 8,
 +        "fhsubmit": null,
 +        "idcaso": 39026,
 +        "idusuariomodificacion": 8,
 +        "idtarea": 323,
 +        "estadoaprobacion": null,
 +        "comentario": null,
 +        "status": 0,
 +        "origin": "ba360review.deskbeaware.com",
 +        "idtareadesc": null,
 +        "idusuariodesc": null,
 +        "fhmodificacion": null,
 +        "id": 2012,
 +        "eid": null,
 +        "uuid": null
 +    },
 +    "code": 200,
 +    "message": null,
 +    "pagination": null
 } }
 </code> </code>
apiba360_105.1747432362.txt.gz · Última modificación: por aolano
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