Derzeit wird die API intern von Folding Monitor genutzt, um Leaderboards, Profilseiten, Teamseiten, Länderrankings, Suche, generierte Signaturkarten und weitere Servicefunktionen zu unterstützen.

Eine öffentliche API ist noch nicht verfügbar, sie ist jedoch Teil der langfristigen Produktentwicklung.

Wir nutzen sie intern, um den Service zu betreiben und die öffentliche Oberfläche schnell, konsistent und zuverlässig zu halten.

Die interne API hilft uns bei der Arbeit mit:

Folding@home-Nutzer-IDs, Namen, Credits, Work Units, Ränge, Teams, Länder und Aktivitätszusammenfassungen.

Team-IDs, Teamnamen, Logos, Mitglieder, Credits, Work Units, Rangbewegungen und Leaderboard-Positionen.

Länderbasierte Rankings, vertretene Länder, Aktivitätszusammenfassungen und Nutzer ohne Ländereinstellung.

24-Stunden-, 7-Tage-, 30-Tage- und Gesamt-Rankings für Nutzer, Teams und Länder.

Forum-Signaturkarten, Profilvorschauen und andere visuelle Elemente auf Basis von Folding@home-Beitragsdaten.

Wir möchten, dass eine öffentliche API nützlich, stabil und verantwortungsvoll ist.

Eine zu frühe Öffnung einer API kann Probleme verursachen: instabile Endpunkte, unklare Limits, inkonsistente Datenformate, übermäßige Serverlast und Breaking Changes für frühe Nutzer.

Bevor öffentliche Endpunkte verfügbar gemacht werden, möchten wir die wichtigen Teile sauber definieren:

Klare Antwortformate für Nutzer, Teams, Länder, Rankings und Zeiträume.

Angemessene Limits, die den Service schützen und die API dennoch nützlich machen.

Transparente Erwartungen hinsichtlich Aktualisierungsfrequenz, Verzögerungen und historischen Daten.

Klare Hinweise dazu, wie Folding Monitor-Daten bei externer Nutzung referenziert werden sollten.

Endpunkte, die zuverlässig genug für Entwickler, Community-Tools, Dashboards und Forum-Integrationen sind.

Sorgfältige Trennung zwischen öffentlichen Statistiken, Daten verbundener Konten, internen Servicedaten und geschützten technischen Informationen.

Eine zukünftige öffentliche API kann Endpunkte enthalten für:

Folding@home-Nutzerprofile und Beitragszusammenfassungen suchen oder abrufen.

Teamprofile, Mitgliederzahlen, Logos, Rangdaten und Aktivitätszusammenfassungen abrufen.

Zugriff auf länderbasierte Statistiken und Rankings über ausgewählte Zeiträume.

Top-Nutzer, Teams und Länder für 24-Stunden-, 7-Tage-, 30-Tage- und Gesamtzeiträume abrufen.

Signaturkarten-Assets für Nutzer und Teams für Foren und Community-Seiten generieren oder abrufen.

Leaderboard-Veränderungen, aufsteigende Nutzer, aktive Teams und Trends der Länderbeteiligung verfolgen.

Einbettbare Widgets für Teams, Nutzer, Foren und Community-Websites unterstützen.

Wenn eine öffentliche API eingeführt wird, wird sie für verantwortungsvolle Nutzung konzipiert.

Ziel ist nicht unbegrenztes Scraping oder hochvolumige Datenextraktion. Ziel ist die Unterstützung nützlicher Community-Tools, Dashboards, Forum-Integrationen, Team-Websites und forschungsfreundlicher Visualisierungen, ohne die Stabilität des Services zu beeinträchtigen.

Eine zukünftige API kann enthalten:

• API-Schlüssel;

• Rate Limits;

• endpunktspezifische Quoten;

• Caching-Anforderungen;

• Attributionsregeln;

• Missbrauchsprävention;

• versionierte Endpunkte;

• Entwicklerdokumentation.

Wir nehmen derzeit noch keine öffentlichen API-Registrierungen an.

Wir sind jedoch daran interessiert zu erfahren, was Entwickler, Team-Betreiber, Community-Mitglieder und Folding@home-Mitwirkende nützlich finden würden.

Sie können API-Ideen, Endpunktwünsche, Integrationsanforderungen oder Interesse an frühem Zugriff senden an:

general@vitaltale.com

Hilfreiches Feedback kann enthalten:

• auf welche Daten Sie zugreifen möchten;

• welche Art von Projekt oder Integration Sie erstellen möchten;

• ob Sie Nutzer-, Team-, Länder- oder Leaderboard-Daten benötigen;

• erwartetes Anfragevolumen;

• bevorzugte Datenformate;

• ob Sie Widgets, Bilder, JSON-Endpunkte oder historische Statistiken benötigen.

Öffentliche API: noch nicht verfügbar

Interne API: aktiv

Entwicklerdokumentation: geplant

Früher Zugriff: noch nicht geöffnet

Feedback: willkommen unter general@vitaltale.com

Folding Monitor wird mit Blick auf API-Bereitschaft entwickelt, auch wenn die öffentliche Oberfläche weiterhin die Hauptpriorität bleibt.