Bem vindo à API de Coleta da Linx+Neemu+Chaordic. Essa documentação vai te ajudar a entender os endpoints e parâmetros para captura de eventos por meio de aplicações não baseadas em web-browsers. Para aplicações baseadas em browsers, o script Linx+Neemu+Chaordic é o meio recomendado que substitui essa etapa.
A API de Coleta permite a você usar recomendações personalizadas em múltiplos canais: APPs nativos, totens, blogs, portais de notícias e emails marketing. Pronto para trazer recomendações para mais perto dos clientes da sua loja? Bora aprender! 🤓
Como usar?
A API de Coleta é 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.
Toda a interação deve ser registrada conforme os endpoints especificados abaixo.
Para cada tipo de página/interação você deve registrar um evento. Os eventos para view de produto, carrinho, compra, busca e categoria tem endpoints específicos descritos abaixo. Páginas fora dessa lista, como por exemplo: checkout e landing pages, podem ser registradas como um evento genérico, conforme descrito no /events/views/:name.
Boas práticas
Embora tenhamos um bom histórico de disponibilidade nas nossas APIs de coleta, recomendamos as seguintes práticas no uso das nossas APIs para garantir o melhor serviço possível:
- Como todo serviço web, o acesso às APIs de coleta da chaordic depende de uma vasta infraestrutura (roteadores, servidores DNS, etc.) entre os nossos serviços e as fontes de coleta.
- Sendo assim, recomendamos o uso de estratégias de retry para o uso das nossas APIs. No geral, recomendamos o uso da estratégia de retry exponencial com jitter com um intervalo máximo de 1 minuto entre requests e máximo de 60 minutos até a desistência.
Recomendamos também:
- A coleta de métricas e o uso de alertas no caso de um volume elevado de erros. Um histórico do volume de erros pode ser crucial no diagnóstico de um eventual problema.
- A criação de um procedimento capaz de mandar notificações de produto para todos os produtos presentes no catálogo. Assim, é possível mitigar eventuais problemas de sincronização ou outros tipos de erro rapidamente.