Bem-vindo à documentação da API de banners Linx+Neemu+Chaordic. Com ela você pode obter recomendações de banners 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.

A configuração dos banners, e seus slides, são feitas na nossa central de controle. Lá é possível definir as regras de exibição de cada banner, assim como cadastrar o conteúdo de cada slide.

Com os banners cadastrados, a nossa API (docs: get-banners-recommendations) pode ser integrada no seu site, ou aplicativo, e passa a fornecer banners contextualizados pelo perfil e página que o usuário está navegando. Tudo de forma automática.

Formas de Autenticação

Por questões de segurança, nossa API exige autenticação para fornecer conteúdo. 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]

curl -v -G "https://banner.chaordicsystems.com/v1/recommendations" \
    -H "Origin: http://www.meusite.com"

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 -v -G "https://banner.chaordicsystems.com/v1/recommendations" \
    --data "apiKey=sample-v5" \
    --data "[email protected]"

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

curl -v -G "https://banner.chaordicsystems.com/v1/recommendations" \
    -H "x-api-key: sample-v5" \
    -H "x-secret-key: [email protected]"

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]