pegabots / api

Neste repositório encontra-se o código da API do Pegabot, capaz de buscar informações do usuário por meio da API do Twitter, bem como fazer requisições de análise ao Motor Pegabot.

API Pegabot

Neste repositório encontra-se o código da API do Pegabot, capaz de buscar informações do usuário por meio da API do Twitter, bem como fazer requisições de análise ao Motor Pegabot.

Background

Quando chamada, a API busca no banco de dados aquele usuário. Caso ele já tenha sido analisado e essa análise tenha ocorrido em menos de 30 dias, o valor da análise é retornado sem que uma nova análise seja feita. Caso contrário, é feita uma requisição ao Motor Pegabot, que analisa aquele perfil e retorna o resultado dessa análise. O valor é então, salvo no banco de dados e retornado à aplicação que fez a requisição.

Código de Conduta

Observe nosso nosso Código de Conduta na hora de realizar interações aqui no repositório. O objetivo é promover um espaço saudável de desenvolvimento.

Contribuindo

Encorajamos todos os interessados a contribuírem para o projeto. Se você quiser mais informações, acesse contribuindo para o projeto para entender como você pode contribuir.

Versão

O Projeto será mantido sob as diretrizes de versão semântica, tanto quanto possível. Os lançamentos serão numerados com o seguinte formato:

<major>.<minor>.<patch>

Para obter mais informações sobre SemVer, visite http://semver.org.

Licença

Este projeto é gratuito e de código aberto. Você pode usá-lo para projetos comerciais, projetos de código aberto ou praticamente o que você quiser. No entanto, você deve disponibilizar o código fonte de qualquer biblioteca que utilize código fonte disponibilizado nesse repositório. Você pode ver aqui qual é a Licensa utilizada no projeto. Para uma explicação simples e em português dessa licensa, acesse esse site.

Agradecimentos

Agradecimentos aos desenvolvedores @blckjzz e @otaviouss.

api's Issues

Expandir acesso da API Pegabot para usuários externos

Para ampliar a capacidade de análises do motor do Pegabot, seria interessante a disponibilização de endpoints em nossa API para usuários externos. Para acessar esses endpoints, os usuários devem ser capazes de utilizar suas chaves da API do Twitter para realizar análises, retornando a probabilidade de um grupo de usuários serem bots. Uma ideia é que o usuário possa entrar com arquivos em um formato específico contendo o handle ou o ID dos usuários a serem analisados e a ferramenta retorne o resultado da análise desses usuários. Mais detalhes e características podem ser sugeridos e implementados.