Este documento descreve a API de Busca Personalizada Linx + Neemu + Chaordic.

Busca Personalizada

Os resultados de busca são baseados no comportamento e histórico dos usuários. Exiba resultados diferentes para buscas iguais. Processando as informações da loja e dados de navegação, a Busca Personalizada gera um ranking para cada consulta realizada. Melhore a experiência e aumente o engajamento com filtros dinâmicos e automáticos, autocomplete e ferramentas de gestão.

Como usar a API?

A API de Busca Personalizada Linx+Neemu+Chaordic é utilizada para realização de consultas de termos e produtos na base de produtos da loja. Este documento descreve esta API.

A API de Busca é baseada em HTTP, funciona com qualquer linguagem que tem uma biblioteca HTTP, tal como cURL, urllib. Você também poderá usar a API direto em seu browser. Todos os serviços disponibilizados seguem o protocolo REST e retornam um JSON correspondente aos parâmetros utilizados.

Toda a interação deve ser registrada conforme os endpoints especificados abaixo.

Formas de autenticação

Para acessar os recursos da API de busca, existem duas formas de autenticação das requisições realizadas.

Autenticação via apiKey + secretKey

Todo cliente integrado em nossa plataforma, tem um identificador da loja (apiKey) e um código de segurança usado para autenticá-lo (secretKey).

Nas requisições da API, esses campos devem ser passados via parâmetros de consulta:

curl -v -G "https://search.neemu.chaordic.com/searchapi/v3/queries" \
    --data "apiKey=sample-v5" \
    --data "[email protected]"

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

curl -v -G "https://search.neemu.chaordic.com/searchapi/v3/queries" \
    -H "x-api-key: sample-v5" \
    -H "x-secret-key: [email protected]"

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

Autenticação via CORS

Uma forma mais segura de autenticação, que evita que dados sigilosos sejam especificados nas requisições, é a autenticação pela origem de tráfego.

Neste caso, é preciso que todos os hosts habilitados a consultar a API sejam fornecidos para nossa equipe de atendimento.

Uma vez fornecidos, não é necessário seja passado nenhum campo de autenticação nas requisições.

Por exemplo, se um cliente definir que todo o domínio .meusite.com está liberado para acessar nossa API. Toda requisição feita a partir deste domínio, tendo o host de origin específicado no header será autenticada internamente.

curl -v -G "https://search.neemu.chaordic.com/searchapi/v3/queries" \
    -H "Origin: checkout.meusite.com"