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.

Como Usar?

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.

Arquitetura e seus impactos na Autenticação

É 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]

curl -v -G "http://api.linximpulse.com/engage/search/v3/search" \
    -H "Origin: checkout.meusite.com"

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:

curl -v -G "http://api.linximpulse.com/engage/search/v3/search" \
    --data "apiKey=sample-v5" \
    --data "[email protected]"

Ou então devem ser especificados no header da requisição:

curl -v -G "http://api.linximpulse.com/engage/search/v3/search" \
    -H "x-api-key: sample-v5" \
    -H "x-secret-key: [email protected]"