Connecter Folding@home

API

Folding Monitor repose sur une API interne structurée utilisée pour collecter, traiter, normaliser, mettre en cache et afficher les statistiques liées à Folding@home.

À ce stade, l’API est utilisée en interne par Folding Monitor pour prendre en charge les classements, les pages de profil, les pages d’équipe, les classements par pays, la recherche, les cartes de signature générées et d’autres fonctionnalités du service.

Une API publique n’est pas encore disponible, mais elle fait partie de l’orientation produit à long terme.

Statut actuel
L’API Folding Monitor est actuellement privée.

Nous l’utilisons en interne pour faire fonctionner le service et maintenir l’interface publique rapide, cohérente et fiable.

L’API interne nous aide à travailler avec :

Statistiques des utilisateurs

Identifiants utilisateur Folding@home, noms, crédits, unités de travail, rangs, équipes, pays et résumés d’activité.

Statistiques des équipes

Identifiants d’équipe, noms d’équipe, logos, membres, crédits, unités de travail, mouvements de classement et positions dans les classements.

Statistiques des pays

Classements par pays, pays représentés, résumés d’activité et utilisateurs sans paramètre de pays.

Données de classement

Classements sur 24 h, 7 j, 30 j et depuis toujours pour les utilisateurs, les équipes et les pays.

Ressources générées

Cartes de signature pour forums, aperçus de profils et autres éléments visuels basés sur les données de contribution Folding@home.

Pourquoi l’API n’est pas encore publique

Nous voulons qu’une API publique soit utile, stable et responsable.

Ouvrir une API trop tôt peut créer des problèmes : endpoints instables, limites peu claires, formats de données incohérents, charge serveur excessive et changements incompatibles pour les premiers utilisateurs.

Avant de rendre des endpoints publics disponibles, nous voulons définir correctement les éléments importants :

Structure des données

Formats de réponse clairs pour les utilisateurs, les équipes, les pays, les classements et les périodes.

Limites de débit

Des limites raisonnables qui protègent le service tout en rendant l’API utile.

Règles de mise en cache

Des attentes transparentes concernant la fréquence d’actualisation, les délais et les données historiques.

Attribution

Des indications claires sur la manière dont les données de Folding Monitor doivent être référencées lorsqu’elles sont utilisées à l’extérieur.

Stabilité

Des endpoints suffisamment fiables pour les développeurs, les outils communautaires, les tableaux de bord et les intégrations de forums.

Confidentialité et sécurité

Une séparation rigoureuse entre les statistiques publiques, les données de comptes connectés, les données internes du service et les informations techniques protégées.

Ce qu’une API publique pourrait prendre en charge

Une future API publique pourrait inclure des endpoints pour :

Recherches d’utilisateurs

Rechercher ou récupérer des profils utilisateur Folding@home et des résumés de contribution.

Recherches d’équipes

Récupérer des profils d’équipe, le nombre de membres, les logos, les données de classement et les résumés d’activité.

Classements par pays

Accéder aux statistiques et classements par pays sur des périodes sélectionnées.

Meilleurs classements

Récupérer les meilleurs utilisateurs, équipes et pays pour les périodes de 24 h, 7 j, 30 j et depuis toujours.

Cartes de signature

Générer ou récupérer des ressources de cartes de signature utilisateur et équipe pour les forums et les pages communautaires.

Mouvements de classement

Suivre les changements dans les classements, les utilisateurs en progression, les équipes actives et les tendances de participation par pays.

Widgets publics

Prendre en charge des widgets intégrables pour les équipes, les utilisateurs, les forums et les sites web communautaires.

Accès responsable

Si une API publique est introduite, elle sera conçue pour une utilisation responsable.

L’objectif n’est pas de permettre un scraping sans restriction ni une extraction de données à grand volume. L’objectif est de soutenir des outils communautaires utiles, des tableaux de bord, des intégrations de forums, des sites web d’équipes et des visualisations adaptées à la recherche, sans nuire à la stabilité du service.

Une future API pourrait inclure :

• des clés API ;

• des limites de débit ;

• des quotas propres à chaque endpoint ;

• des exigences de mise en cache ;

• des règles d’attribution ;

• une prévention des abus ;

• des endpoints versionnés ;

• une documentation développeur.

Intéressé par l’accès à l’API ?

Nous n’acceptons pas encore les inscriptions à l’API publique.

Cependant, nous souhaitons savoir ce que les développeurs, les responsables d’équipes, les membres de la communauté et les contributeurs Folding@home trouveraient utile.

Vous pouvez envoyer vos idées d’API, demandes d’endpoints, besoins d’intégration ou intérêt pour un accès anticipé à :

general@vitaltale.com

Un retour utile peut inclure :

• les données auxquelles vous souhaitez accéder ;

• le type de projet ou d’intégration que vous souhaitez construire ;

• si vous avez besoin de données utilisateur, équipe, pays ou classement ;

• le volume de requêtes attendu ;

• les formats de données préférés ;

• si vous avez besoin de widgets, d’images, d’endpoints JSON ou de statistiques historiques.

Disponibilité actuelle de l’API

API publique : pas encore disponible

API interne : active

Documentation développeur : prévue

Accès anticipé : pas encore ouvert

Retours : bienvenus à general@vitaltale.com

Folding Monitor est développé en tenant compte d’une future disponibilité API, même si l’interface publique reste la priorité principale.