Cómo integrar la API v3 de búsqueda por texto de Impresee
Este documento describe cómo integrar los servicios de búsqueda por texto de Impresee en tu tienda en línea.
Pasos previos
- Obtener un Impresee app
UUID
, el cual es una cadena de 36 caracteres. Este código puede ser generado en nuestro Impresee Console o puedes solicitarnos que creemos uno por ti.
Consulta
Para buscar debes utilizar el siguiente servicio REST:
https://api.impresee.com/ImpreseeSearch/api/v3/search/text/<your_impresee_application_UUID>
Se debe enviar un mensaje JSON mediante el método POST. El JSONtiene el siguiente formato:
La siguiente lista describe cada campo del JSON:
- query_text: it corresponds to the text that the user writes. It can be complete or incomplete words (as the user is typing).
- query_id: Identificador de la búsqueda anterior. En la primera búsqueda el id es vacío.
- page_size: tamaño de cada página.
- num_page: la página que se desea mostrar, parte desde 0.
- search_type: una de las siguientes constantes describe la acción del usuario:
- INSTANT: para la búsqueda que se ejecuta mientras se tipea, no se calculan filtros.
- FULL: búsqueda completa, se calculan y muestran filtros.
- FILTER: filtrar una búsqueda.
- REORDER: el usuario escogió una opción de reordenamiento.
- PAGE: el usuario cambió de página.
- search_filter: Un arreglo con los filtros de producto a utilizar durante la búsqueda. Cada elemento del arreglo requiere el código de filtro y los valores a utilizar. Para los filtros por selección se deben marcar uno o más valores. Para los filtros de rango se esperan dos valores numéricos.
- search_reorder: El código de reordenamiento. Por los defecto los productos se ordenan por relevancia en un orden descendente.
Respuesta
El servicio de búsqueda retorna un JSON con la lista de productos que cumplen con las condiciones y atributos especificados en la consulta..
Es siguiente es un JSON de respuesta:
Cada producto tiene la siguiente información:
Usando tu cuenta en Impresee Console podrás configurar los atributos que se exportarán en el JSON. De esta manera es posible mostrar información extra por producto.
Impresee proporciona una biblioteca JavaScript que se puede configurar fácilmente para integrar el motor de búsqueda con cualquier sitio web en poco tiempo. Se pueden encontrar más detalles sobre la biblioteca para la integración y cómo integrar la búsqueda visual aquí.