{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Introdução","type":"basic","slug":"introdução","excerpt":"","body":"Bem-vindo à documentação da API de Busca Personalizada Linx Impulse. Com ela você poderá realizar consultas de termos de busca e produtos na base de produtos da sua loja. \n\nOs resultados da Busca Personalizada são baseados no comportamento e histórico dos usuários, por isso ela pode exibir resultados diferentes para buscas iguais. Processando as informações da loja e dados de navegação dos usuários, a Busca Personalizada gera uma ordenação de resultados para cada consulta realizada.\n\n\n[block:api-header]\n{\n  \"title\": \"Como Usar?\"\n}\n[/block]\nA API de Busca é baseada em HTTP e funciona com qualquer linguagem que tenha uma biblioteca HTTP,  tal como cURL e urllib. Você também poderá usar a API direto em seu navegador.\n\nNas páginas dessa documentação, apresentamos tudo o que você precisa saber em relação a API, bem como exemplos e detalhamento de parâmetros adicionais. Todos os serviços disponibilizados seguem o padrão REST e retornam um JSON de acordo com os parâmetros utilizados.\n\n**Toda a interação deve ser registrada conforme os endpoints especificados no menu ao lado.**\n\n[block:api-header]\n{\n  \"title\": \"Arquitetura e seus impactos na Autenticação\"\n}\n[/block]\nÉ sua escolha de arquitetura fazer as chamadas à API via frontend ou backend. \n\n## Via Frontend:\nFazendo a chamada no próprio navegador via Ajax por exemplo, é possível desfrutar da autenticação automática segundo um whitelist de domínio. Assim nas requests você não deverá passar como parâmetro a `secretKey`.\n\nEntão por exemplo, se você definir que o **.minhaloja.com** está liberado para acessar nossa API, toda requisição para esse domínio será autenticada internamente. Removendo a necessidade de informar campos de autenticação. Facinho, facinho. 🍰\n\nPara garantir essa segurança, precisamos que todos os hosts habilitados a consultar a API sejam fornecidos para o seu Gerente de Projetos de Integração, ou para a nossa equipe de atendimento no atendimento:::at:::linx3.com. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -G \\\"http://api.linximpulse.com/engage/search/v3/search\\\" \\\\\\n    -H \\\"Origin: checkout.meusite.com\\\" \",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n## Via Backend:\nQuando as chamadas não forem feitas a partir do navegador, use a autenticação via apiKey e secretKey. Esses dois parâmetros são responsáveis por identificar sua loja na nossa plataforma (apiKey) e autenticá-la por um código de segurança (secretKey).\n\nNas requisições da API, esses campos devem ser passados via parâmetros de consulta:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -G \\\"https://apikey.neemu.com/searchapi/v3/search\\\" \\\\\\n    --data \\\"apiKey=sample-v5\\\" \\\\\\n    --data \\\"[email protected]\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nOu então devem ser especificados no header da requisição:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -G \\\"https://apikey.neemu.com/searchapi/v3/search\\\" \\\\\\n    -H \\\"x-api-key: sample-v5\\\" \\\\\\n    -H \\\"x-secret-key: [email protected]\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d00029d39c2920014e3170d","project":"55c3572a57f7f32d0016ec3d","parentDoc":null,"user":"5760739a30e27d0e00002a9f","version":{"version":"3-search","version_clean":"3.0.0-search","codename":"API de Busca pelo time de Integração","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5d00029d39c2920014e316db","5d00029d39c2920014e316dc","5d00029d39c2920014e316dd","5d00029d39c2920014e316de","5d00029d39c2920014e316df","5d00029d39c2920014e316e0","5d00029d39c2920014e316e1","5d00029d39c2920014e316e2","5d00029d39c2920014e316e3","5d00029d39c2920014e316e4","5d00029d39c2920014e316e5","5d00029d39c2920014e316e6"],"_id":"5d00029d39c2920014e31722","project":"55c3572a57f7f32d0016ec3d","__v":0,"forked_from":"590a413d12d47a3700f83c8e","createdAt":"2017-05-03T20:44:45.480Z","releaseDate":"2017-05-03T20:44:45.480Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"API de busca","slug":"api-de-busca","order":8,"from_sync":false,"reference":false,"_id":"5d00029d39c2920014e316e3","project":"55c3572a57f7f32d0016ec3d","createdAt":"2017-03-06T13:18:21.954Z","__v":0,"version":"5d00029d39c2920014e31722"},"createdAt":"2017-03-06T13:18:44.803Z","githubsync":"","__v":0}
Bem-vindo à documentação da API de Busca Personalizada Linx Impulse. Com ela você poderá realizar consultas de termos de busca e produtos na base de produtos da sua loja. Os resultados da Busca Personalizada são baseados no comportamento e histórico dos usuários, por isso ela pode exibir resultados diferentes para buscas iguais. Processando as informações da loja e dados de navegação dos usuários, a Busca Personalizada gera uma ordenação de resultados para cada consulta realizada. [block:api-header] { "title": "Como Usar?" } [/block] A API de Busca é baseada em HTTP e funciona com qualquer linguagem que tenha uma biblioteca HTTP, tal como cURL e urllib. Você também poderá usar a API direto em seu navegador. Nas páginas dessa documentação, apresentamos tudo o que você precisa saber em relação a API, bem como exemplos e detalhamento de parâmetros adicionais. Todos os serviços disponibilizados seguem o padrão REST e retornam um JSON de acordo com os parâmetros utilizados. **Toda a interação deve ser registrada conforme os endpoints especificados no menu ao lado.** [block:api-header] { "title": "Arquitetura e seus impactos na Autenticação" } [/block] É sua escolha de arquitetura fazer as chamadas à API via frontend ou backend. ## Via Frontend: Fazendo a chamada no próprio navegador via Ajax por exemplo, é possível desfrutar da autenticação automática segundo um whitelist de domínio. Assim nas requests você não deverá passar como parâmetro a `secretKey`. Então por exemplo, se você definir que o **.minhaloja.com** está liberado para acessar nossa API, toda requisição para esse domínio será autenticada internamente. Removendo a necessidade de informar campos de autenticação. Facinho, facinho. 🍰 Para garantir essa segurança, precisamos que todos os hosts habilitados a consultar a API sejam fornecidos para o seu Gerente de Projetos de Integração, ou para a nossa equipe de atendimento no [email protected] [block:code] { "codes": [ { "code": "curl -v -G \"http://api.linximpulse.com/engage/search/v3/search\" \\\n -H \"Origin: checkout.meusite.com\" ", "language": "curl" } ] } [/block] ## Via Backend: Quando as chamadas não forem feitas a partir do navegador, use a autenticação via apiKey e secretKey. Esses dois parâmetros são responsáveis por identificar sua loja na nossa plataforma (apiKey) e autenticá-la por um código de segurança (secretKey). Nas requisições da API, esses campos devem ser passados via parâmetros de consulta: [block:code] { "codes": [ { "code": "curl -v -G \"https://apikey.neemu.com/searchapi/v3/search\" \\\n --data \"apiKey=sample-v5\" \\\n --data \"[email protected]\"", "language": "curl" } ] } [/block] Ou então devem ser especificados no header da requisição: [block:code] { "codes": [ { "code": "curl -v -G \"https://apikey.neemu.com/searchapi/v3/search\" \\\n -H \"x-api-key: sample-v5\" \\\n -H \"x-secret-key: [email protected]\"", "language": "curl" } ] } [/block]