{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Introdução","type":"basic","slug":"introdução","excerpt":"","body":"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](http://docs.chaordic.com.br/docs/embed-script) é o meio recomendado que substitui essa etapa.**\n\n\nA 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! 🤓\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Como usar?\"\n}\n[/block]\nA 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.\n\n**Toda a interação deve ser registrada conforme os endpoints especificados abaixo.**\n\nPara 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](/v7-collect/docs/eventsviewsname-1). \n\n[/events/views/product](/v0-api-coleta/docs/eventsviewsproduct)\n\n[/events/views/cart](/v0-api-coleta/docs/eventsviewscart)\n\n[/events/views/transaction](/v0-api-coleta/docs/eventsviewstransaction)\n\n[/events/views/emptysearch](/v0-api-coleta/docs/eventsviewsemptysearch)\n\n[/events/views/search](/v0-api-coleta/docs/eventsviewssearch)\n\n[/events/views/category](/v0-api-coleta/docs/eventsviewscategory)\n\n[/events/views/:name](/v0-api-coleta/docs/eventsviewsname-1)\n[block:api-header]\n{\n  \"title\": \"Boas práticas\"\n}\n[/block]\nEmbora 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:\n\n * 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. \n * 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](https://www.awsarchitectureblog.com/2015/03/backoff.html) com um intervalo máximo de **1 minuto entre requests** e máximo de **60 minutos até a desistência**.\n \nRecomendamos também:\n *  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.\n * 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.","updates":["56fe703de7f3080e008e4024","6148a19a6b6f320063f9317a"],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5772772dd98d530e00a31d09","user":"56f2e9ed8299450e00ec75d4","parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"API de Coleta","slug":"apis-1","order":3,"from_sync":false,"reference":false,"_id":"5772772dd98d530e00a31cf5","createdAt":"2016-03-30T13:37:46.668Z","project":"55c3572a57f7f32d0016ec3d","version":"5772772dd98d530e00a31cf1","__v":0},"createdAt":"2016-03-30T17:04:02.306Z","version":{"version":"0-api-coleta","version_clean":"0.0.0-api-coleta","codename":"API de Coleta","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5772772dd98d530e00a31cf2","5772772dd98d530e00a31cf3","5772772dd98d530e00a31cf4","5772772dd98d530e00a31cf5","5772772dd98d530e00a31cf6","5772772dd98d530e00a31cf7","5772772dd98d530e00a31cf8","5772772dd98d530e00a31cf9","5772772dd98d530e00a31cfa","5772772dd98d530e00a31cfb","590246da272d2f0f00817185","59024928bdd4461900b79a14","590276ca4c3b710f00821cca"],"_id":"5772772dd98d530e00a31cf1","__v":4,"createdAt":"2016-06-28T13:10:05.430Z","project":"55c3572a57f7f32d0016ec3d","releaseDate":"2016-06-28T13:10:05.430Z"},"project":"55c3572a57f7f32d0016ec3d","__v":2,"githubsync":""}
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](http://docs.chaordic.com.br/docs/embed-script) é 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! 🤓 [block:api-header] { "type": "basic", "title": "Como usar?" } [/block] 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](/v7-collect/docs/eventsviewsname-1). [/events/views/product](/v0-api-coleta/docs/eventsviewsproduct) [/events/views/cart](/v0-api-coleta/docs/eventsviewscart) [/events/views/transaction](/v0-api-coleta/docs/eventsviewstransaction) [/events/views/emptysearch](/v0-api-coleta/docs/eventsviewsemptysearch) [/events/views/search](/v0-api-coleta/docs/eventsviewssearch) [/events/views/category](/v0-api-coleta/docs/eventsviewscategory) [/events/views/:name](/v0-api-coleta/docs/eventsviewsname-1) [block:api-header] { "title": "Boas práticas" } [/block] 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](https://www.awsarchitectureblog.com/2015/03/backoff.html) 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.