{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Introdução","type":"basic","slug":"introdução","excerpt":"","body":"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. 😉\n\nAntes de começar, sua loja precisa estar integrada com a [API de Coleta](http://docs.chaordic.com.br/v0-api-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 atendimento:::at:::chaordic.com.br.\n\n[block:api-header]\n{\n  \"title\": \"Como usar?\"\n}\n[/block]\nNas 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. \n\nA 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.\n\nCom 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.\n[block:api-header]\n{\n  \"title\": \"Formas de Autenticação\"\n}\n[/block]\nPor questões de segurança, nossa API exige autenticação para fornecer conteúdo. Existem duas formas de autenticar as requisições:\n\n## Autenticação via CORS\n\nEssa 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.\n\nSe 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. 🍰\n\nPara garantir essa segurança, precisamos que todos os hosts habilitados a consultar a API sejam fornecidos para nossa equipe de atendimento no [email protected] \n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -G \\\"https://banner.chaordicsystems.com/v1/recommendations\\\" \\\\\\n    -H \\\"Origin: http://www.meusite.com\\\" \",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n## Autenticação via apiKey + secretKey\n\nQuando 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).\n\nNas requisições da API, esses dois campos devem ser informados via parâmetros de consulta:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -G \\\"https://banner.chaordicsystems.com/v1/recommendations\\\" \\\\\\n    --data \\\"apiKey=sample-v5\\\" \\\\\\n    --data \\\"[email protected]\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nOu então devem ser especificados no header da requisição:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -G \\\"https://banner.chaordicsystems.com/v1/recommendations\\\" \\\\\\n    -H \\\"x-api-key: sample-v5\\\" \\\\\\n    -H \\\"x-secret-key: [email protected]\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n **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] **","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5addffaf94fe9d0003cd9dfa","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"API de Banners","slug":"api-de-recomendação","order":1,"from_sync":false,"reference":false,"_id":"5addffaf94fe9d0003cd9df7","version":"5addffaf94fe9d0003cd9df5","project":"55c3572a57f7f32d0016ec3d","createdAt":"2016-06-22T23:58:11.811Z","__v":0},"user":"56f2e9ed8299450e00ec75d4","parentDoc":null,"project":"55c3572a57f7f32d0016ec3d","version":{"version":"1-api-banners","version_clean":"1.0.0-api-banners","codename":"API de Banners","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5addffaf94fe9d0003cd9df6","5addffaf94fe9d0003cd9df7","5addffaf94fe9d0003cd9df8","5c74677d6b8d330063dd3f64"],"_id":"5addffaf94fe9d0003cd9df5","project":"55c3572a57f7f32d0016ec3d","createdAt":"2018-04-23T15:45:51.605Z","releaseDate":"2018-04-23T15:45:51.605Z","__v":2},"createdAt":"2016-06-23T00:02:32.872Z","githubsync":"","__v":0}
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](http://docs.chaordic.com.br/v0-api-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] [block:api-header] { "title": "Como usar?" } [/block] 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. [block:api-header] { "title": "Formas de Autenticação" } [/block] 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] [block:code] { "codes": [ { "code": "curl -v -G \"https://banner.chaordicsystems.com/v1/recommendations\" \\\n -H \"Origin: http://www.meusite.com\" ", "language": "curl" } ] } [/block] ## 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: [block:code] { "codes": [ { "code": "curl -v -G \"https://banner.chaordicsystems.com/v1/recommendations\" \\\n --data \"apiKey=sample-v5\" \\\n --data \"[email protected]\"", "language": "curl" } ] } [/block] Ou então devem ser especificados no header da requisição: [block:code] { "codes": [ { "code": "curl -v -G \"https://banner.chaordicsystems.com/v1/recommendations\" \\\n -H \"x-api-key: sample-v5\" \\\n -H \"x-secret-key: [email protected]\"", "language": "curl" } ] } [/block] **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] **