Nossa Central de Ajuda foi projetada para fornecer uma opção de autoatendimento completa para nossos clientes e interessados em nossas soluções. A Central de Ajuda contém: uma base de conhecimento e um atalho para solicitações de suporte, via chat.
Você também pode fazer parte de uma comunidade, aqui na Central de Ajuda, com interações de usuários que compartilham suas melhores práticas, soluções encontradas, casos de uso, entre outros conhecimentos. Se escolher fazer parte da nossa comunidade, você poderá interagir, perguntando e respondendo outros usuários.
É possível pesquisar por artigos da base de conhecimento para aprender como executar uma tarefa ou pesquisar na comunidade e fazer perguntas a outros usuários. Caso não consiga encontrar uma resposta, fique a vontade para enviar uma solicitação de suporte.
Aqui você encontrará respostas a perguntas comuns aos outros usuários, situações mais comuns de clientes. É possível também fazer sugestões de aplicação da tecnologia.
Introdução a Documentação API Klipbox
Este artigo é uma breve introdução a documentação da API Klipbox e serve para você possa ser introduzido ao funcionamento desta tecnologia, bem como sanar dúvidas inicias, antes do seu contato com um de nossos consultores.
***Durante o processo de contratação – e após -, nossa equipe te guiará no processo para que consigam rapidamente desfrutar da nossa solução.
Tópicos que você verá neste artigo:
- Conceitos Principais
- O Klipbox e suas partes
- Primeiros Passos
- Autenticação na API
- Criar um Monitoramento
- Editar um Monitoramento
- Consultar Notícias de um Monitoramento
O Klipbox é uma ferramenta de monitoramento, busca e indexação de notícias online, que tem por objetivo coletar conteúdo noticioso nativo e publicamente acessível na internet, e disponibilizá-lo por meio de API REST. Priorizamos aqui uma linguagem simples, sendo técnica apenas quando estritamente necessário.
O ponto central da tecnologia Klipbox é a dinâmica que denominamos como monitoramento, portanto, iniciaremos com seu conceito e das demais partes que o compõem.
- Monitoramento: É um conjunto de Palavras-chave, Termos e Filtros, que formam os critérios de pesquisa para recuperação de notícias no banco de dados.
- Palavras-chave: Palavras que serão utilizadas como base para a pesquisa de notícias. As palavras-chave apresentam certa flexibilidade quanto à grafia trazendo não apenas resultados com os termos exatos. Podem ser adicionadas várias palavras-chave a um único monitoramento, tornando a pesquisa abrangente, ou seja, a interação entre elas se assimila a um operador boleano “OR”. É importante dizer que um monitoramento não existe sem pelo ao menos uma palavra-chave.
- Queries / Pesquisas: Se trata da forma como se organizam as palavras-chave para que as mesmas representem o resultado desejado pelo usuário. Em geral, um Monitoramento tem várias Queries que por sua vez pode conter várias Palavras-chave relacionadas entre sí por termos Boleanos e agrupamentos.
As Pesquisas podem ter as seguintes diretivas:
- Must: Palavras-chave que obrigatoriamente precisam estar no texto.
- Must Not: Palavras-chave que se presentes, eliminarão a notícia dos resultados.
- Should: Palavras-chave que podem ou não estar presentes, desde que ao
menos uma das Pesquisas com a diretiva Should esteja presente no documento. - Filter: Esta diretiva tem o mesmo funcionamento de Must, embora, a presença
desses termos, não afetam o cálculo de relevância dos documentos. - Filtros de fonte: São filtros de fontes de notícias aplicados a partir de seus
domínios raiz, sem o subdomínio, com o intuito de tornar os resultados das notícias
ainda mais relevantes para o usuário.
Os filtros de fonte podem apresentar:
- Fontes Excluídas: NÃO serão apresentadas notícias a partir das fontes indicadas.
- Fontes Exclusivas: Serão apresentadas APENAS notícias a partir das fontes indicadas. Há ainda fatores de grande importância para a operação do Klipbox no dia-a-dia, que não são definidos no momento da criação do monitoramento, mas sim de sua visualização. São eles:
- Ordenação de notícias: A ordenação padrão de notícias é feita em duas etapas:
(1) Data; (2) Cálculo de relevância. É importante reforçar que NÃO é usado formato “DATETIME”, senão “DATE”, na fase de ordenação por data. Também é importante comentar que o cálculo de relevância não considera a repercussão da notícia na internet, senão a relação entre os critérios de pesquisa inseridos no monitoramento e suas presenças relativas no conjunto de notícias encontradas. - Filtro de data: Por padrão, o filtro de datas trará as notícias mais recentes disponíveis no banco de dados, com base no momento em que a consulta é realizada. É possível definir uma data inicial e final para que os resultados sejam restritos a esse período.
- Paginação: Em cada requisição é retornado por padrão, um conjunto de até 10 notícias. Embora, esse seja um parâmetro customizável da pesquisa que pode retornar de 1 até 100 notícias por página.
- Marcação / Highlight: Por padrão, no campo highlight serão trazidas até 5 frases inteiras que contêm qualquer uma das palavras-chave. O desenvolvedor tem ainda a liberdade de alterar a marcação padrão inicial (<mark>) e final (</mark>), além da quantidade de frases, ou o texto inteiro com as marcações.
- Campos: Por padrão, todos os campos disponíveis para uma notícia serão exibidos, mas o desenvolvedor tem a liberdade de definir quais campos serão trazidos, exceto o highlight, que sempre será retornado. Os campos disponíveis para definição são: url, title, text, images, source, domain, subdomain, author, published_date, extracted_date.
- Ordenação de notícias: A ordenação padrão de notícias é feita em duas etapas:
Além disso, os monitoramentos podem ser organizados em “Departamentos” ou seja, grupos de monitoramentos, onde os acessos são restritos aos usuários que fazem parte dele.
Para se autenticar na API é necessário ter uma conta na API do Klipbox. Para isso, basta acessar https://www.klipbox.com.br/planos, escolher a categoria de API que deseja usar e se for elegível a usar nossa API, o consultor irá criar o seu usuário e senha, para que você experimente o sistema, antes de finalizar a contratação.
Todas as conexões com a API são feitas por meio de protocolo HTTPS, sendo redirecionadas para o HTTPS todas as requisições recebidas.
À exceção da chamada que cria o token de acesso, e as notícias públicas TODAS as chamadas deverão incluí-lo à fim de autenticar as requisições.
O token gerado, tem uma validade máxima de 365 dias, devendo ser renovado dentro desse período.
Criando um monitoramento na API

Será recebida uma resposta contendo as propriedades do seu monitoramento.

Editar um monitoramento

Será recebida uma resposta contendo as propriedades atualizadas do seu monitoramento.

Caso queira aprender como masterizar a criação de monitoramentos, te introduzimos as Pesquisas Avançadas neste outro artigo. Clique Aqui.(É preciso estar logado para acessar este artigo)
Consultar Notícias de um Monitoramento

● date: opcional. Caso esse campo não seja enviado na requisição, retornará com as notícias mais recentes.
page_size: opcional. Tamanho da página de notícias. Caso não seja informado, assumirá 10, como valor padrão. O valor pode variar entre 0 e 100.
● page: opcional. Caso esse campo não seja enviado na requisição, assumirá o valor 0, indicando que a primeira página de notícias será trazida. Para recuperar a próxima página, basta trazer na próxima requisição este campo com o valor acrescido de 1.
● sort: opcional. As notícias atualmente podem ser ordenadas por published_date ou extracted_date. O desenvolvedor ainda pode adicionar “-” antes do tipo de ordenação, indicando que a mesma será inversa. Ex.: “-published_date” tratá as notícia na ordem inversa, ou seja, as mais antigas primeiro. Por padrão o valor “published_date” é assumido.
Será recebida uma resposta conforme o modelo a seguir:

Campos de maior interesse para o desenvolvedor na resposta acima:
- count: Total de notícias considerando filtro de data e monitoramento.
- hits: Aqui está contido o resultado da pesquisa.
- hits>[n]>_id: Identificador único da notícia.
- hits>[n]>highlight>text: Texto da notícia com as palavras que cumpriram os critérios de pesquisa, entre as marcações <mark></mark>, ou a definida na requisição do monitoramento.