{"id":8105,"date":"2021-01-11T15:56:12","date_gmt":"2021-01-11T18:56:12","guid":{"rendered":"https:\/\/impresee.com\/?page_id=8105"},"modified":"2023-09-05T16:26:37","modified_gmt":"2023-09-05T19:26:37","slug":"how-to-integrate-impresee-search-by-text-api-v3","status":"publish","type":"page","link":"https:\/\/impresee.com\/es\/how-to-integrate-impresee-search-by-text-api-v3\/","title":{"rendered":"How to integrate Impresee Search by Text API v3"},"content":{"rendered":"<p>[et_pb_section fb_built=&#8221;1&#8243; _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; da_disable_devices=&#8221;off|off|off&#8221; global_colors_info=&#8221;{}&#8221; da_is_popup=&#8221;off&#8221; da_exit_intent=&#8221;off&#8221; da_has_close=&#8221;on&#8221; da_alt_close=&#8221;off&#8221; da_dark_close=&#8221;off&#8221; da_not_modal=&#8221;on&#8221; da_is_singular=&#8221;off&#8221; da_with_loader=&#8221;off&#8221; da_has_shadow=&#8221;on&#8221;][et_pb_row column_structure=&#8221;3_4,1_4&#8243; _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;][et_pb_column type=&#8221;3_4&#8243; _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; custom_padding=&#8221;||1px|||&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<h1 role=\"group\" aria-multiline=\"true\" aria-label=\"Block: Heading\" style=\"white-space: pre-wrap;\" class=\"block-editor-rich-text__editable block-editor-block-list__block wp-block is-hovered rich-text\" id=\"block-27a58a22-8038-4ed7-b74f-65e2e018acc6\" data-block=\"27a58a22-8038-4ed7-b74f-65e2e018acc6\" data-type=\"core\/heading\" data-title=\"Heading\" contenteditable=\"true\" tabindex=\"0\">How to integrate Impresee Search by Text API v3<\/h1>\n<p>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<p><strong>This document describes how you can integrate <em>Impresee search by text services<\/em> into your online store.<\/strong><\/p>\n<p>&nbsp;<\/p>\n<p>[\/et_pb_text][et_pb_text module_id=&#8221;previous-steps&#8221; _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<h2>Previous Steps<\/h2>\n<p>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<ul>\n<li>Obtain an Impresee application <strong><code>UUID<\/code><\/strong> this is a string with 36 characters. This code can be generated in the <a href=\"https:\/\/console.impresee.com\">Impresee Console<\/a> or you can ask us to generate one for you.<\/li>\n<\/ul>\n<p>[\/et_pb_text][et_pb_text module_id=&#8221;request&#8221; _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<h2>Request<\/h2>\n<p>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<p><span style=\"font-weight: 400;\">In order to search products you must use the following <strong>REST<\/strong> service:<\/span><\/p>\n<p>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<pre>https:\/\/api.impresee.com\/ImpreseeSearch\/api\/v3\/search\/text\/<strong>&lt;your_impresee_application_UUID&gt;<\/strong><\/pre>\n<p>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<p><span style=\"font-weight: 400;\">A <strong>JSON<\/strong> message must be sent to that service in <strong>POST<\/strong> mode. The <strong>JSON<\/strong> message has the following format:<\/span><\/p>\n<p>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<script src=\"https:\/\/gist.github.com\/CamilaAlvarez\/f799b5d22e2fb3a1038c5b93c99fd136.js\"><\/script>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<p><span style=\"font-weight: 400;\">The following list describes each <strong>JSON<\/strong> field:<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\"><b>query_text<\/b><span style=\"font-weight: 400;\">: it corresponds to the text that the user writes. It can be complete or incomplete words (as the user is typing).<\/span><\/li>\n<li style=\"font-weight: 400;\"><b>query_id<\/b><span style=\"font-weight: 400;\">: it is the identifier of the previous search. In the first search the id is empty.<\/span><\/li>\n<li style=\"font-weight: 400;\"><b>page_size<\/b><span style=\"font-weight: 400;\">: size of each page.<\/span><\/li>\n<li style=\"font-weight: 400;\"><b>num_page<\/b><span style=\"font-weight: 400;\">: the page you want to show, starting at 0.<\/span><\/li>\n<li style=\"font-weight: 400;\"><b>search_type<\/b><span style=\"font-weight: 400;\">: One of the following constants describing the user action:<\/span><\/li>\n<ul>\n<li style=\"font-weight: 400;\"><b>INSTANT<\/b><span style=\"font-weight: 400;\">: for search as you type, no filters are calculated<\/span><\/li>\n<li style=\"font-weight: 400;\"><b>FULL<\/b><span style=\"font-weight: 400;\">: full search, filters are calculated and shown to the user<\/span><\/li>\n<li style=\"font-weight: 400;\"><b>FILTER<\/b><span style=\"font-weight: 400;\">: filtering a search<\/span><\/li>\n<li style=\"font-weight: 400;\"><b>REORDER<\/b><span style=\"font-weight: 400;\">: a sort-by option is used<\/span><\/li>\n<li style=\"font-weight: 400;\"><b>PAGE<\/b><span style=\"font-weight: 400;\">: a page number is selected by user<\/span><\/li>\n<\/ul>\n<li style=\"font-weight: 400;\"><b>search_filter<\/b><span style=\"font-weight: 400;\">: An array with the product filters to use during the search. Each element of the array requires the filter code and the values to use. For filters by selection, one or more values must be marked. For range filters two numerical values are expected.<\/span><\/li>\n<li style=\"font-weight: 400;\"><b>search_reorder<\/b><span style=\"font-weight: 400;\">: The reorder-by code. By default products are sorted by relevance in descending order. The ordering code to be used must be written.<\/span><\/li>\n<\/ul>\n<p>[\/et_pb_text][et_pb_text module_id=&#8221;response&#8221; _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<h2>Response<\/h2>\n<p>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<p><span style=\"font-weight: 400;\">The search service returns a <strong>JSON<\/strong> message with the list of products that meet the condition and the attributes to be displayed to the user.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">This is a <strong>JSON<\/strong> response message:<\/span><\/p>\n<p>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<script src=\"https:\/\/gist.github.com\/CamilaAlvarez\/6795374f286058c78d075fc282aba95b.js\"><\/script>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<p><span style=\"font-weight: 400;\">Each product contains the following data:<\/span><\/p>\n<p>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<script src=\"https:\/\/gist.github.com\/CamilaAlvarez\/0cd68410530f8e5fa295be2cd5f8dee3.js\"><\/script>[\/et_pb_text][et_pb_text _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;]<\/p>\n<p><span style=\"font-weight: 400;\">Using your <a href=\"https:\/\/console.impresee.com\">Impresee Console<\/a> account you can configure the catalog attributes that will be exported to the <strong>JSON<\/strong>. In this way it is possible to display extra information about each product.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Impresee provides a JavaScript library that can be easily configured to integrate the search engine with any website in no time. More details about the library for integration and how to integrate visual search can be found <a href=\"https:\/\/impresee.com\/integrating-impresee-using-impresees-snippet\/\">here<\/a>.<br \/><\/span><\/p>\n<p>[\/et_pb_text][\/et_pb_column][et_pb_column type=&#8221;1_4&#8243; _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; global_colors_info=&#8221;{}&#8221;][et_pb_button button_url=&#8221;#previous-steps&#8221; button_text=&#8221;Previous steps&#8221; _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; custom_button=&#8221;on&#8221; button_text_color=&#8221;#000000&#8243; button_bg_color=&#8221;rgba(0,0,0,0)&#8221; button_border_width=&#8221;0px&#8221; global_colors_info=&#8221;{}&#8221;][\/et_pb_button][et_pb_button button_url=&#8221;#request&#8221; button_text=&#8221;Request&#8221; _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; custom_button=&#8221;on&#8221; button_text_color=&#8221;#000000&#8243; button_bg_color=&#8221;rgba(0,0,0,0)&#8221; button_border_width=&#8221;0px&#8221; global_colors_info=&#8221;{}&#8221;][\/et_pb_button][et_pb_button button_url=&#8221;#response&#8221; button_text=&#8221;Response&#8221; _builder_version=&#8221;4.16&#8243; _module_preset=&#8221;default&#8221; custom_button=&#8221;on&#8221; button_text_color=&#8221;#000000&#8243; button_bg_color=&#8221;rgba(0,0,0,0)&#8221; button_border_width=&#8221;0px&#8221; global_colors_info=&#8221;{}&#8221;][\/et_pb_button][\/et_pb_column][\/et_pb_row][\/et_pb_section]<\/p>","protected":false},"excerpt":{"rendered":"<p>How to integrate Impresee Search by Text API v3This document describes how you can integrate Impresee search by text services into your online store. &nbsp;Previous Steps Obtain an Impresee application UUID this is a string with 36 characters. This code can be generated in the Impresee Console or you can ask us to generate one [&hellip;]<\/p>","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"on","_et_pb_old_content":"","_et_gb_content_width":"","footnotes":""},"class_list":["post-8105","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.1 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>How to integrate Impresee Search by Text API v3 &#8211; Impresee: Search bar and navigation solutions for eCommerce<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/impresee.com\/es\/how-to-integrate-impresee-search-by-text-api-v3\/\" \/>\n<meta property=\"og:locale\" content=\"es_ES\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to integrate Impresee Search by Text API v3 &#8211; Impresee: Search bar and navigation solutions for eCommerce\" \/>\n<meta property=\"og:description\" content=\"How to integrate Impresee Search by Text API v3This document describes how you can integrate Impresee search by text services into your online store. &nbsp;Previous Steps Obtain an Impresee application UUID this is a string with 36 characters. This code can be generated in the Impresee Console or you can ask us to generate one [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/impresee.com\/es\/how-to-integrate-impresee-search-by-text-api-v3\/\" \/>\n<meta property=\"og:site_name\" content=\"Impresee: Search bar and navigation solutions for eCommerce\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/impresee\/\" \/>\n<meta property=\"article:modified_time\" content=\"2023-09-05T19:26:37+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/impresee.com\/wp-content\/uploads\/2019\/01\/favicon-1.png\" \/>\n\t<meta property=\"og:image:width\" content=\"200\" \/>\n\t<meta property=\"og:image:height\" content=\"200\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@impresee\" \/>\n<meta name=\"twitter:label1\" content=\"Tiempo estimado de lectura\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutos\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/impresee.com\/how-to-integrate-impresee-search-by-text-api-v3\/\",\"url\":\"https:\/\/impresee.com\/how-to-integrate-impresee-search-by-text-api-v3\/\",\"name\":\"How to integrate Impresee Search by Text API v3 &#8211; Impresee: Search bar and navigation solutions for eCommerce\",\"isPartOf\":{\"@id\":\"https:\/\/impresee.com\/#website\"},\"datePublished\":\"2021-01-11T18:56:12+00:00\",\"dateModified\":\"2023-09-05T19:26:37+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/impresee.com\/how-to-integrate-impresee-search-by-text-api-v3\/#breadcrumb\"},\"inLanguage\":\"es-CL\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/impresee.com\/how-to-integrate-impresee-search-by-text-api-v3\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/impresee.com\/how-to-integrate-impresee-search-by-text-api-v3\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/impresee.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to integrate Impresee Search by Text API v3\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/impresee.com\/#website\",\"url\":\"https:\/\/impresee.com\/\",\"name\":\"Impresee\",\"description\":\"AI search bar, filters and discount games for eCommerce to get more visitors, increase conversion and get repeat sales. Available for Shopify, Woocomerce, Magento and others\",\"publisher\":{\"@id\":\"https:\/\/impresee.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/impresee.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"es-CL\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/impresee.com\/#organization\",\"name\":\"Impresee\",\"url\":\"https:\/\/impresee.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"es-CL\",\"@id\":\"https:\/\/impresee.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/impresee.com\/wp-content\/uploads\/2019\/01\/logo_color_negro_sf_web-e1547827174322.png\",\"contentUrl\":\"https:\/\/impresee.com\/wp-content\/uploads\/2019\/01\/logo_color_negro_sf_web-e1547827174322.png\",\"width\":400,\"height\":152,\"caption\":\"Impresee\"},\"image\":{\"@id\":\"https:\/\/impresee.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/impresee\/\",\"https:\/\/x.com\/impresee\",\"https:\/\/www.instagram.com\/impresee.ai\/\",\"https:\/\/www.linkedin.com\/company\/impresee\",\"https:\/\/www.youtube.com\/channel\/UC5ZniKfJGvG8t4GrOOgYczA\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to integrate Impresee Search by Text API v3 &#8211; Impresee: Search bar and navigation solutions for eCommerce","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/impresee.com\/es\/how-to-integrate-impresee-search-by-text-api-v3\/","og_locale":"es_ES","og_type":"article","og_title":"How to integrate Impresee Search by Text API v3 &#8211; Impresee: Search bar and navigation solutions for eCommerce","og_description":"How to integrate Impresee Search by Text API v3This document describes how you can integrate Impresee search by text services into your online store. &nbsp;Previous Steps Obtain an Impresee application UUID this is a string with 36 characters. This code can be generated in the Impresee Console or you can ask us to generate one [&hellip;]","og_url":"https:\/\/impresee.com\/es\/how-to-integrate-impresee-search-by-text-api-v3\/","og_site_name":"Impresee: Search bar and navigation solutions for eCommerce","article_publisher":"https:\/\/www.facebook.com\/impresee\/","article_modified_time":"2023-09-05T19:26:37+00:00","og_image":[{"width":200,"height":200,"url":"https:\/\/impresee.com\/wp-content\/uploads\/2019\/01\/favicon-1.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_site":"@impresee","twitter_misc":{"Tiempo estimado de lectura":"4 minutos"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/impresee.com\/how-to-integrate-impresee-search-by-text-api-v3\/","url":"https:\/\/impresee.com\/how-to-integrate-impresee-search-by-text-api-v3\/","name":"How to integrate Impresee Search by Text API v3 &#8211; Impresee: Search bar and navigation solutions for eCommerce","isPartOf":{"@id":"https:\/\/impresee.com\/#website"},"datePublished":"2021-01-11T18:56:12+00:00","dateModified":"2023-09-05T19:26:37+00:00","breadcrumb":{"@id":"https:\/\/impresee.com\/how-to-integrate-impresee-search-by-text-api-v3\/#breadcrumb"},"inLanguage":"es-CL","potentialAction":[{"@type":"ReadAction","target":["https:\/\/impresee.com\/how-to-integrate-impresee-search-by-text-api-v3\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/impresee.com\/how-to-integrate-impresee-search-by-text-api-v3\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/impresee.com\/"},{"@type":"ListItem","position":2,"name":"How to integrate Impresee Search by Text API v3"}]},{"@type":"WebSite","@id":"https:\/\/impresee.com\/#website","url":"https:\/\/impresee.com\/","name":"Impresee","description":"AI search bar, filters and discount games for eCommerce to get more visitors, increase conversion and get repeat sales. Available for Shopify, Woocomerce, Magento and others","publisher":{"@id":"https:\/\/impresee.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/impresee.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"es-CL"},{"@type":"Organization","@id":"https:\/\/impresee.com\/#organization","name":"Impresee","url":"https:\/\/impresee.com\/","logo":{"@type":"ImageObject","inLanguage":"es-CL","@id":"https:\/\/impresee.com\/#\/schema\/logo\/image\/","url":"https:\/\/impresee.com\/wp-content\/uploads\/2019\/01\/logo_color_negro_sf_web-e1547827174322.png","contentUrl":"https:\/\/impresee.com\/wp-content\/uploads\/2019\/01\/logo_color_negro_sf_web-e1547827174322.png","width":400,"height":152,"caption":"Impresee"},"image":{"@id":"https:\/\/impresee.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/impresee\/","https:\/\/x.com\/impresee","https:\/\/www.instagram.com\/impresee.ai\/","https:\/\/www.linkedin.com\/company\/impresee","https:\/\/www.youtube.com\/channel\/UC5ZniKfJGvG8t4GrOOgYczA"]}]}},"_links":{"self":[{"href":"https:\/\/impresee.com\/es\/wp-json\/wp\/v2\/pages\/8105","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/impresee.com\/es\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/impresee.com\/es\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/impresee.com\/es\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/impresee.com\/es\/wp-json\/wp\/v2\/comments?post=8105"}],"version-history":[{"count":7,"href":"https:\/\/impresee.com\/es\/wp-json\/wp\/v2\/pages\/8105\/revisions"}],"predecessor-version":[{"id":12867,"href":"https:\/\/impresee.com\/es\/wp-json\/wp\/v2\/pages\/8105\/revisions\/12867"}],"wp:attachment":[{"href":"https:\/\/impresee.com\/es\/wp-json\/wp\/v2\/media?parent=8105"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}