На этом этапе API используется Folding Monitor внутри сервиса для поддержки таблиц лидеров, страниц профилей, страниц команд, рейтингов стран, поиска, генерируемых карточек подписи и других функций сервиса.

Публичный API пока недоступен, но он является частью долгосрочного направления развития продукта.

Мы используем его внутри сервиса, чтобы обеспечивать его работу и поддерживать публичный интерфейс быстрым, согласованным и надежным.

Внутренний API помогает нам работать с:

ID пользователей Folding@home, именами, кредитами, рабочими единицами, рангами, командами, странами и сводками активности.

ID команд, названиями команд, логотипами, участниками, кредитами, рабочими единицами, движением в рейтинге и позициями в таблицах лидеров.

Рейтингами по странам, представленными странами, сводками активности и пользователями без настроек страны.

Рейтингами за 24 ч, 7 дн., 30 дн. и за все время для пользователей, команд и стран.

Карточками подписи для форумов, предварительными просмотрами профилей и другими визуальными элементами на основе данных о вкладе Folding@home.

Мы хотим, чтобы публичный API был полезным, стабильным и ответственным.

Слишком раннее открытие API может создать проблемы: нестабильные endpoints, неясные лимиты, несогласованные форматы данных, чрезмерную нагрузку на сервер и критические изменения для ранних пользователей.

Перед тем как сделать публичные endpoints доступными, мы хотим правильно определить важные части:

Понятные форматы ответов для пользователей, команд, стран, рейтингов и временных периодов.

Разумные лимиты, которые защищают сервис и при этом делают API полезным.

Прозрачные ожидания относительно частоты обновления, задержек и исторических данных.

Понятные рекомендации о том, как следует ссылаться на данные Folding Monitor при внешнем использовании.

Endpoints, достаточно надежные для разработчиков, инструментов сообщества, панелей мониторинга и интеграций с форумами.

Аккуратное разделение публичной статистики, данных подключенных аккаунтов, внутренних данных сервиса и защищенной технической информации.

Будущий публичный API может включать endpoints для:

Поиска или получения профилей пользователей Folding@home и сводок вклада.

Получения профилей команд, количества участников, логотипов, данных рейтинга и сводок активности.

Доступа к статистике и рейтингам по странам за выбранные временные периоды.

Получения лучших пользователей, команд и стран за 24 ч, 7 дн., 30 дн. и за все время.

Генерации или получения ресурсов карточек подписи пользователей и команд для форумов и страниц сообщества.

Отслеживания изменений в таблицах лидеров, растущих пользователей, активных команд и тенденций участия по странам.

Поддержки встраиваемых виджетов для команд, пользователей, форумов и сайтов сообщества.

Если публичный API будет введен, он будет спроектирован для ответственного использования.

Цель не в том, чтобы создать неограниченный scraping или массовое извлечение данных. Цель — поддерживать полезные инструменты сообщества, панели мониторинга, интеграции с форумами, сайты команд и визуализации, удобные для исследовательских задач, без ущерба для стабильности сервиса.

Будущий API может включать:

• API-ключи;

• лимиты запросов;

• квоты для отдельных endpoints;

• требования к кэшированию;

• правила атрибуции;

• предотвращение злоупотреблений;

• версионированные endpoints;

• документацию для разработчиков.

Мы пока не принимаем регистрации для публичного API.

Однако нам интересно узнать, что было бы полезно разработчикам, администраторам команд, участникам сообщества и участникам Folding@home.

Вы можете отправлять идеи для API, запросы endpoints, потребности в интеграции или интерес к раннему доступу на:

general@vitaltale.com

Полезная обратная связь может включать:

• к каким данным вы хотели бы получить доступ;

• какой проект или интеграцию вы хотите создать;

• нужны ли вам данные пользователей, команд, стран или таблиц лидеров;

• ожидаемый объем запросов;

• предпочитаемые форматы данных;

• нужны ли вам виджеты, изображения, JSON endpoints или историческая статистика.

Публичный API: пока недоступен

Внутренний API: активен

Документация для разработчиков: запланирована

Ранний доступ: пока не открыт

Обратная связь: приветствуется на general@vitaltale.com

Folding Monitor создается с учетом будущей готовности к API, даже пока публичный интерфейс остается главным приоритетом.