Diferencias
Muestra las diferencias entre dos versiones de la página.
apiba360 [2020/10/27 23:03] – scantor | apiba360 [2024/03/05 15:41] (actual) – editor externo 127.0.0.1 | ||
---|---|---|---|
Línea 9: | Línea 9: | ||
* Una guía a través de ejemplos simples para el uso de los recursos de la API REST. | * Una guía a través de ejemplos simples para el uso de los recursos de la API REST. | ||
- | Adicional, podrá visualizar el **[[tecnicamente# | + | Adicional, podrá visualizar el **[[tecnicamente# |
El listado de todos los recursos de la API REST son: | El listado de todos los recursos de la API REST son: | ||
Línea 27: | Línea 27: | ||
| [[apiba360# | | [[apiba360# | ||
| [[apiba360# | | [[apiba360# | ||
+ | | [[apiba360# | ||
---- | ---- | ||
Línea 558: | Línea 559: | ||
=== 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 790: | ||
" | " | ||
" | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== 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> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
" | " | ||
} | } | ||
Línea 1030: | Línea 1123: | ||
^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^ | ^ Campo API ^ Descripción ^ Tipo de dato ^ Requerido ^ Comentario ^ Ejemplo ^ | ||
- | | razonsocial | Razón social de la cuenta | String | Sí | | “In Motion” | | + | | razonsocial | Razón social de la cuenta | String | Sí | Este campo tiene una validación que sea menor a 255 caracteres. |
- | | identificador | Identificador de la cuenta | String | Sí | Debe ser único | “900262501-1” | | + | | identificador | Identificador de la cuenta | String | Sí | Debe ser único. Este campo tiene una validación que sea menor a 20 caracteres. |
| idsla | Acuerdo de la cuenta | Integer | Sí | Corresponde al Id del acuerdo creado en Be Aware 360 y que se le asignará a la cuenta | 1 | | | idsla | Acuerdo de la cuenta | Integer | Sí | Corresponde al Id del acuerdo creado en Be Aware 360 y que se le asignará a la cuenta | 1 | | ||
- | | direccion | Dirección de la cuenta | String | No | | “Carrera 11A # 93- 52” | | + | | direccion | Dirección de la cuenta | String | No | Este campo tiene una validación que sea menor a 255 caracteres. |
- | | email | Correo electrónico de la cuenta | String | No | | " | + | | email | Correo electrónico de la cuenta | String | No | Este campo tiene una validación que sea menor a 45 caracteres. |
- | | facebook | Id de Facebook de la cuenta | String | No | | “1234567890987654” | | + | | facebook | Id de Facebook de la cuenta | String | No | Este campo tiene una validación que sea menor a 100 caracteres. |
- | | instagram | Usuario de Instagram de la cuenta | String | No | | “@imcol” | | + | | instagram | Usuario de Instagram de la cuenta | String | No | Este campo tiene una validación que sea menor a 100 caracteres. |
- | | twitter | Usuario de Twitter de la cuenta | String | No | | “@immex” | | + | | twitter | Usuario de Twitter de la cuenta | String | No | Este campo tiene una validación que sea menor a 100 caracteres. |
- | | giro | Giro o actividad económica de la cuenta | String | No | | “Servicios de tecnología” | | + | | giro | Giro o actividad económica de la cuenta | String | No | Este campo tiene una validación que sea menor a 200 caracteres. |
- | | paginaweb | Página web de la cuenta | String | No | | “www.grupoinmotion.com” | | + | | paginaweb | Página web de la cuenta | String | No | Este campo tiene una validación que sea menor a 100 caracteres. |
| telefono | Teléfono de la cuenta | String | No | Solo acepta caracteres numéricos. Es importante que el teléfono vaya con el prefijo correspondiente | " | | telefono | Teléfono de la cuenta | String | No | Solo acepta caracteres numéricos. Es importante que el teléfono vaya con el prefijo correspondiente | " | ||
| idrepresentante | Contacto que corresponde al representante de la cuenta | Integer | No | Id del contacto que corresponde al representante de la cuenta | 118 | | | idrepresentante | Contacto que corresponde al representante de la cuenta | Integer | No | Id del contacto que corresponde al representante de la cuenta | 118 | | ||
Línea 1332: | Línea 1425: | ||
* **[[apiba360# | * **[[apiba360# | ||
+ | * **[[apiba360# | ||
* **[[apiba360# | * **[[apiba360# | ||
* **[[apiba360# | * **[[apiba360# | ||
* **[[apiba360# | * **[[apiba360# | ||
+ | * **[[apiba360# | ||
---- | ---- | ||
Línea 1528: | Línea 1623: | ||
" | " | ||
" | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== 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 2057: | Línea 2383: | ||
" | " | ||
" | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ==== Consultar caso por Id contacto ==== | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Método === | ||
+ | |||
+ | '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === URL Recurso === | ||
+ | |||
+ | **%%https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Request: === | ||
+ | |||
+ | **Parámetros: | ||
+ | |||
+ | idcontacto -> Indica el identificador del contacto que otorga Be Aware 360. | ||
+ | |||
+ | **Campos:** | ||
+ | |||
+ | No requiere enviar campos. | ||
+ | |||
+ | **Autenticación: | ||
+ | |||
+ | ^ Tipo de autenticación ^ Usuario ^ Contraseña ^ | ||
+ | | Basic Auth | // | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ---- | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | Retorna la lista de todos los casos asignados al contacto por el cual se está realizando la búsqueda. | ||
+ | |||
+ | **Ejemplo: | ||
+ | |||
+ | <code java> | ||
+ | { | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
} | } | ||
} | } | ||
Línea 2635: | Línea 3314: | ||
**%%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 3552: | Línea 4247: | ||
| 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 3581: | Línea 4276: | ||
=== Método === | === Método === | ||
- | '' | + | '' |
---- | ---- |