Bem-vindo à documentação da API de recomendação Linx Impulse. Com ela você pode obter recomendações de produtos configuradas do jeitinho que você precisa. 😉
Antes de começar, sua loja precisa estar integrada com a API de Coleta para capturar eventos e assim, gerar recomendações contextualizadas. Ou seja, baseadas em informações reais sobre o comportamento do seu usuário na loja. Para saber se essa solução é compatível com sua loja, entre em contato com nosso atendimento através do [email protected].
Como usar?
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.
Receba recomendações por página, utilizando nosso painel de controle para definir regras de negócio e configurar vitrines.
Formas de Autenticação
Para utilizar todos os recursos da API de vitrines, existem duas formas de autenticar as requisições:
Autenticação via CORS
Essa autenticação é uma forma segura e que evita a necessidade de especificar dados sigilosos nas requisições. Utilize para requisições feitas pelo seu navegador.
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 nossa equipe de atendimento no [email protected].
Para este tipo de autenticação, o parâmetro apiKey é opcional, porém recomendado. Enviar a apiKey, ajuda a validar a autenticidade da requisição.
curl --request GET \
--url 'https://recs.chaordicsystems.com/v0/pages/recommendations?name=home&source=desktop&deviceId=sample-deviceId&apiKey=sample' \
--header 'origin: https://www.sample.com.br/'
Autenticação via apiKey + secretKey
Quando as chamadas não forem feitas a partir do seu navegador, use a autenticação via apiKey e secretKey. Esses dois 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 dois campos devem ser informados via parâmetros de consulta:
curl --request GET \
--url 'https://recs.chaordicsystems.com/v0/pages/recommendations?name=home&source=desktop&deviceId=sample-deviceId&apiKey=sample&secretKey=xjg139DDiaj@'
Ou então devem ser especificados no header da requisição:
curl --request GET \
--url 'https://recs.chaordicsystems.com/v0/pages/recommendations?name=home&source=desktop&deviceId=sample-deviceId' \
--header 'x-api-key: sample' \
--header 'x-secret-key: xjg139DDiaj@'
Utilize o menu ao lado para testar e conhecer o detalhamento de parâmetros de cada um dos endpoints. Precisando de ajuda, estamos sempre disponíveis no [email protected].