En esta etapa, la API es utilizada internamente por Folding Monitor para respaldar tablas de clasificación, páginas de perfil, páginas de equipos, rankings por países, búsqueda, tarjetas de firma generadas y otras funciones del servicio.
Aún no hay una API pública disponible, pero forma parte de la dirección del producto a largo plazo.
La usamos internamente para impulsar el servicio y mantener la interfaz pública rápida, coherente y fiable.
La API interna nos ayuda a trabajar con:
IDs de usuario de Folding@home, nombres, créditos, unidades de trabajo, rangos, equipos, países y resúmenes de actividad.
IDs de equipo, nombres de equipo, logotipos, miembros, créditos, unidades de trabajo, movimientos de ranking y posiciones en tablas de clasificación.
Rankings por países, países representados, resúmenes de actividad y usuarios sin configuración de país.
Rankings de 24 h, 7 d, 30 d y de todos los tiempos para usuarios, equipos y países.
Tarjetas de firma para foros, vistas previas de perfiles y otros elementos visuales basados en datos de contribución de Folding@home.
Queremos que una API pública sea útil, estable y responsable.
Abrir una API demasiado pronto puede crear problemas: endpoints inestables, límites poco claros, formatos de datos inconsistentes, carga excesiva del servidor y cambios incompatibles para los primeros usuarios.
Antes de poner endpoints públicos a disposición, queremos definir correctamente las partes importantes:
Formatos de respuesta claros para usuarios, equipos, países, rankings y períodos de tiempo.
Límites razonables que protejan el servicio sin dejar de hacer útil la API.
Expectativas transparentes sobre frecuencia de actualización, retrasos y datos históricos.
Orientación clara sobre cómo deben referenciarse los datos de Folding Monitor cuando se utilicen externamente.
Endpoints lo suficientemente fiables para desarrolladores, herramientas comunitarias, dashboards e integraciones con foros.
Separación cuidadosa entre estadísticas públicas, datos de cuentas conectadas, datos internos del servicio e información técnica protegida.
Una futura API pública puede incluir endpoints para:
Buscar o recuperar perfiles de usuarios de Folding@home y resúmenes de contribución.
Recuperar perfiles de equipos, recuentos de miembros, logotipos, datos de ranking y resúmenes de actividad.
Acceder a estadísticas y rankings por países en períodos de tiempo seleccionados.
Obtener los principales usuarios, equipos y países para períodos de 24 h, 7 d, 30 d y de todos los tiempos.
Generar o recuperar recursos de tarjetas de firma de usuarios y equipos para foros y páginas comunitarias.
Seguir cambios en las tablas de clasificación, usuarios en ascenso, equipos activos y tendencias de participación por país.
Admitir widgets insertables para equipos, usuarios, foros y sitios web comunitarios.
Si se introduce una API pública, estará diseñada para un uso responsable.
El objetivo no es crear scraping sin restricciones ni extracción de datos de alto volumen. El objetivo es apoyar herramientas comunitarias útiles, dashboards, integraciones con foros, sitios web de equipos y visualizaciones favorables a la investigación sin perjudicar la estabilidad del servicio.
Una futura API puede incluir:
• claves API;
• límites de tasa;
• cuotas específicas por endpoint;
• requisitos de caché;
• reglas de atribución;
• prevención de abuso;
• endpoints versionados;
• documentación para desarrolladores.
Aún no estamos aceptando registros para la API pública.
Sin embargo, nos interesa saber qué les resultaría útil a desarrolladores, mantenedores de equipos, miembros de la comunidad y contribuidores de Folding@home.
Puedes enviar ideas para la API, solicitudes de endpoints, necesidades de integración o interés en acceso anticipado a:
general@vitaltale.com
Los comentarios útiles pueden incluir:
• a qué datos te gustaría acceder;
• qué tipo de proyecto o integración quieres crear;
• si necesitas datos de usuarios, equipos, países o tablas de clasificación;
• volumen esperado de solicitudes;
• formatos de datos preferidos;
• si necesitas widgets, imágenes, endpoints JSON o estadísticas históricas.
API pública: aún no disponible
API interna: activa
Documentación para desarrolladores: planificada
Acceso anticipado: aún no abierto
Comentarios: bienvenidos en general@vitaltale.com
Folding Monitor se está construyendo teniendo en cuenta la preparación para API, aunque la interfaz pública siga siendo la prioridad principal.