In questa fase, l’API è utilizzata internamente da Folding Monitor per supportare leaderboard, pagine profilo, pagine dei team, classifiche per paese, ricerca, schede firma generate e altre funzionalità del servizio.

Un’API pubblica non è ancora disponibile, ma fa parte della direzione di prodotto a lungo termine.

La utilizziamo internamente per alimentare il servizio e mantenere l’interfaccia pubblica veloce, coerente e affidabile.

L’API interna ci aiuta a lavorare con:

ID utente Folding@home, nomi, crediti, unità di lavoro, posizioni in classifica, team, paesi e riepiloghi di attività.

ID dei team, nomi dei team, loghi, membri, crediti, unità di lavoro, movimenti in classifica e posizioni nelle leaderboard.

Classifiche basate sui paesi, paesi rappresentati, riepiloghi di attività e utenti senza impostazioni del paese.

Classifiche su 24 h, 7 giorni, 30 giorni e di tutti i tempi per utenti, team e paesi.

Schede firma per forum, anteprime dei profili e altri elementi visivi basati sui dati di contributo di Folding@home.

Vogliamo che un’API pubblica sia utile, stabile e responsabile.

Aprire un’API troppo presto può creare problemi: endpoint instabili, limiti poco chiari, formati dei dati incoerenti, carico eccessivo sui server e modifiche incompatibili per i primi utenti.

Prima di rendere disponibili endpoint pubblici, vogliamo definire correttamente le parti importanti:

Formati di risposta chiari per utenti, team, paesi, classifiche e periodi di tempo.

Limiti ragionevoli che proteggano il servizio pur rendendo utile l’API.

Aspettative trasparenti su frequenza di aggiornamento, ritardi e dati storici.

Indicazioni chiare su come i dati di Folding Monitor dovrebbero essere citati quando utilizzati esternamente.

Endpoint sufficientemente affidabili per sviluppatori, strumenti della comunità, dashboard e integrazioni con forum.

Separazione accurata tra statistiche pubbliche, dati degli account collegati, dati interni del servizio e informazioni tecniche protette.

Una futura API pubblica potrebbe includere endpoint per:

Cercare o recuperare profili utente Folding@home e riepiloghi di contributo.

Recuperare profili dei team, conteggi dei membri, loghi, dati di classifica e riepiloghi di attività.

Accedere a statistiche e classifiche basate sui paesi in periodi di tempo selezionati.

Recuperare i migliori utenti, team e paesi per periodi di 24 h, 7 giorni, 30 giorni e di tutti i tempi.

Generare o recuperare risorse di schede firma per utenti e team per forum e pagine della comunità.

Tracciare cambiamenti nelle leaderboard, utenti in crescita, team attivi e tendenze di partecipazione dei paesi.

Supportare widget incorporabili per team, utenti, forum e siti web della comunità.

Se verrà introdotta un’API pubblica, sarà progettata per un uso responsabile.

L’obiettivo non è creare scraping illimitato o estrazione di dati ad alto volume. L’obiettivo è supportare strumenti utili per la comunità, dashboard, integrazioni con forum, siti web dei team e visualizzazioni adatte alla ricerca senza danneggiare la stabilità del servizio.

Una futura API potrebbe includere:

• chiavi API;

• limiti di frequenza;

• quote specifiche per endpoint;

• requisiti di caching;

• regole di attribuzione;

• prevenzione degli abusi;

• endpoint versionati;

• documentazione per sviluppatori.

Non stiamo ancora accettando registrazioni per l’API pubblica.

Tuttavia, siamo interessati a sapere cosa sviluppatori, responsabili di team, membri della comunità e contributori Folding@home troverebbero utile.

Puoi inviare idee per l’API, richieste di endpoint, esigenze di integrazione o interesse per l’accesso anticipato a:

general@vitaltale.com

Un feedback utile può includere:

• quali dati vorresti poter accedere;

• che tipo di progetto o integrazione vuoi creare;

• se hai bisogno di dati utente, team, paese o leaderboard;

• volume previsto delle richieste;

• formati di dati preferiti;

• se hai bisogno di widget, immagini, endpoint JSON o statistiche storiche.

API pubblica: non ancora disponibile

API interna: attiva

Documentazione per sviluppatori: pianificata

Accesso anticipato: non ancora aperto

Feedback: benvenuto a general@vitaltale.com

Folding Monitor viene sviluppato tenendo presente la preparazione all’API, anche se l’interfaccia pubblica rimane la priorità principale.