Nesta etapa, a API é usada internamente pelo Folding Monitor para oferecer suporte a leaderboards, páginas de perfil, páginas de equipes, rankings por país, busca, cartões de assinatura gerados e outros recursos do serviço.
Uma API pública ainda não está disponível, mas faz parte da direção de produto de longo prazo.
Nós a usamos internamente para alimentar o serviço e manter a interface pública rápida, consistente e confiável.
A API interna nos ajuda a trabalhar com:
IDs de usuários do Folding@home, nomes, créditos, unidades de trabalho, posições no ranking, equipes, países e resumos de atividade.
IDs de equipes, nomes de equipes, logotipos, membros, créditos, unidades de trabalho, movimentação no ranking e posições em leaderboards.
Rankings por país, países representados, resumos de atividade e usuários sem configurações de país.
Rankings de 24 h, 7 dias, 30 dias e de todos os tempos para usuários, equipes e países.
Cartões de assinatura para fóruns, pré-visualizações de perfil e outros elementos visuais baseados em dados de contribuição do Folding@home.
Queremos que uma API pública seja útil, estável e responsável.
Abrir uma API cedo demais pode criar problemas: endpoints instáveis, limites pouco claros, formatos de dados inconsistentes, carga excessiva no servidor e mudanças incompatíveis para usuários iniciais.
Antes de disponibilizar endpoints públicos, queremos definir corretamente as partes importantes:
Formatos de resposta claros para usuários, equipes, países, rankings e períodos de tempo.
Limites razoáveis que protejam o serviço e, ao mesmo tempo, tornem a API útil.
Expectativas transparentes sobre frequência de atualização, atrasos e dados históricos.
Orientação clara sobre como os dados do Folding Monitor devem ser referenciados quando usados externamente.
Endpoints confiáveis o suficiente para desenvolvedores, ferramentas comunitárias, dashboards e integrações com fóruns.
Separação cuidadosa entre estatísticas públicas, dados de contas conectadas, dados internos do serviço e informações técnicas protegidas.
Uma futura API pública pode incluir endpoints para:
Buscar ou recuperar perfis de usuários do Folding@home e resumos de contribuição.
Recuperar perfis de equipes, contagens de membros, logotipos, dados de ranking e resumos de atividade.
Acessar estatísticas e rankings por país em períodos de tempo selecionados.
Buscar os principais usuários, equipes e países para períodos de 24 h, 7 dias, 30 dias e de todos os tempos.
Gerar ou recuperar recursos de cartões de assinatura de usuários e equipes para fóruns e páginas comunitárias.
Acompanhar mudanças em leaderboards, usuários em ascensão, equipes ativas e tendências de participação por país.
Suportar widgets incorporáveis para equipes, usuários, fóruns e sites comunitários.
Se uma API pública for introduzida, ela será projetada para uso responsável.
O objetivo não é criar scraping irrestrito ou extração de dados em alto volume. O objetivo é apoiar ferramentas comunitárias úteis, dashboards, integrações com fóruns, sites de equipes e visualizações favoráveis à pesquisa sem prejudicar a estabilidade do serviço.
Uma futura API pode incluir:
• chaves de API;
• limites de taxa;
• cotas específicas por endpoint;
• requisitos de cache;
• regras de atribuição;
• prevenção de abuso;
• endpoints versionados;
• documentação para desenvolvedores.
Ainda não estamos aceitando registros para a API pública.
No entanto, temos interesse em saber o que desenvolvedores, mantenedores de equipes, membros da comunidade e contribuidores do Folding@home considerariam útil.
Você pode enviar ideias para a API, solicitações de endpoints, necessidades de integração ou interesse em acesso antecipado para:
general@vitaltale.com
Feedback útil pode incluir:
• quais dados você gostaria de acessar;
• que tipo de projeto ou integração você deseja construir;
• se você precisa de dados de usuários, equipes, países ou leaderboards;
• volume esperado de solicitações;
• formatos de dados preferidos;
• se você precisa de widgets, imagens, endpoints JSON ou estatísticas históricas.
API pública: ainda não disponível
API interna: ativa
Documentação para desenvolvedores: planejada
Acesso antecipado: ainda não aberto
Feedback: bem-vindo em general@vitaltale.com
O Folding Monitor está sendo construído com prontidão para API em mente, mesmo enquanto a interface pública continua sendo a principal prioridade.